API reference / Optional services

Optional services

Discover and provision add-on OSC services for a workspace.

GET /api/v1/optional-services/

List optional add-on services and each one's provisioning state for the workspace.

Response

Response 200 (application/json)
[
  {
    "key": "string",
    "serviceId": "string",
    "displayName": "string",
    "instanceNameEnvVar": "string",
    "state": "not-configured",
    "instanceName": "string",
    "url": "string"
  }
]

GET /api/v1/optional-services/{key}

Get a single optional service's provisioning state.

Parameters

NameInTypeRequired
keypathstringrequired

Response

Response 200 (application/json)
{
  "key": "string",
  "serviceId": "string",
  "displayName": "string",
  "instanceNameEnvVar": "string",
  "state": "not-configured",
  "instanceName": "string",
  "url": "string"
}

DELETE /api/v1/optional-services/{key}

Deprovision an optional service.

Parameters

NameInTypeRequired
keypathstringrequired

Response

Response 202 (application/json)
{
  "operationId": "string",
  "key": "string",
  "name": "string",
  "status": "pending"
}

POST /api/v1/optional-services/{key}/provision

Provision an optional service on demand.

Parameters

NameInTypeRequired
keypathstringrequired

Request

Request body (application/json)
{
  "name": "string"
}

Response

Response 202 (application/json)
{
  "operationId": "string",
  "key": "string",
  "name": "string",
  "status": "pending"
}
← PreviousProvisioningNext →Profiles