API Definition
The commissioning file of this service as base64 encoded content of a buffer
Validation Successful
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
The parameter values of this service as a JSON object
Created service
Validation Error
Invalid Content
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"
}{
"id": "text",
"targetState": "text",
"currentState": "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 service
Service
Invalid request
Service not found
GET /api/services/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"commissioningData": {},
"resources": {},
"targetState": "text",
"currentState": "text"
}Id of service
Accepted
Validation Error
Invalid Content
PUT /api/services/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 61
{
"parameters": {},
"commissioningFile": "text",
"marketplace": {}
}No content
Id of service
Service
Invalid request
Service not found
GET /api/services/{id}/status HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"targetState": "text",
"currentState": "text"
}Id of service
Service dependencies
Invalid request
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"
]
}
]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: 20
{
"operation": "text"
}{
"id": "text",
"targetState": "text",
"currentState": "text"
}Last updated
Was this helpful?