Skip to main content
An issue is a problem Atlas has identified — a failure, anomaly, root cause, or action item — with status, priority, and links back to the data it came from. Issues can be created manually or generated automatically by a job run. See Generating an Issue for a workflow guide.

Endpoints


Create an issue

POST /issues Request body: Example request:
Response fields: Example response:

List issues

GET /issues Query parameters: Example request:
Returns {"items": [...], "count": N} where each item is an issue object with the same fields as the create response.

Get an issue

GET /issues/{issue_id} Example request:
Returns a single issue object with the same fields as the create response.

Update an issue

PATCH /issues/{issue_id} All fields are optional. Only provided fields are updated. Example request:
Returns the updated issue object with the same fields as the create response.

Delete an issue

DELETE /issues/{issue_id} Example request:
Returns 204 No Content.

Get metrics

GET /issues/metrics Returns aggregate issue counts broken down by status, rendered as chart-ready data. Example request:
Response fields: Each chart object: Pie chart chart_data: Example response:

List comments

GET /issues/{issue_id}/comments Query parameters: Example request:
Returns {"items": [...], "count": N} where each item is a comment object with the same fields as the create comment response.

Add a comment

POST /issues/{issue_id}/comments Request body: Example request:
Response fields: Example response:

Update a comment

PATCH /issues/{issue_id}/comments/{comment_id} Request body: Example request:
Returns the updated comment object with the same fields as the create comment response.

Delete a comment

DELETE /issues/{issue_id}/comments/{comment_id} Example request:
Returns 204 No Content.

List issue files

GET /issues/{issue_id}/files Returns files associated with an issue (e.g. troubleshooting plans). Query parameters: Example request:
Response fields (array): Example response: