Platform API ReferenceEnvironment

List environment objects

List environment objects in a Workspace or Deployment.

Path parameters

organizationIdstringRequired

The ID of the Organization to which the environment object belongs.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

offsetintegerOptional>=0Defaults to 0

The number of results to skip before returning values.

limitintegerOptional>=0Defaults to 20

The maximum number of results to return.

sortslist of enumsOptional

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

workspaceIdstringOptional

The Workspace ID to filter for. The API returns details for all environment objects belonging only to this specified Workspace.

deploymentIdstringOptional

The Deployment ID to filter for. The API returns details for all environment objects belonging only to this specified Deployment.

objectTypeenumOptional

The environment object type to filter for. The API returns details for all environment objects belonging only to this specified object type.

Allowed values:
objectKeystringOptional

The environment object key to filter for. The API returns details for all environment objects belonging only to the specified object key.

showSecretsbooleanOptional

If true, returns the actual values of fields of type secret in the API response.

resolveLinkedbooleanOptional

Resolve and return the environment objects linked to the specified Deployment or Workspace in the API response.

Response

OK

environmentObjectslist of objects

The list of environment objects

limitinteger

The maximum number of environment objects in current page

offsetinteger

The offset of the current page of environment objects

totalCountinteger

The total number of environment objects

Errors