API Definition

17KB

Service Manager Schema.yaml

validate a commissioning file

post

/validate/service

Authorizations

Body

commissioningFilestringrequired

The commissioning file of this service as base64 encoded content of a buffer

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/validate/service' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"commissioningFile":"text"}'

200

400

406

200

No body

Validation Successful

Create a new service

post

/services

Authorizations

Body

idstring · min: 4required

commissioningFilestringrequired

The commissioning file of this service as base64 encoded content of a buffer

parametersobject

The parameter values of this service as a JSON object

marketplaceobject

targetStatestring · enum

Options: disabled, enabled

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/services' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","commissioningFile":"text","parameters":{},"marketplace":{},"targetState":"disabled"}'

201

400

406

201

{
  "id": "text",
  "targetState": "text",
  "currentState": "text"
}

Created service

Read all services

get

/services

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/services' \
  --header 'Authorization: YOUR_API_KEY'

200

200

[
  {
    "id": "text",
    "commissioningData": {},
    "resources": {},
    "targetState": "text",
    "currentState": "text"
  }
]

Array of services

Get the service schemas

post

/services/parametersSchema

Authorizations

Body

commissioningFilestringrequired

The commissioning file of this service as base64 encoded content of a buffer

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/services/parametersSchema' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"commissioningFile":"text"}'

201

400

406

201

{}

Service schemas

Get status of all services

get

/services/status

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/services/status' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{}

Map of service statuses

Get information of all services

get

/services/info

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/services/info' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{}

Map of service information

Get the instance names of the services

get

/services/instances

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/services/instances' \
  --header 'Authorization: YOUR_API_KEY'

200

200

[
  "text"
]

Map of service information

Get a specific service

get

/services/{id}

Authorizations

Path parameters

idstringrequired

Id of service

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/services/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

400

404

200

{
  "id": "text",
  "commissioningData": {},
  "resources": {},
  "targetState": "text",
  "currentState": "text"
}

Service

Update an existing service

put

/services/{id}

Authorizations

Path parameters

idstringrequired

Id of service

Body

parametersobject

commissioningFilestring

marketplaceobject

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/services/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"parameters":{},"marketplace":{}}'

202

400

406

202

No body

Accepted

Delete an existing service

delete

/services/{id}

Authorizations

Path parameters

idstringrequired

Id of service

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/services/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

404

200

{
  "id": "text"
}

OK

Get a specific service status

get

/services/{id}/status

Authorizations

Path parameters

idstringrequired

Id of service

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/services/{id}/status' \
  --header 'Authorization: YOUR_API_KEY'

200

400

404

200

{
  "id": "text",
  "targetState": "text",
  "currentState": "text"
}

Service

Get the service dependencies

get

/services/{id}/dependencies

Authorizations

Path parameters

idstringrequired

Id of service

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/services/{id}/dependencies' \
  --header 'Authorization: YOUR_API_KEY'

200

400

404

200

{
  "dependent": [
    "text"
  ],
  "dependsOn": [
    "text"
  ]
}

Service dependencies

Get all ingress routes

get

/services/ingress-routes

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/services/ingress-routes' \
  --header 'Authorization: YOUR_API_KEY'

200

400

200

[
  {
    "id": "text",
    "containerHost": "text",
    "containerPort": 1,
    "containerPrefixRewrite": "text",
    "ingressPort": 1,
    "ingressUrlPrefix": "text",
    "type": "text",
    "headers": [
      "text"
    ]
  }
]

Ingress routes

Get all Cybus::Link routes

get

/services/links

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/services/links' \
  --header 'Authorization: YOUR_API_KEY'

200

400

200

[
  {
    "id": "text",
    "ingressRoute": "text",
    "name": "text",
    "href": "text"
  }
]

Links

Get all links by all services

get

/services/all-links

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/services/all-links' \
  --header 'Authorization: YOUR_API_KEY'

200

400

200

[
  {
    "id": "text",
    "name": "text",
    "links": []
  }
]

Links

Perform an operation on a service

put

/services/{id}/operation

Authorizations

Path parameters

idstringrequired

Id of service

Body

operationstring

Disable and enable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/services/{id}/operation' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json'

200

400

404

200

{
  "id": "text",
  "targetState": "text",
  "currentState": "text"
}

Service

Get all of the resource schemas

get

/resources/schemas

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/resources/schemas' \
  --header 'Authorization: YOUR_API_KEY'

200

400

500

200

{
  "[a-zA-Z0-9]+": {},
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Resource schemas in a JSON string