Account Environments

Manage account environments

Get account environments for the account

get

Return the list of the account environments for the account

Authorizations

token

AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters

account_idstringRequired

The ID of the account

Query parameters

_pageintegerOptional

Index of the page

Example: 0

_max_per_pageintegerOptional

Number of items per page

Example: 10

Responses

200

Success

application/json

current_item_countinteger · intOptional

Returns the number of items in the current page

current_pageinteger · intOptional

Returns the number of the current page

Default: 0

total_countinteger · intOptional

Returns the number of total items

items_per_pageinteger · intOptional

Returns the number of items per page

Default: 10

last_pageinteger · intOptional

Returns the index of the page

404

Not Found

get

/accounts/{account_id}/account_environments

HTTPcURLJavaScriptPython

GET /v1/accounts/{account_id}/account_environments HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "current_item_count": 1,
  "current_page": 0,
  "total_count": 1,
  "items_per_page": 10,
  "last_page": 1,
  "items": [
    {
      "id": "text",
      "environment": "text",
      "isMain": "text",
      "panic": "text",
      "singleAssignment": "text"
    }
  ]
}

Get one environment

get

Return one environment by its id

Authorizations

token

AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters

account_idstringRequired

The ID of the account

account_environment_idstringRequired

The ID of the environment

Responses

200

Success

application/json

idstringRead-onlyOptional

ID of the accountEnvironment

environmentstringOptional

Name of the accountEnvironment

isMainstringOptional

Is this accountEnvironment the main production one

panicstringOptional

Is this accountEnvironment in panic mode

singleAssignmentstringOptional

Is XP-C enabled for this accountEnvironment

404

Not Found

get

/accounts/{account_id}/account_environments/{account_environment_id}

HTTPcURLJavaScriptPython

GET /v1/accounts/{account_id}/account_environments/{account_environment_id} HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "environment": "text",
  "isMain": "text",
  "panic": "text",
  "singleAssignment": "text"
}

Panic the account environment

patch

Update the panic mode of the account environment

Authorizations

token

AuthorizationstringRequired

Prefix the token with 'Bearer ' to indicate it is a bearer token

Path parameters

account_idstringRequired

The ID of the account

account_environment_idstringRequired

The ID of the environment

Body

application/json

panicstring · enumRequired

Status of the panic mode

Possible values:

Responses

200

Success

No content

404

Not Found

patch

/accounts/{account_id}/account_environments/{account_environment_id}

HTTPcURLJavaScriptPython

PATCH /v1/accounts/{account_id}/account_environments/{account_environment_id} HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "panic": "on"
}

No content