Services (API)

validate a commissioning file

post
Authorizations
AuthorizationstringRequired
Body
commissioningFilestringRequired

The commissioning file of this service as base64 encoded content of a buffer

Responses
chevron-right
200

Validation Successful

No content

post
/validate/service

No content

Create a new service

post
Authorizations
AuthorizationstringRequired
Body
idstring · min: 4Required
commissioningFilestringRequired

The commissioning file of this service as base64 encoded content of a buffer

targetStatestring · enumOptionalPossible values:
Responses
post
/services

Read all services

get
Authorizations
AuthorizationstringRequired
Responses
get
/services
301

Permanent Redirect

No content

Get the service schemas

post
Authorizations
AuthorizationstringRequired
Body
commissioningFilestringRequired

The commissioning file of this service as base64 encoded content of a buffer

Responses
post
/services/parametersSchema

Return the remaining time in milliseconds until the service can be installed

get
Authorizations
AuthorizationstringRequired
Path parameters
idstring · min: 4Required

Id of the service

Responses
chevron-right
200

OK

application/json
get
/services/{id}/deletion-status

Get a specific service

get
Authorizations
AuthorizationstringRequired
Responses
get
/services/{id}
301

Permanent Redirect

No content

Update an existing service

put
Authorizations
AuthorizationstringRequired
Responses
put
/services/{id}
308

Permanent Redirect

No content

Delete an existing service

delete
Authorizations
AuthorizationstringRequired
Path parameters
idstring · min: 4Required

Id of service

Responses
chevron-right
200

OK

application/json
delete
/services/{id}

Get the service dependencies

get
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired

Id of service

Responses
chevron-right
200

Service dependencies

application/json
get
/services/{id}/dependencies

Get all ingress routes

get
Authorizations
AuthorizationstringRequired
Responses
chevron-right
200

Ingress routes

application/json
get
/services/ingress-routes
get
Authorizations
AuthorizationstringRequired
Responses
chevron-right
200

Links

application/json
get
/services/links
get
Authorizations
AuthorizationstringRequired
Query parameters
onlyFromEnabledServicesbooleanOptional

Only list on the response resources from enabled services

Responses
chevron-right
200

Links

application/json
get
/services/all-links
200

Links

Perform an operation on a service

put
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired

Id of service

Body
operationstring · enumRequired

Disable and enable

Possible values:
Responses
chevron-right
200

Service

application/json
put
/services/{id}/operation

Delete specific resource runner

delete
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired

Id of resource runner

Responses
chevron-right
200

OK

application/json
delete
/resources/runners/{id}

Get all of the resource schemas

get
Authorizations
AuthorizationstringRequired
Responses
chevron-right
200

Resource schemas in a JSON string

application/json
get
/resources/schemas

Store resources schemas

post
Authorizations
AuthorizationstringRequired
Body
schemasobject[] · min: 1Required

List of resources schemas

Responses
post
/resources/schemas

No content

Read all services

get
Authorizations
AuthorizationstringRequired
Query parameters
searchTextstring · min: 3Optional

The value used to retrieve services by matching service ID or name

pageinteger · min: 1Optional

Page to return

itemsPerPageinteger · min: 1 · max: 100Optional

Number of items per page

orderBystring · enumOptional

Order response by field

Possible values:
orderstring · enumOptional

Ascending or descending order

Possible values:
Responses
chevron-right
200

Array of services

application/json
get
/v2/services

Get the number of installed Services

get
Authorizations
AuthorizationstringRequired
Responses
chevron-right
200

Number of installed Services

application/json
get
/v2/services/stats/count

Get paginated list of service IDs for all Services order lexicographically Ascending

get
Authorizations
AuthorizationstringRequired
Query parameters
pageinteger · min: 1Optional

Page to return

itemsPerPageinteger · min: 1 · max: 100Optional

Number of items per page

Responses
chevron-right
200

Get paginated list of service IDs for all Services order lexicographically Ascending

application/json
get
/v2/services/ids

Get a specific service

get
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired

Id of service

Responses
chevron-right
200

Service

application/json
get
/v2/services/{id}

Update an existing service

put
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired

Id of service

Body
commissioningFilestringOptional
Responses
put
/v2/services/{id}

Get ServiceCommissioningFile for specific service

get
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired

Id of service

Responses
chevron-right
200

SCF

application/json
get
/v2/services/{id}/serviceCommissioningFile

Read resources by for service

get
Authorizations
AuthorizationstringRequired
Path parameters
serviceIdstringRequired

Id of service

Query parameters
runnerNamestring · min: 3Optional

filter by runner name

parentResourceIdstring · min: 3Optional

filter by parentResourceId

searchTextstring · min: 3Optional

The value used to retrieve service resources by matching resource name

pageinteger · min: 1Optional

Page to return

itemsPerPageinteger · min: 1 · max: 100Optional

Number of items per page

orderBystring · enumOptional

Order response by field

Possible values:
orderstring · enumOptional

Ascending or descending order

