Environments

Get environments under specified subscription.

get/api/v1/environments

Request

  • Base URL: https://api.chiligrafx.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.chiligrafx.com/api/v1/environments
  • Auth: HTTP bearer

Query parameters

subscriptionIdstring uuid

Specifies ID of the subscription to read environments from.

environmentNamestring

Specifies environment name to search for.

Response

Returns environments under specified subscription.

idinteger required

Environment Id.

guidstring uuid required

Environment guid.

namestring required

Environment display name.

regionstring nullable

Environment region.

type'Development' | 'Sandbox' | 'Production' required

Environment type.

usedStorageinteger required

Total environment used storage.

backOfficeUristring uri nullable

Backoffice URL.

technicalNamestring nullable

Environment technical name.

Example response

[
  {
    "id": 494,
    "guid": "18a3ae5c-3bc5-42eb-b8d8-0307fbbbfea1",
    "name": "CHILI Team",
    "region": "westeurope",
    "usedStorage": 1093314335,
    "backOfficeUri": "https://cp-000-000.chili-publish-sandbox.online/cp-000-000/interface.aspx",
    "technicalName": "ch-01"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.