Skip to content
Prefactor Docs

Fetch environment

GET
/api/v1/environment/{environment_id}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
environment_id
required
Environment_Id

A valid environment ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny

Query Parameters

Section titled “Query Parameters ”
idempotency_key
One of:

Optional idempotency key for ensuring request idempotency

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

object
details
Environment_Details
object
account_id
Account_Id

A valid account ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
description
One of:

Optional free-form description

string
id
Environment_Id

A valid environment ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
name

Environment name

string
Example
Development
purpose

Environment purpose

string
Allowed values: development staging testing production
Example
development
type

Type of resource (always ‘environment’)

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

default

Section titled “default ”

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