Managed Services

List all managed services

get

Responses

200

successful operation

No content

get/service

HTTPcURLJavaScriptPython

GET /rest/service HTTP/1.1
Accept: */*

200

successful operation

No content

Get a managed service by ID

get

Path parameters

managedServiceIdstring · uuidRequired

The ID of the managed service

Responses

default

default response

application/json

createdDatestring · date-timeOptional

errorMessagestringOptional

idstring · uuidOptional

modifiedDatestring · date-timeOptional

nodeIdstring · uuidOptional

statusobject · ManagedServiceStatusOptional

typestring · enumOptionalPossible values:

get/service/{managedServiceId}

HTTPcURLJavaScriptPython

GET /rest/service/{managedServiceId} HTTP/1.1
Accept: */*

default

default response

{
  "createdDate": "2026-07-14T14:41:58.069Z",
  "errorMessage": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedDate": "2026-07-14T14:41:58.069Z",
  "nodeId": "123e4567-e89b-12d3-a456-426614174000",
  "optionalDependencies": [
    "REPOSITORY"
  ],
  "requiredDependencies": [
    "REPOSITORY"
  ],
  "status": {},
  "type": "REPOSITORY"
}

Change an existing managed service

put

Path parameters

managedServiceIdstring · uuidRequired

The ID of the managed service to change

Body

application/json

createdDatestring · date-timeOptional

errorMessagestringOptional

idstring · uuidOptional

modifiedDatestring · date-timeOptional

nodeIdstring · uuidOptional

statusobject · ManagedServiceStatusOptional

typestring · enumOptionalPossible values:

Responses

default

default response

application/json

createdDatestring · date-timeOptional

errorMessagestringOptional

idstring · uuidOptional

modifiedDatestring · date-timeOptional

nodeIdstring · uuidOptional

statusobject · ManagedServiceStatusOptional

typestring · enumOptionalPossible values:

put/service/{managedServiceId}

HTTPcURLJavaScriptPython

PUT /rest/service/{managedServiceId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 306

{
  "createdDate": "2026-07-14T14:41:58.069Z",
  "errorMessage": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedDate": "2026-07-14T14:41:58.069Z",
  "nodeId": "123e4567-e89b-12d3-a456-426614174000",
  "optionalDependencies": [
    "REPOSITORY"
  ],
  "requiredDependencies": [
    "REPOSITORY"
  ],
  "status": {},
  "type": "REPOSITORY"
}

default

default response

{
  "createdDate": "2026-07-14T14:41:58.069Z",
  "errorMessage": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "modifiedDate": "2026-07-14T14:41:58.069Z",
  "nodeId": "123e4567-e89b-12d3-a456-426614174000",
  "optionalDependencies": [
    "REPOSITORY"
  ],
  "requiredDependencies": [
    "REPOSITORY"
  ],
  "status": {},
  "type": "REPOSITORY"
}

Start a managed service

post

Path parameters

managedServiceIdstring · uuidRequired

The ID of the managed service to start

Responses

202

successful operation

No content

post/service/{managedServiceId}/start

HTTPcURLJavaScriptPython

POST /rest/service/{managedServiceId}/start HTTP/1.1
Accept: */*

202

successful operation

No content

Stop a managed service

post

Path parameters

managedServiceIdstring · uuidRequired

The ID of the managed service to stop

Responses

202

successful operation

No content

post/service/{managedServiceId}/stop

HTTPcURLJavaScriptPython

POST /rest/service/{managedServiceId}/stop HTTP/1.1
Accept: */*

202

successful operation

No content