Possible values:
onlyFromEnabledServicesbooleanOptional

Only list on the response resources from enabled services

Responses
chevron-right
200

Array of services

application/json
get
/v2/services/{serviceId}/resources

Read all resources

get
Authorizations
AuthorizationstringRequired
Query parameters
runnerNamestring · min: 3Optional

Resource runner name

parentResourceIdstring · min: 3Optional

Filter by parent of requested resources

searchTextstring · min: 3Optional

The value used to retrieve services resources by matching resource name

pageinteger · min: 1Optional

Page to return

itemsPerPageinteger · min: 1 · max: 100Optional

Number of items per page

orderBystring · enumOptional

Order response by field

Possible values:
orderstring · enumOptional

Ascending or descending order

Possible values:
onlyFromEnabledServicesbooleanOptional

Only list on the response resources from enabled services

Responses
chevron-right
200

Array of resources

application/json
get
/v2/resources

Read a specific resource

get
Authorizations
AuthorizationstringRequired
Path parameters
resourceIdstringRequired

Id of resource

Responses
chevron-right
200

Resource

application/json
get
/v2/resources/{resourceId}

Update an existing resources

put
Authorizations
AuthorizationstringRequired
Path parameters
resourceIdstringRequired

Id of resource

Body
operationstring · enumRequired

Disable and enable

Possible values:
Responses
chevron-right
200

Success

No content

put
/v2/resources/{resourceId}/operation

No content

Get available topics for service ID

get
Authorizations
AuthorizationstringRequired
Path parameters
serviceIdstringRequired

Id of service to list topics for

Query parameters
pageinteger · min: 1Optional

Page to return

itemsPerPageinteger · min: 1 · max: 100Optional

Number of items per page

orderBystring · enumOptional

Order response by field

Possible values:
orderstring · enumOptional

Ascending or descending order

Possible values:
searchTextstringOptional

The value used to retrieve topics by matching resource name or resource ID

onlyFromEnabledServicesbooleanOptional

Only list on the response topics from enabled service

Responses
chevron-right
200

Paginated list of topics

application/json
get
/v2/services/{serviceId}/topics

Get available topics for resources

get
Authorizations
AuthorizationstringRequired
Query parameters
idsstring[]Optional

The resource IDs to filter by (multiple allowed)

pageinteger · min: 1Optional

Page to return

itemsPerPageinteger · min: 1 · max: 100Optional

Number of items per page

orderBystring · enumOptional

Order response by field

Possible values:
orderstring · enumOptional

Ascending or descending order

Possible values:
searchTextstringOptional

The value used to retrieve topics by matching resource name or resource ID or service ID

onlyFromEnabledServicesbooleanOptional

Only list on the response topics from enabled services

Responses
chevron-right
200

Paginated list of topics

application/json
get
/v2/topics/resources

Get adjacency matrix of services

get
Authorizations
AuthorizationstringRequired
Responses
chevron-right
200

List of service relationships

application/json
get
/v2/service-graph/adjacency-matrix

Get all root nodes, i.e. all nodes which have no dependencies

get
Authorizations
AuthorizationstringRequired
Responses
chevron-right
200

List of root nodes

application/json
get
/v2/service-graph/root-nodes

Get all dependencies of a list of services

get
Authorizations
AuthorizationstringRequired
Query parameters
serviceIdsstringRequired

List of service to get dependencies for

distanceintegerOptional

Configures how many hops to return, e.g. 1 for direct dependencies only, 2 to return until dependencies of dependencies, etc.

Responses
chevron-right
200

List of dependencies

application/json
get
/v2/service-graph/dependencies

Get number of dependencies of a service

get
Authorizations
AuthorizationstringRequired
Query parameters
serviceIdstringRequired

Id of service to get dependencies for

distanceintegerOptional

Configures how many hops to return, e.g. 1 for direct dependencies only, 2 to return until dependencies of dependencies, etc.

Responses
chevron-right
200

Number of dependencies

No content

get
/v2/service-graph/dependencies/count

No content

Get all dependents of a list services

get
Authorizations
AuthorizationstringRequired
Query parameters
serviceIdsstringRequired

List of services to get dependents for

distanceintegerOptional

Configures how many hops to return, e.g. 1 for direct dependents only, 2 to return until dependents of dependents, etc.

Responses
chevron-right
200

List of dependencies

application/json
get
/v2/service-graph/dependents

Get number of dependents of a service

get
Authorizations
AuthorizationstringRequired
Query parameters
serviceIdstringRequired

Id of service to get dependents for

distanceintegerOptional

Configures how many hops to return, e.g. 1 for direct dependents only, 2 to return until dependents of dependents, etc.

Responses
chevron-right
200

Number of dependents

No content

get
/v2/service-graph/dependents/count

No content

Get count of resources by category

get
Authorizations
AuthorizationstringRequired
Path parameters
categorystring · enumRequired

Resource Category

Possible values:
Responses
chevron-right
200

Resource

application/json
get
/v2/resources/count/{category}

Last updated

Was this helpful?