Environments

Get environment information.

get/api/v1/environments/{environmentId}

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/{environmentId}
  • Auth: HTTP bearer

Path parameters

environmentIdstring uuid required

Environment Id.

Response

Returns environment information.

idinteger required

Environment Id.

guidstring uuid required

Environment Guid.

backOfficeUristring uri nullable

Backoffice URI

subscriptionIdstring uuid required

Subscription id.

namestring required

Environment name.

defaultNamestring nullable

Environment default name.

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

Environment type.

usedStorageinteger required

Total used storage in bytes.

tenantNamestring nullable

Tenant name.

regionstring nullable

Region name.

rendersinteger required

Render count for environment.

watermarkedRendersinteger required

Render count (watermarked) for environment.

isGraFxPricebookboolean required

Flag which indicates if the environment's subscription belongs to a GraFx pricebook.

disableCpoToGraFxRedirectboolean required

Indicates whether CPO to GraFx redirect is disabled.

Example response

{
  "id": 494,
  "guid": "8c36fcf4-3b2d-4088-977a-3066af964c2d",
  "backOfficeUri": "http://localhost/",
  "subscriptionId": "0bfb98c6-4219-421e-9a99-8c8a959f21a9",
  "name": "cp-000-001",
  "defaultName": "cp-000-001",
  "usedStorage": 2048,
  "usedStorageDetail": {
    "assets": 1280,
    "documents": 3560,
    "fonts": 1280,
    "cache": 2560,
    "backup": 5120,
    "other": 10240
  },
  "tenantName": "Tenant",
  "region": "westeurope",
  "renders": 2500,
  "watermarkedRenders": 2500,
  "isGraFxPricebook": true,
  "disableCpoToGraFxRedirect": true
}

Changes

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