Last updated 5 months ago
Was this helpful?
GET /api/services HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
Array of services
[ { "id": "text", "commissioningData": {}, "resources": {}, "targetState": "text", "currentState": "text" } ]
GET /api/services/status HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
Map of service statuses
{}
GET /api/services/info HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
Map of service information
GET /api/services/instances HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
[ "text" ]
Id of service
GET /api/services/{id} HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
Service
{ "id": "text", "commissioningData": {}, "resources": {}, "targetState": "text", "currentState": "text" }
DELETE /api/services/{id} HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
OK
{ "id": "text" }
GET /api/services/{id}/status HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
{ "id": "text", "targetState": "text", "currentState": "text" }
GET /api/services/{id}/dependencies HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
Service dependencies
{ "dependent": [ "text" ], "dependsOn": [ "text" ] }
GET /api/services/ingress-routes HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
Ingress routes
[ { "id": "text", "containerHost": "text", "containerPort": 1, "containerPrefixRewrite": "text", "ingressPort": 1, "ingressUrlPrefix": "text", "type": "text", "headers": [ "text" ] } ]
GET /api/services/links HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
Links
[ { "id": "text", "ingressRoute": "text", "name": "text", "href": "text" } ]
GET /api/services/all-links HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
[ { "id": "text", "name": "text", "links": [] } ]
GET /api/resources/schemas HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
Resource schemas in a JSON string
{ "[a-zA-Z0-9]+": {}, "ANY_ADDITIONAL_PROPERTY": "anything" }
The commissioning file of this service as base64 encoded content of a buffer
POST /api/validate/service HTTP/1.1 Host: Authorization: YOUR_API_KEY Content-Type: application/json Accept: */* Content-Length: 28 { "commissioningFile": "text" }
Validation Successful
No content
The parameter values of this service as a JSON object
disabled
enabled
POST /api/services HTTP/1.1 Host: Authorization: YOUR_API_KEY Content-Type: application/json Accept: */* Content-Length: 98 { "id": "text", "commissioningFile": "text", "parameters": {}, "marketplace": {}, "targetState": "disabled" }
Created service
POST /api/services/parametersSchema HTTP/1.1 Host: Authorization: YOUR_API_KEY Content-Type: application/json Accept: */* Content-Length: 28 { "commissioningFile": "text" }
Service schemas
PUT /api/services/{id} HTTP/1.1 Host: Authorization: YOUR_API_KEY Content-Type: application/json Accept: */* Content-Length: 61 { "parameters": {}, "commissioningFile": "text", "marketplace": {} }
Accepted
Disable and enable
PUT /api/services/{id}/operation HTTP/1.1 Host: Authorization: YOUR_API_KEY Content-Type: application/json Accept: */* Content-Length: 20 { "operation": "text" }
