Last updated 22 days ago
Was this helpful?
curl -L \ --url '/services' \ --header 'Authorization: YOUR_API_KEY'
[ { "id": "text", "commissioningData": {}, "resources": {}, "targetState": "text", "currentState": "text" } ]
curl -L \ --url '/services/status' \ --header 'Authorization: YOUR_API_KEY'
{}
curl -L \ --url '/services/info' \ --header 'Authorization: YOUR_API_KEY'
curl -L \ --url '/services/instances' \ --header 'Authorization: YOUR_API_KEY'
[ "text" ]
Id of service
curl -L \ --url '/services/{id}' \ --header 'Authorization: YOUR_API_KEY'
{ "id": "text", "commissioningData": {}, "resources": {}, "targetState": "text", "currentState": "text" }
curl -L \ --request DELETE \ --url '/services/{id}' \ --header 'Authorization: YOUR_API_KEY'
{ "id": "text" }
curl -L \ --url '/services/{id}/status' \ --header 'Authorization: YOUR_API_KEY'
{ "id": "text", "targetState": "text", "currentState": "text" }
curl -L \ --url '/services/{id}/dependencies' \ --header 'Authorization: YOUR_API_KEY'
{ "dependent": [ "text" ], "dependsOn": [ "text" ] }
curl -L \ --url '/services/ingress-routes' \ --header 'Authorization: YOUR_API_KEY'
[ { "id": "text", "containerHost": "text", "containerPort": 1, "containerPrefixRewrite": "text", "ingressPort": 1, "ingressUrlPrefix": "text", "type": "text", "headers": [ "text" ] } ]
curl -L \ --url '/services/links' \ --header 'Authorization: YOUR_API_KEY'
[ { "id": "text", "ingressRoute": "text", "name": "text", "href": "text" } ]
curl -L \ --url '/services/all-links' \ --header 'Authorization: YOUR_API_KEY'
[ { "id": "text", "name": "text", "links": [] } ]
Id of resource runner
curl -L \ --request DELETE \ --url '/resources/runners/{id}' \ --header 'Authorization: YOUR_API_KEY'
curl -L \ --url '/resources/schemas' \ --header 'Authorization: YOUR_API_KEY'
{ "[a-zA-Z0-9]+": {}, "ANY_ADDITIONAL_PROPERTY": "anything" }
The commissioning file of this service as base64 encoded content of a buffer
curl -L \ --request POST \ --url '/validate/service' \ --header 'Authorization: YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "commissioningFile": "text" }'
No body
The parameter values of this service as a JSON object
disabled
enabled
curl -L \ --request POST \ --url '/services' \ --header 'Authorization: YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "id": "text", "commissioningFile": "text", "parameters": {}, "marketplace": {}, "targetState": "disabled" }'
curl -L \ --request POST \ --url '/services/parametersSchema' \ --header 'Authorization: YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "commissioningFile": "text" }'
curl -L \ --request PUT \ --url '/services/{id}' \ --header 'Authorization: YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "parameters": {}, "commissioningFile": "text", "marketplace": {} }'
Disable and enable
curl -L \ --request PUT \ --url '/services/{id}/operation' \ --header 'Authorization: YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "operation": "text" }'