Services (API)
The commissioning file of this service as base64 encoded content of a buffer
Validation Successful
No content
Validation Error
Invalid Content
POST /api/validate/service HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28
{
"commissioningFile": "text"
}No content
The commissioning file of this service as base64 encoded content of a buffer
Created service
Validation Error
Invalid Content
Conflict with service current state
Internal Server Error
POST /api/services HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 226
{
"id": "text",
"commissioningFile": "text",
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"marketplace": {
"filename": "text",
"directory": "text",
"version": "text",
"updatedAt": "2025-09-28T03:52:44.642Z"
},
"targetState": "disabled"
}{
"id": "text"
}The commissioning file of this service as base64 encoded content of a buffer
Service schemas
Validation Error
Invalid Content
POST /api/services/parametersSchema HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28
{
"commissioningFile": "text"
}{}Id of the service
OK
Internal Error while fetching service deletion status
GET /api/services/{id}/deletion-status HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"serviceID": "text",
"deletionIsComplete": true,
"remainingTimeInMs": 1
}Id of service
Service dependencies
Service not found
GET /api/services/{id}/dependencies HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"dependent": [
"text"
],
"dependsOn": [
"text"
]
}Ingress routes
Invalid request
GET /api/services/ingress-routes HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": "text",
"containerHost": "text",
"containerPort": 1,
"containerPrefixRewrite": "text",
"ingressPort": 1,
"ingressUrlPrefix": "text",
"type": "text",
"headers": [
"text"
]
}
]Only list on the response resources from enabled services
Links
GET /api/services/all-links HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
Links
[
{
"id": "text",
"name": "text",
"links": []
}
]Id of service
Disable and enable
Service
Invalid request
Service not found
PUT /api/services/{id}/operation HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"operation": "disable"
}{
"serviceId": "myService",
"name": "My Service",
"version": "v1.2.3",
"targetState": "enabled",
"currentState": "disabled",
"createdAt": "2025-03-06T22:13:43.065Z",
"updatedAt": "2025-03-06T22:13:43.065Z"
}List of resources schemas
Resource schemas stored
No content
Invalid request
POST /api/resources/schemas HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"schemas": [
{}
]
}No content
The value used to retrieve services by matching service ID or name
Page to return
Number of items per page
Order response by field
Ascending or descending order
Array of services
Internal Server Error
GET /api/v2/services HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"jsonapi": {
"version": "1.1.1"
},
"data": [
{
"serviceId": "myService",
"name": "My Service",
"version": "v1.2.3",
"targetState": "enabled",
"currentState": "disabled",
"createdAt": "2025-03-06T22:13:43.065Z",
"updatedAt": "2025-03-06T22:13:43.065Z"
}
],
"meta": {
"pagination": {
"totalPages": 1,
"totalRows": 1,
"pageNumber": 1,
"totalRowsInPage": 1,
"nextPage": 1,
"rowsPerPage": 50
}
}
}Number of installed Services
Internal Server Error
GET /api/v2/services/stats/count HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"jsonapi": {
"version": "1.1.1"
},
"data": {
"servicesCount": 1000
},
"meta": {}
}Page to return
Number of items per page
Get paginated list of service IDs for all Services order lexicographically Ascending
Bad Request
Internal Server Error
GET /api/v2/services/ids HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"jsonapi": {
"version": "1.1.1"
},
"data": [
"myService"
],
"meta": {
"pagination": {
"totalPages": 1,
"totalRows": 1,
"pageNumber": 1,
"totalRowsInPage": 1,
"nextPage": 1,
"rowsPerPage": 50
}
}
}Id of service
Service
Service not found
GET /api/v2/services/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"jsonapi": {
"version": "1.1.1"
},
"data": {
"connectwareServiceUuid": "81a6c550-fad5-11ef-a38c-0242ac120006",
"serviceId": "myService",
"name": "My Service",
"description": "My Service has some resources",
"version": "v1.2.3",
"provider": "Cybus",
"homepage": "cybus.io",
"icon": "TGFyYTwz",
"targetState": "enabled",
"currentState": "disabled",
"totalResources": 105,
"roleCount": 1,
"userCount": 2,
"volumeCount": 3,
"fileCount": 4,
"containerCount": 5,
"ingressRouteCount": 6,
"linkCount": 7,
"nodeCount": 8,
"serverCount": 9,
"connectionCount": 10,
"endpointCount": 11,
"mappingCount": 12,
"createdAt": "2025-03-06T22:13:43.065Z",
"updatedAt": "2025-03-06T22:13:43.065Z",
"parameters": {
"host": "cybus.io",
"port": 443
},
"marketPlace": {
"directory": "text",
"filename": "text",
"updatedAt": "text",
"version": "text"
}
},
"meta": {}
}Id of service
Accepted
Bad Request
Invalid Content
PUT /api/v2/services/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 189
{
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"commissioningFile": "text",
"marketplace": {
"filename": "text",
"directory": "text",
"version": "text",
"updatedAt": "2025-09-28T03:52:44.642Z"
}
}{
"jsonapi": {
"version": "1.1.1"
},
"meta": {}
}Id of service
SCF
Bad Request
Service not found
Internal Server Error
GET /api/v2/services/{id}/serviceCommissioningFile HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"jsonapi": {
"version": "1.1.1"
},
"data": {
"parameters_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"scf": "text"
},
"meta": {}
}Id of service
filter by runner name
filter by parentResourceId
The value used to retrieve service resources by matching resource name
Page to return
Number of items per page
Order response by field
Ascending or descending order
Only list on the response resources from enabled services
Array of services
Bad Request
Internal Server Error
GET /api/v2/services/{serviceId}/resources HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"jsonapi": {
"version": "1.1"
},
"data": [
{
"protocol": "text",
"category": "Node",
"parentResourceId": "text",
"resourceConfig": {
"args": {
"operation": "serverProvides",
"topic": "text"
}
}
}
],
"meta": {
"pagination": {
"totalPages": 1,
"totalRows": 1,
"pageNumber": 1,
"totalRowsInPage": 1,
"nextPage": 1,
"rowsPerPage": 50
}
}
}Resource runner name
Filter by parent of requested resources
The value used to retrieve services resources by matching resource name
Page to return
Number of items per page
Order response by field
Ascending or descending order
Only list on the response resources from enabled services
Array of resources
Bad Request
Internal Server Error
GET /api/v2/resources HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"jsonapi": {
"version": "1.1"
},
"data": [
{
"protocol": "text",
"category": "Node",
"parentResourceId": "text",
"resourceConfig": {
"args": {
"operation": "serverProvides",
"topic": "text"
}
}
}
],
"meta": {
"pagination": {
"totalPages": 1,
"totalRows": 1,
"pageNumber": 1,
"totalRowsInPage": 1,
"nextPage": 1,
"rowsPerPage": 50
}
}
}Id of resource
Resource
Resource not found
Internal Server Error
GET /api/v2/resources/{resourceId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"jsonapi": {
"version": "1.1.1"
},
"data": {
"resourceId": "myResource",
"serviceId": "myService",
"category": "Node",
"resourceConfig": {
"args": {
"operation": "serverProvides",
"topic": "text"
}
},
"runnerName": "protocol-mapper",
"protocol": "text",
"parentResourceId": "text"
},
"meta": {}
}Id of resource
Disable and enable
Success
No content
Invalid request
Internal Server Error
PUT /api/v2/resources/{resourceId}/operation HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"operation": "disable"
}No content
Id of service to list topics for
Page to return
Number of items per page
Order response by field
Ascending or descending order
The value used to retrieve topics by matching resource name or resource ID
Only list on the response topics from enabled service
Paginated list of topics
Parameter missing
No topics found
Internal Server Error
GET /api/v2/services/{serviceId}/topics HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"jsonapi": {
"version": "1.1"
},
"data": [
{
"topic": "services/servicea/A/000",
"serviceId": "servicea",
"resourceId": "servicea-A_000",
"category": "Endpoint"
}
],
"meta": {
"pagination": {
"totalPages": 1,
"totalRows": 1,
"pageNumber": 1,
"totalRowsInPage": 1,
"nextPage": 1,
"rowsPerPage": 50
}
}
}The resource IDs to filter by (multiple allowed)
Page to return
Number of items per page
Order response by field
Ascending or descending order
The value used to retrieve topics by matching resource name or resource ID or service ID
Only list on the response topics from enabled services
Paginated list of topics
Parameter missing
No topics found
Internal Server Error
GET /api/v2/topics/resources HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"jsonapi": {
"version": "1.1"
},
"data": [
{
"topic": "services/servicea/A/000",
"serviceId": "servicea",
"resourceId": "servicea-A_000",
"category": "Endpoint"
}
],
"meta": {
"pagination": {
"totalPages": 1,
"totalRows": 1,
"pageNumber": 1,
"totalRowsInPage": 1,
"nextPage": 1,
"rowsPerPage": 50
}
}
}List of service to get dependencies for
Configures how many hops to return, e.g. 1 for direct dependencies only, 2 to return until dependencies of dependencies, etc.
List of dependencies
Internal Server Error
GET /api/v2/service-graph/dependencies?serviceIds=text HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"nodes": [
"text"
]
}Id of service to get dependencies for
Configures how many hops to return, e.g. 1 for direct dependencies only, 2 to return until dependencies of dependencies, etc.
Number of dependencies
No content
Internal Server Error
GET /api/v2/service-graph/dependencies/count?serviceId=text HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
List of services to get dependents for
Configures how many hops to return, e.g. 1 for direct dependents only, 2 to return until dependents of dependents, etc.
List of dependencies
Internal Server Error
GET /api/v2/service-graph/dependents?serviceIds=text HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"nodes": [
"text"
]
}Id of service to get dependents for
Configures how many hops to return, e.g. 1 for direct dependents only, 2 to return until dependents of dependents, etc.
Number of dependents
No content
Internal Server Error
GET /api/v2/service-graph/dependents/count?serviceId=text HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
Resource Category
Resource
Invalid Resource Category provided
Internal Server Error
GET /api/v2/resources/count/{category} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"jsonapi": {
"version": "1.1.1"
},
"data": {
"resourceCount": 1000
},
"meta": {}
}Last updated
Was this helpful?