Contact Uscybus.io

API Definition

17KB
Service Manager Schema.yaml

validate a commissioning file

post
Authorizations
Body
commissioningFilestringRequired

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

Responses
200
Validation Successful
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

Create a new service

post
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
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"
}

Read all services

get
Authorizations
Responses
200
Array of services
application/json
get
GET /api/services HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

Array of services

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

Get the service schemas

post
Authorizations
Body
commissioningFilestringRequired

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

Responses
201
Service schemas
application/json
Responseobject
post
POST /api/services/parametersSchema HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "commissioningFile": "text"
}
{}

Get status of all services

get
Authorizations
Responses
200
Map of service statuses
application/json
Responseobject
get
GET /api/services/status HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

Map of service statuses

{}

Get information of all services

get
Authorizations
Responses
200
Map of service information
application/json
Responseobject
get
GET /api/services/info HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

Map of service information

{}

Get the instance names of the services

get
Authorizations
Responses
200
Map of service information
application/json
Responsestring[]
get
GET /api/services/instances HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

Map of service information

[
  "text"
]

Get a specific service

get
Authorizations
Path parameters
idstringRequired

Id of service

Responses
200
Service
application/json
get
GET /api/services/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

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

Update an existing service

put
Authorizations
Path parameters
idstringRequired

Id of service

Body
parametersobjectOptional
commissioningFilestringOptional
marketplaceobjectOptional
Responses
202
Accepted
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

Delete an existing service

delete
Authorizations
Path parameters
idstringRequired

Id of service

Responses
200
OK
application/json
delete
DELETE /api/services/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text"
}

Get a specific service status

get
Authorizations
Path parameters
idstringRequired

Id of service

Responses
200
Service
application/json
get
GET /api/services/{id}/status HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

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

Get the service dependencies

get
Authorizations
Path parameters
idstringRequired

Id of service

Responses
200
Service dependencies
application/json
get
GET /api/services/{id}/dependencies HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

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

Get all ingress routes

get
Authorizations
Responses
200
Ingress routes
application/json
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"
    ]
  }
]

Get all Cybus::Link routes

get
Authorizations
Responses
200
Links
application/json
get
GET /api/services/links HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

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

Get all links by all services

get
Authorizations
Responses
200
Links
application/json
get
GET /api/services/all-links HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

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

Perform an operation on a service

put
Authorizations
Path parameters
idstringRequired

Id of service

Body
operationstringOptional

Disable and enable

Responses
200
Service
application/json
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"
}

Get all of the resource schemas

get
Authorizations
Responses
200
Resource schemas in a JSON string
application/json
get
GET /api/resources/schemas HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

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

Last updated

Was this helpful?