Environments | Heeler User Guide

List Environments

get

Authorizations

Query parameters

sourcestring · enumRequiredPossible values:

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

GET /api/environments/?source=aws HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "Corporate",
    "source": "aws",
    "organizational_units": 1,
    "accounts": 1,
    "tags": 1
  }
]

List Linked Accounts

get

Authorizations

Query parameters

sourcestring · enumRequiredPossible values:

namestring · enumRequiredPossible values:

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

GET /api/environments/linked_accounts?source=aws&name=Corporate HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "Corporate",
    "source": "aws",
    "account_id": "text",
    "account_name": "text",
    "date_added": "2025-06-27T12:26:07.749Z",
    "system_managed": false,
    "tag_managed": false
  }
]

List Available Accounts

get

Returns all available accounts. Note that accounts which are already associated with the supplied environment as well as those which are automated via OU associations are excluded.

Authorizations

Query parameters

sourcestring · enumRequiredPossible values:

namestring · enumRequiredPossible values:

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

GET /api/environments/accounts?source=aws&name=Corporate HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "Corporate",
    "source": "aws",
    "account_id": "text",
    "account_name": "text",
    "date_added": "2025-06-27T12:26:07.749Z",
    "system_managed": false,
    "tag_managed": false
  }
]

Update Environment For Accounts

post

Update the environment associated with a list of accounts. Note that any account in the list that is already associated with an environment that is managed by the system via OU mapping will be ignored.

Authorizations

Body

namestring · enumRequiredPossible values:

sourcestring · enumRequiredPossible values:

account_liststring[]Required

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

POST /api/environments/accounts HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "name": "Corporate",
  "source": "aws",
  "account_list": [
    "text"
  ]
}

{
  "ok": true,
  "message": "text"
}

List Linked Organizational Units

get

Authorizations

Query parameters

sourcestring · enumRequiredPossible values:

namestring · enumRequiredPossible values:

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

GET /api/environments/linked_organizational_units?source=aws&name=Corporate HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "Corporate",
    "source": "aws",
    "organizational_unit_id": "text",
    "organizational_unit_name": "text",
    "date_added": "2025-06-27T12:26:07.749Z",
    "accounts": 0
  }
]

List Organizational Units

get

Authorizations

Query parameters

sourcestring · enumRequiredPossible values:

namestring · enumRequiredPossible values:

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

GET /api/environments/organizational_units?source=aws&name=Corporate HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "organizational_unit_id": "text",
    "organizational_unit_name": "text"
  }
]

Update Environment For Ous

post

Update the environment associated with a list of OUs.

Authorizations

Body

namestring · enumRequiredPossible values:

sourcestring · enumRequiredPossible values:

organizational_unit_liststring[]Required

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

POST /api/environments/organizational_units HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "name": "Corporate",
  "source": "aws",
  "organizational_unit_list": [
    "text"
  ]
}

{
  "ok": true,
  "message": "text"
}

Unassign Ou

delete

Authorizations

Query parameters

ou_idstringRequired

namestring · enumRequiredPossible values:

sourcestring · enumRequiredPossible values:

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

delete

DELETE /api/environments/organizational_unit/unassign?ou_id=text&name=Corporate&source=aws HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ok": true,
  "message": "text"
}

List Tags For Environment

get

Authorizations

Query parameters

sourcestring · enumRequiredPossible values:

namestring · enumRequiredPossible values:

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

GET /api/environments/tags?source=aws&name=Corporate HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "Corporate",
    "source": "aws",
    "tag_key": "text",
    "tag_value": "text",
    "case_sensitive": true,
    "allow_resource_override": true
  }
]

Assign Tag To Environment

post

Associate a tag key/value pair with an environment

Authorizations

Body

namestring · enumRequiredPossible values:

sourcestring · enumRequiredPossible values:

tag_keystringRequired

tag_valuestringRequired

case_sensitivebooleanRequired

allow_resource_overridebooleanRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

POST /api/environments/tag HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "name": "Corporate",
  "source": "aws",
  "tag_key": "text",
  "tag_value": "text",
  "case_sensitive": true,
  "allow_resource_override": true
}

{
  "ok": true,
  "message": "text"
}

Unassign Tag

delete

Authorizations

Query parameters

tag_keystringRequired

tag_valuestringRequired

sourcestring · enumRequiredPossible values:

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

delete

DELETE /api/environments/tag/unassign?tag_key=text&tag_value=text&source=aws HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ok": true,
  "message": "text"
}

List Active Task Status

get

Authorizations

Query parameters

task_typeany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

GET /api/environments/task_statuses/active HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "task_type": "text",
    "task_id": "text",
    "exectuor": "text",
    "status": "text",
    "progress": "text",
    "execution_id": "text",
    "start_time": "2025-06-27T12:26:07.749Z"
  }
]