Environment management API - GET all environments of an account
Lists all environments of an account.
The request produces an application/json
payload.
GET |
|
Authentication
To execute this request, you need the Allow read access for environment resources (account-env-read
) scope assigned to your token. To learn how to obtain and use it, see Authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
accountUuid | string | The ID of the required account. You can find the UUID on the Account Management > Identity & access management > OAuth clients page, during creation of an OAuth client. | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Environment | - |
Response body objects
The EnvironmentListDto
object
Element | Type | Description |
---|---|---|
data | Environment | Lists all environments in an account |
The EnvironmentDto
object
Element | Type | Description |
---|---|---|
id | string | The UUID of the environment. |
name | string | Friendly name of the environment |
active | boolean | Property to determine if environment is active |
url | string | The url of the environment |
Response body JSON model
{"data": [{"id": "string","name": "string","active": true,"url": "string"}]}