API Definition
Authorizations
Body
commissioningFilestringRequired
The commissioning file of this service as base64 encoded content of a buffer
Responses
200
Validation Successful
400
Validation Error
application/json
406
Invalid Content
application/json
post
POST /api/validate/service HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28
{
"commissioningFile": "text"
}
No content
Authorizations
Body
idstring · min: 4Required
commissioningFilestringRequired
The commissioning file of this service as base64 encoded content of a buffer
parametersobjectOptional
The parameter values of this service as a JSON object
marketplaceobjectOptional
targetStatestring · enumOptionalPossible values:
Responses
201
Created service
application/json
400
Validation Error
application/json
406
Invalid Content
application/json
post
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"
}
Authorizations
Body
commissioningFilestringRequired
The commissioning file of this service as base64 encoded content of a buffer
Responses
201
Service schemas
application/json
Responseobject
400
Validation Error
application/json
406
Invalid Content
application/json
post
POST /api/services/parametersSchema HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28
{
"commissioningFile": "text"
}
{}
Authorizations
Path parameters
idstringRequired
Id of service
Responses
200
Service
application/json
400
Invalid request
404
Service not found
get
GET /api/services/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"commissioningData": {},
"resources": {},
"targetState": "text",
"currentState": "text"
}
Authorizations
Path parameters
idstringRequired
Id of service
Body
parametersobjectOptional
commissioningFilestringOptional
marketplaceobjectOptional
Responses
202
Accepted
400
Validation Error
application/json
406
Invalid Content
application/json
put
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
Authorizations
Path parameters
idstringRequired
Id of service
Responses
200
Service
application/json
400
Invalid request
404
Service not found
get
GET /api/services/{id}/status HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"targetState": "text",
"currentState": "text"
}
Authorizations
Path parameters
idstringRequired
Id of service
Responses
200
Service dependencies
application/json
400
Invalid request
404
Service not found
get
GET /api/services/{id}/dependencies HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"dependent": [
"text"
],
"dependsOn": [
"text"
]
}
Authorizations
Responses
200
Ingress routes
application/json
400
Invalid request
get
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"
]
}
]
Authorizations
Path parameters
idstringRequired
Id of service
Body
operationstringOptional
Disable and enable
Responses
200
Service
application/json
400
Invalid request
404
Service not found
put
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?