Toggle a service

Sets whether a service is enabled. When enabling, the stored configuration and secrets are validated against their schemas before the change is persisted and the service is hydrated on its adapter.

POST /services/{serviceId}/enabled

Toggle a service

cURL

curl --request POST \
  --url http://localhost:9371/services/{serviceId}/enabled \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true
}
'

200

{
  "id": "<string>",
  "enabled": true
}

Path Parameters

serviceId · string · required

Service identifier matching the installed manifest id.

Minimum string length: 1

Body

application/json

Request body used to toggle a service enabled state.

enabled · boolean · required

Desired enabled state for the service.

Response

200

application/json

Updated enabled state.

Response returned after toggling a service enabled state.

id · string · required

Identifier of the service whose enabled state was updated.

Minimum string length: 1

enabled · boolean · required

The new enabled state stored for the service.