Environments-5 API Reference

Environments-5

For instructions on how to authenticate to use this endpoint, see API overview.

Stream dashboard metadata and tiles via Server-Sent Events. Sends metadata first, then tiles as they are rendered.

Endpoints

`GET`	`/api/environments/:project_id/dashboards/:id/stream_tiles/`
`POST`	`/api/environments/:project_id/dashboards/create_from_template_json/`
`GET`	`/api/environments/:project_id/error_tracking/assignment_rules/`
`POST`	`/api/environments/:project_id/error_tracking/assignment_rules/`
`GET`	`/api/environments/:project_id/error_tracking/assignment_rules/:id/`
`PATCH`	`/api/environments/:project_id/error_tracking/assignment_rules/:id/`
`DELETE`	`/api/environments/:project_id/error_tracking/assignment_rules/:id/`
`PATCH`	`/api/environments/:project_id/error_tracking/assignment_rules/reorder/`
`GET`	`/api/environments/:project_id/error_tracking/grouping_rules/`

Retrieve environments dashboards stream tiles

Path parameters

id
integer
A unique integer value identifying this dashboard.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

format
string
One of: "json""txt"

Response

Status 200 No response body

Retrieve environments dashboards stream tiles

Path parameters

id
integer
A unique integer value identifying this dashboard.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

format
string
One of: "json""txt"

Response

Status 200 No response body

Create environments dashboards create from template json

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

format
string
One of: "json""txt"

Response

Status 200 No response body

Create environments dashboards create from template json

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

format
string
One of: "json""txt"

Response

Status 200 No response body

List all environments error tracking assignment rules

Required API key scopes

error_tracking:read

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "filters": null,
      "assignee": "string",
      "order_key": -2147483648,
      "disabled_data": null
    }
  ]
}

List all environments error tracking assignment rules

Required API key scopes

error_tracking:read

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "filters": null,
      "assignee": "string",
      "order_key": -2147483648,
      "disabled_data": null
    }
  ]
}

Create environments error tracking assignment rules

Required API key scopes

error_tracking:write

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 201

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filters": null,
  "assignee": "string",
  "order_key": -2147483648,
  "disabled_data": null
}

Create environments error tracking assignment rules

Required API key scopes

error_tracking:write

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 201

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filters": null,
  "assignee": "string",
  "order_key": -2147483648,
  "disabled_data": null
}

Retrieve environments error tracking assignment rules

Required API key scopes

error_tracking:read

Path parameters

id
string
A UUID string identifying this error tracking assignment rule.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filters": null,
  "assignee": "string",
  "order_key": -2147483648,
  "disabled_data": null
}

Retrieve environments error tracking assignment rules

Required API key scopes

error_tracking:read

Path parameters

id
string
A UUID string identifying this error tracking assignment rule.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filters": null,
  "assignee": "string",
  "order_key": -2147483648,
  "disabled_data": null
}

Update environments error tracking assignment rules

Required API key scopes

error_tracking:write

Path parameters

id
string
A UUID string identifying this error tracking assignment rule.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filters": null,
  "assignee": "string",
  "order_key": -2147483648,
  "disabled_data": null
}

Update environments error tracking assignment rules

Required API key scopes

error_tracking:write

Path parameters

id
string
A UUID string identifying this error tracking assignment rule.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filters": null,
  "assignee": "string",
  "order_key": -2147483648,
  "disabled_data": null
}

Delete environments error tracking assignment rules

Required API key scopes

error_tracking:write

Path parameters

id
string
A UUID string identifying this error tracking assignment rule.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 204 No response body

Delete environments error tracking assignment rules

Required API key scopes

error_tracking:write

Path parameters

id
string
A UUID string identifying this error tracking assignment rule.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 204 No response body

Update environments error tracking assignment rules reorder

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200 No response body

Update environments error tracking assignment rules reorder

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

Status 200 No response body

List all environments error tracking grouping rules

Required API key scopes

error_tracking:read

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "filters": null,
      "assignee": "string",
      "order_key": -2147483648,
      "disabled_data": null
    }
  ]
}

List all environments error tracking grouping rules

Required API key scopes

error_tracking:read

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "filters": null,
      "assignee": "string",
      "order_key": -2147483648,
      "disabled_data": null
    }
  ]
}