Skip to content

Fetch environment

GET
/api/v1/environment/{environment_id}
environment_id
required
idempotency_key
One of:
IdempotencyKeyOrNull

Optional idempotency key for ensuring request idempotency

string

Success

object
details
Environment_Details
object
account_id
Account_Id

A valid account ID

string
Example
013xrzp12g3nqk8ngskn1wtxgka5b0nf
id
Environment_Id

A valid environment ID

string
Example
013xrzp12g3nqk8nzxvq7jm2arsfg5h1
name

Environment name

string
Example
Development
type

Type of resource (always ‘environment’)

string
Allowed values: environment
Example
environment
status
string
Allowed values: success
Example
success

Error

One of:
object
code
string
Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action invalid_value required_value idempotency_key_already_used
Example
bad_request
message
string
status
string
Allowed values: error
Example
error