diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 96b4ba5901d1d..ec1198aa7b4bb 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -6701,6 +6701,58 @@ menu: - GetDomainAllowlist unstable: [] order: 1 + - name: Error Tracking + url: /api/latest/error-tracking/ + identifier: error-tracking + generated: true + - name: Update the state of an issue + url: '#update-the-state-of-an-issue' + identifier: error-tracking-update-the-state-of-an-issue + parent: error-tracking + generated: true + params: + versions: + - v2 + operationids: + - UpdateIssueState + unstable: [] + order: 3 + - name: Update the assignee of an issue + url: '#update-the-assignee-of-an-issue' + identifier: error-tracking-update-the-assignee-of-an-issue + parent: error-tracking + generated: true + params: + versions: + - v2 + operationids: + - UpdateIssueAssignee + unstable: [] + order: 4 + - name: Get the details of an error tracking issue + url: '#get-the-details-of-an-error-tracking-issue' + identifier: error-tracking-get-the-details-of-an-error-tracking-issue + parent: error-tracking + generated: true + params: + versions: + - v2 + operationids: + - GetIssue + unstable: [] + order: 2 + - name: Search error tracking issues + url: '#search-error-tracking-issues' + identifier: error-tracking-search-error-tracking-issues + parent: error-tracking + generated: true + params: + versions: + - v2 + operationids: + - SearchIssues + unstable: [] + order: 1 - name: Fastly Integration url: /api/latest/fastly-integration/ identifier: fastly-integration diff --git a/content/en/api/latest/error-tracking/_index.md b/content/en/api/latest/error-tracking/_index.md new file mode 100644 index 0000000000000..7a9050188f8c2 --- /dev/null +++ b/content/en/api/latest/error-tracking/_index.md @@ -0,0 +1,3 @@ +--- +title: Error Tracking +--- diff --git a/content/en/api/v2/error-tracking/_index.md b/content/en/api/v2/error-tracking/_index.md new file mode 100644 index 0000000000000..cd32c6998c50e --- /dev/null +++ b/content/en/api/v2/error-tracking/_index.md @@ -0,0 +1,4 @@ +--- +title: Error Tracking +headless: true +--- diff --git a/content/en/api/v2/error-tracking/examples.json b/content/en/api/v2/error-tracking/examples.json new file mode 100644 index 0000000000000..13c55bc9744e8 --- /dev/null +++ b/content/en/api/v2/error-tracking/examples.json @@ -0,0 +1,640 @@ +{ + "SearchIssues": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "impacted_sessions": 12, + "impacted_users": 4, + "total_count": 82 + }, + "id": "c1726a66-1f64-11ee-b338-da7ad0900002", + "relationships": { + "issue": { + "data": { + "id": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "issue" + } + } + }, + "type": "error_tracking_search_result" + } + ], + "included": [ + { + "attributes": { + "error_message": "object of type 'NoneType' has no len()", + "error_type": "builtins.TypeError", + "file_path": "/django-email/conduit/apps/core/utils.py", + "first_seen": 1671612804001, + "first_seen_version": "aaf65cd0", + "function_name": "filter_forbidden_tags", + "is_crash": false, + "languages": [ + "PYTHON", + "GO" + ], + "last_seen": 1671620003100, + "last_seen_version": "b6199f80", + "platform": "BACKEND", + "service": "email-api-py", + "state": "RESOLVED" + }, + "id": "c1726a66-1f64-11ee-b338-da7ad0900002", + "relationships": { + "assignee": { + "data": { + "id": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "user" + } + }, + "case": { + "data": { + "id": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "case" + } + }, + "team_owners": { + "data": [ + { + "id": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "team" + } + ] + } + }, + "type": "issue" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

Array of results matching the search query.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a search result.

\n
\n
\n
\n
\n
\n

impacted_sessions

\n
\n

int64

\n

Count of sessions impacted by the issue over the queried time window.

\n
\n \n
\n
\n
\n
\n
\n

impacted_users

\n
\n

int64

\n

Count of users impacted by the issue over the queried time window.

\n
\n \n
\n
\n
\n
\n
\n

total_count

\n
\n

int64

\n

Total count of errors that match the issue over the queried time window.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Search result identifier (matches the nested issue's identifier).

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships between the search result and other resources.

\n
\n
\n
\n
\n
\n

issue

\n
\n

object

\n

Relationship between the search result and the corresponding issue.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The issue the search result corresponds to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Issue identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: issue

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: error_tracking_search_result

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of resources related to the search results.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The issue matching the request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of an issue.

\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

Error message associated with the issue.

\n
\n \n
\n
\n
\n
\n
\n

error_type

\n
\n

string

\n

Type of the error that matches the issue.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

Path of the file where the issue occurred.

\n
\n \n
\n
\n
\n
\n
\n

first_seen

\n
\n

int64

\n

Timestamp of the first seen error in milliseconds since the Unix epoch.

\n
\n \n
\n
\n
\n
\n
\n

first_seen_version

\n
\n

string

\n

The application version (for example, git commit hash) where the issue was first observed.

\n
\n \n
\n
\n
\n
\n
\n

function_name

\n
\n

string

\n

Name of the function where the issue occurred.

\n
\n \n
\n
\n
\n
\n
\n

is_crash

\n
\n

boolean

\n

Error is a crash.

\n
\n \n
\n
\n
\n
\n
\n

languages

\n
\n

[string]

\n

Array of programming languages associated with the issue.

\n
\n \n
\n
\n
\n
\n
\n

last_seen

\n
\n

int64

\n

Timestamp of the last seen error in milliseconds since the Unix epoch.

\n
\n \n
\n
\n
\n
\n
\n

last_seen_version

\n
\n

string

\n

The application version (for example, git commit hash) where the issue was last observed.

\n
\n \n
\n
\n
\n
\n
\n

platform

\n
\n

enum

\n

Platform associated with the issue. \nAllowed enum values: ANDROID,BACKEND,BROWSER,FLUTTER,IOS,REACT_NATIVE,ROKU,UNKNOWN

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

Service name.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

enum

\n

State of the issue \nAllowed enum values: OPEN,ACKNOWLEDGED,RESOLVED,IGNORED,EXCLUDED

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Issue identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between the issue and an assignee, case and/or teams.

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship between the issue and assignee.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The user the issue is assigned to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

User identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object \nAllowed enum values: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

case

\n
\n

object

\n

Relationship between the issue and case.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The case the issue is attached to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: case

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

team_owners

\n
\n

object

\n

Relationship between the issue and teams.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Array of teams that are owners of the issue.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Team identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: issue

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A case

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Case resource attributes

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived

\n
\n \n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CaseObjectAttributes object.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description

\n
\n \n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Jira issue information

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue ID

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

service_now_ticket

\n
\n

object

\n

ServiceNow ticket attached to case

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

ServiceNow ticket information

\n
\n
\n
\n
\n
\n

sys_target_link

\n
\n

string

\n

Link to the Incident created on ServiceNow

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Case type \nAllowed enum values: STANDARD

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case's identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Case resource type \nAllowed enum values: case

default: case

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

The user to whom the issue is assigned.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

User identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object \nAllowed enum values: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 4

\n
\n

object

\n

A team that owns an issue.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a team.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The team's identifier.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the team.

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from its description.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Team identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: team

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "from": 1671612804000, + "query": "service:orders-* AND @language:go", + "to": 1671620004000 + }, + "type": "search_request" + } + }, + "json": { + "data": { + "attributes": { + "from": 1671612804000, + "order_by": "IMPACTED_SESSIONS", + "persona": "BACKEND", + "query": "service:orders-* AND @language:go", + "to": 1671620004000, + "track": "trace" + }, + "type": "search_request" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Search issues request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object describing a search issue request.

\n
\n
\n
\n
\n
\n

from [required]

\n
\n

int64

\n

Start date (inclusive) of the query in milliseconds since the Unix epoch.

\n
\n \n
\n
\n
\n
\n
\n

order_by

\n
\n

enum

\n

The attribute to sort the search results by. \nAllowed enum values: TOTAL_COUNT,FIRST_SEEN,IMPACTED_SESSIONS,PRIORITY

\n
\n \n
\n
\n
\n
\n
\n

persona

\n
\n

enum

\n

Persona for the search. Either track(s) or persona(s) must be specified. \nAllowed enum values: ALL,BROWSER,MOBILE,BACKEND

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

Search query following the event search syntax.

\n
\n \n
\n
\n
\n
\n
\n

to [required]

\n
\n

int64

\n

End date (exclusive) of the query in milliseconds since the Unix epoch.

\n
\n \n
\n
\n
\n
\n
\n

track

\n
\n

enum

\n

Track of the events to query. Either track(s) or persona(s) must be specified. \nAllowed enum values: trace,logs,rum

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: search_request

\n
\n \n
\n
\n
\n
" + } + }, + "GetIssue": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "error_message": "object of type 'NoneType' has no len()", + "error_type": "builtins.TypeError", + "file_path": "/django-email/conduit/apps/core/utils.py", + "first_seen": 1671612804001, + "first_seen_version": "aaf65cd0", + "function_name": "filter_forbidden_tags", + "is_crash": false, + "languages": [ + "PYTHON", + "GO" + ], + "last_seen": 1671620003100, + "last_seen_version": "b6199f80", + "platform": "BACKEND", + "service": "email-api-py", + "state": "RESOLVED" + }, + "id": "c1726a66-1f64-11ee-b338-da7ad0900002", + "relationships": { + "assignee": { + "data": { + "id": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "user" + } + }, + "case": { + "data": { + "id": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "case" + } + }, + "team_owners": { + "data": [ + { + "id": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "team" + } + ] + } + }, + "type": "issue" + }, + "included": [ + { + "attributes": { + "archived_at": "2025-01-01T00:00:00Z", + "closed_at": "2025-01-01T00:00:00Z", + "created_at": "2025-01-01T00:00:00Z", + "creation_source": "ERROR_TRACKING", + "description": "string", + "due_date": "2025-01-01", + "insights": [ + { + "ref": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", + "resource_id": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "ERROR_TRACKING" + } + ], + "jira_issue": { + "result": { + "issue_id": "1904866", + "issue_key": "ET-123", + "issue_url": "https://your-jira-instance.atlassian.net/browse/ET-123", + "project_key": "ET" + }, + "status": "COMPLETED" + }, + "key": "ET-123", + "modified_at": "2025-01-01T00:00:00Z", + "priority": "NOT_DEFINED", + "status": "OPEN", + "title": "Error: HTTP error", + "type": "ERROR_TRACKING_ISSUE" + }, + "id": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "relationships": { + "assignee": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "user" + } + }, + "created_by": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "user" + } + }, + "modified_by": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "user" + } + }, + "project": { + "data": { + "id": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "project" + } + } + }, + "type": "case" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The issue matching the request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of an issue.

\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

Error message associated with the issue.

\n
\n \n
\n
\n
\n
\n
\n

error_type

\n
\n

string

\n

Type of the error that matches the issue.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

Path of the file where the issue occurred.

\n
\n \n
\n
\n
\n
\n
\n

first_seen

\n
\n

int64

\n

Timestamp of the first seen error in milliseconds since the Unix epoch.

\n
\n \n
\n
\n
\n
\n
\n

first_seen_version

\n
\n

string

\n

The application version (for example, git commit hash) where the issue was first observed.

\n
\n \n
\n
\n
\n
\n
\n

function_name

\n
\n

string

\n

Name of the function where the issue occurred.

\n
\n \n
\n
\n
\n
\n
\n

is_crash

\n
\n

boolean

\n

Error is a crash.

\n
\n \n
\n
\n
\n
\n
\n

languages

\n
\n

[string]

\n

Array of programming languages associated with the issue.

\n
\n \n
\n
\n
\n
\n
\n

last_seen

\n
\n

int64

\n

Timestamp of the last seen error in milliseconds since the Unix epoch.

\n
\n \n
\n
\n
\n
\n
\n

last_seen_version

\n
\n

string

\n

The application version (for example, git commit hash) where the issue was last observed.

\n
\n \n
\n
\n
\n
\n
\n

platform

\n
\n

enum

\n

Platform associated with the issue. \nAllowed enum values: ANDROID,BACKEND,BROWSER,FLUTTER,IOS,REACT_NATIVE,ROKU,UNKNOWN

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

Service name.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

enum

\n

State of the issue \nAllowed enum values: OPEN,ACKNOWLEDGED,RESOLVED,IGNORED,EXCLUDED

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Issue identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between the issue and an assignee, case and/or teams.

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship between the issue and assignee.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The user the issue is assigned to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

User identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object \nAllowed enum values: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

case

\n
\n

object

\n

Relationship between the issue and case.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The case the issue is attached to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: case

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

team_owners

\n
\n

object

\n

Relationship between the issue and teams.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Array of teams that are owners of the issue.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Team identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: issue

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of resources related to the issue.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The case attached to the issue.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a case.

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived.

\n
\n \n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created.

\n
\n \n
\n
\n
\n
\n
\n

creation_source

\n
\n

string

\n

Source of the case creation.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the case.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Due date of the case.

\n
\n \n
\n
\n
\n
\n
\n

insights

\n
\n

[object]

\n

Insights of the case.

\n
\n
\n
\n
\n
\n

ref

\n
\n

string

\n

Reference of the insight.

\n
\n \n
\n
\n
\n
\n
\n

resource_id

\n
\n

string

\n

Insight identifier.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the insight.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue of the case.

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Contains the identifiers and URL for a successfully created Jira issue.

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue identifier.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key.

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL.

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Creation status of the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key of the case.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the case.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the case.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case.

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: case

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The user to whom the issue is assigned.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

User identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object \nAllowed enum values: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A team that owns an issue.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a team.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The team's identifier.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the team.

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from its description.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Team identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: team

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateIssueAssignee": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "error_message": "object of type 'NoneType' has no len()", + "error_type": "builtins.TypeError", + "file_path": "/django-email/conduit/apps/core/utils.py", + "first_seen": 1671612804001, + "first_seen_version": "aaf65cd0", + "function_name": "filter_forbidden_tags", + "is_crash": false, + "languages": [ + "PYTHON", + "GO" + ], + "last_seen": 1671620003100, + "last_seen_version": "b6199f80", + "platform": "BACKEND", + "service": "email-api-py", + "state": "RESOLVED" + }, + "id": "c1726a66-1f64-11ee-b338-da7ad0900002", + "relationships": { + "assignee": { + "data": { + "id": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "user" + } + }, + "case": { + "data": { + "id": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "case" + } + }, + "team_owners": { + "data": [ + { + "id": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "team" + } + ] + } + }, + "type": "issue" + }, + "included": [ + { + "attributes": { + "archived_at": "2025-01-01T00:00:00Z", + "closed_at": "2025-01-01T00:00:00Z", + "created_at": "2025-01-01T00:00:00Z", + "creation_source": "ERROR_TRACKING", + "description": "string", + "due_date": "2025-01-01", + "insights": [ + { + "ref": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", + "resource_id": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "ERROR_TRACKING" + } + ], + "jira_issue": { + "result": { + "issue_id": "1904866", + "issue_key": "ET-123", + "issue_url": "https://your-jira-instance.atlassian.net/browse/ET-123", + "project_key": "ET" + }, + "status": "COMPLETED" + }, + "key": "ET-123", + "modified_at": "2025-01-01T00:00:00Z", + "priority": "NOT_DEFINED", + "status": "OPEN", + "title": "Error: HTTP error", + "type": "ERROR_TRACKING_ISSUE" + }, + "id": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "relationships": { + "assignee": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "user" + } + }, + "created_by": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "user" + } + }, + "modified_by": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "user" + } + }, + "project": { + "data": { + "id": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "project" + } + } + }, + "type": "case" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The issue matching the request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of an issue.

\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

Error message associated with the issue.

\n
\n \n
\n
\n
\n
\n
\n

error_type

\n
\n

string

\n

Type of the error that matches the issue.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

Path of the file where the issue occurred.

\n
\n \n
\n
\n
\n
\n
\n

first_seen

\n
\n

int64

\n

Timestamp of the first seen error in milliseconds since the Unix epoch.

\n
\n \n
\n
\n
\n
\n
\n

first_seen_version

\n
\n

string

\n

The application version (for example, git commit hash) where the issue was first observed.

\n
\n \n
\n
\n
\n
\n
\n

function_name

\n
\n

string

\n

Name of the function where the issue occurred.

\n
\n \n
\n
\n
\n
\n
\n

is_crash

\n
\n

boolean

\n

Error is a crash.

\n
\n \n
\n
\n
\n
\n
\n

languages

\n
\n

[string]

\n

Array of programming languages associated with the issue.

\n
\n \n
\n
\n
\n
\n
\n

last_seen

\n
\n

int64

\n

Timestamp of the last seen error in milliseconds since the Unix epoch.

\n
\n \n
\n
\n
\n
\n
\n

last_seen_version

\n
\n

string

\n

The application version (for example, git commit hash) where the issue was last observed.

\n
\n \n
\n
\n
\n
\n
\n

platform

\n
\n

enum

\n

Platform associated with the issue. \nAllowed enum values: ANDROID,BACKEND,BROWSER,FLUTTER,IOS,REACT_NATIVE,ROKU,UNKNOWN

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

Service name.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

enum

\n

State of the issue \nAllowed enum values: OPEN,ACKNOWLEDGED,RESOLVED,IGNORED,EXCLUDED

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Issue identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between the issue and an assignee, case and/or teams.

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship between the issue and assignee.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The user the issue is assigned to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

User identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object \nAllowed enum values: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

case

\n
\n

object

\n

Relationship between the issue and case.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The case the issue is attached to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: case

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

team_owners

\n
\n

object

\n

Relationship between the issue and teams.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Array of teams that are owners of the issue.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Team identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: issue

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of resources related to the issue.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The case attached to the issue.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a case.

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived.

\n
\n \n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created.

\n
\n \n
\n
\n
\n
\n
\n

creation_source

\n
\n

string

\n

Source of the case creation.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the case.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Due date of the case.

\n
\n \n
\n
\n
\n
\n
\n

insights

\n
\n

[object]

\n

Insights of the case.

\n
\n
\n
\n
\n
\n

ref

\n
\n

string

\n

Reference of the insight.

\n
\n \n
\n
\n
\n
\n
\n

resource_id

\n
\n

string

\n

Insight identifier.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the insight.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue of the case.

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Contains the identifiers and URL for a successfully created Jira issue.

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue identifier.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key.

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL.

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Creation status of the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key of the case.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the case.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the case.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case.

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: case

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The user to whom the issue is assigned.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

User identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object \nAllowed enum values: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A team that owns an issue.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a team.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The team's identifier.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the team.

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from its description.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Team identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: team

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "id": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "assignee" + } + }, + "json": { + "data": { + "id": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "assignee" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Update issue assignee request.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

User identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: assignee

\n
\n \n
\n
\n
\n
" + } + }, + "UpdateIssueState": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "error_message": "object of type 'NoneType' has no len()", + "error_type": "builtins.TypeError", + "file_path": "/django-email/conduit/apps/core/utils.py", + "first_seen": 1671612804001, + "first_seen_version": "aaf65cd0", + "function_name": "filter_forbidden_tags", + "is_crash": false, + "languages": [ + "PYTHON", + "GO" + ], + "last_seen": 1671620003100, + "last_seen_version": "b6199f80", + "platform": "BACKEND", + "service": "email-api-py", + "state": "RESOLVED" + }, + "id": "c1726a66-1f64-11ee-b338-da7ad0900002", + "relationships": { + "assignee": { + "data": { + "id": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "user" + } + }, + "case": { + "data": { + "id": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "case" + } + }, + "team_owners": { + "data": [ + { + "id": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "team" + } + ] + } + }, + "type": "issue" + }, + "included": [ + { + "attributes": { + "archived_at": "2025-01-01T00:00:00Z", + "closed_at": "2025-01-01T00:00:00Z", + "created_at": "2025-01-01T00:00:00Z", + "creation_source": "ERROR_TRACKING", + "description": "string", + "due_date": "2025-01-01", + "insights": [ + { + "ref": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", + "resource_id": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "ERROR_TRACKING" + } + ], + "jira_issue": { + "result": { + "issue_id": "1904866", + "issue_key": "ET-123", + "issue_url": "https://your-jira-instance.atlassian.net/browse/ET-123", + "project_key": "ET" + }, + "status": "COMPLETED" + }, + "key": "ET-123", + "modified_at": "2025-01-01T00:00:00Z", + "priority": "NOT_DEFINED", + "status": "OPEN", + "title": "Error: HTTP error", + "type": "ERROR_TRACKING_ISSUE" + }, + "id": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "relationships": { + "assignee": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "user" + } + }, + "created_by": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "user" + } + }, + "modified_by": { + "data": { + "id": "00000000-0000-0000-0000-000000000000", + "type": "user" + } + }, + "project": { + "data": { + "id": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "project" + } + } + }, + "type": "case" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The issue matching the request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of an issue.

\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

Error message associated with the issue.

\n
\n \n
\n
\n
\n
\n
\n

error_type

\n
\n

string

\n

Type of the error that matches the issue.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

Path of the file where the issue occurred.

\n
\n \n
\n
\n
\n
\n
\n

first_seen

\n
\n

int64

\n

Timestamp of the first seen error in milliseconds since the Unix epoch.

\n
\n \n
\n
\n
\n
\n
\n

first_seen_version

\n
\n

string

\n

The application version (for example, git commit hash) where the issue was first observed.

\n
\n \n
\n
\n
\n
\n
\n

function_name

\n
\n

string

\n

Name of the function where the issue occurred.

\n
\n \n
\n
\n
\n
\n
\n

is_crash

\n
\n

boolean

\n

Error is a crash.

\n
\n \n
\n
\n
\n
\n
\n

languages

\n
\n

[string]

\n

Array of programming languages associated with the issue.

\n
\n \n
\n
\n
\n
\n
\n

last_seen

\n
\n

int64

\n

Timestamp of the last seen error in milliseconds since the Unix epoch.

\n
\n \n
\n
\n
\n
\n
\n

last_seen_version

\n
\n

string

\n

The application version (for example, git commit hash) where the issue was last observed.

\n
\n \n
\n
\n
\n
\n
\n

platform

\n
\n

enum

\n

Platform associated with the issue. \nAllowed enum values: ANDROID,BACKEND,BROWSER,FLUTTER,IOS,REACT_NATIVE,ROKU,UNKNOWN

\n
\n \n
\n
\n
\n
\n
\n

service

\n
\n

string

\n

Service name.

\n
\n \n
\n
\n
\n
\n
\n

state

\n
\n

enum

\n

State of the issue \nAllowed enum values: OPEN,ACKNOWLEDGED,RESOLVED,IGNORED,EXCLUDED

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Issue identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationship between the issue and an assignee, case and/or teams.

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship between the issue and assignee.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The user the issue is assigned to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

User identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object \nAllowed enum values: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

case

\n
\n

object

\n

Relationship between the issue and case.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The case the issue is attached to.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: case

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

team_owners

\n
\n

object

\n

Relationship between the issue and teams.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

Array of teams that are owners of the issue.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Team identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: team

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: issue

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Array of resources related to the issue.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

The case attached to the issue.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a case.

\n
\n
\n
\n
\n
\n

archived_at

\n
\n

date-time

\n

Timestamp of when the case was archived.

\n
\n \n
\n
\n
\n
\n
\n

closed_at

\n
\n

date-time

\n

Timestamp of when the case was closed.

\n
\n \n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the case was created.

\n
\n \n
\n
\n
\n
\n
\n

creation_source

\n
\n

string

\n

Source of the case creation.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the case.

\n
\n \n
\n
\n
\n
\n
\n

due_date

\n
\n

string

\n

Due date of the case.

\n
\n \n
\n
\n
\n
\n
\n

insights

\n
\n

[object]

\n

Insights of the case.

\n
\n
\n
\n
\n
\n

ref

\n
\n

string

\n

Reference of the insight.

\n
\n \n
\n
\n
\n
\n
\n

resource_id

\n
\n

string

\n

Insight identifier.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the insight.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

jira_issue

\n
\n

object

\n

Jira issue of the case.

\n
\n
\n
\n
\n
\n

result

\n
\n

object

\n

Contains the identifiers and URL for a successfully created Jira issue.

\n
\n
\n
\n
\n
\n

issue_id

\n
\n

string

\n

Jira issue identifier.

\n
\n \n
\n
\n
\n
\n
\n

issue_key

\n
\n

string

\n

Jira issue key.

\n
\n \n
\n
\n
\n
\n
\n

issue_url

\n
\n

string

\n

Jira issue URL.

\n
\n \n
\n
\n
\n
\n
\n

project_key

\n
\n

string

\n

Jira project key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Creation status of the Jira issue.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

key

\n
\n

string

\n

Key of the case.

\n
\n \n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the case was last modified.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

enum

\n

Case priority \nAllowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

enum

\n

Case status \nAllowed enum values: OPEN,IN_PROGRESS,CLOSED

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Title of the case.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

Type of the case.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Case identifier.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Resources related to a case.

\n
\n
\n
\n
\n
\n

assignee

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_by

\n
\n

object

\n

Relationship to user.

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to user object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the user.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

User resource type. \nAllowed enum values: user

default: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

project

\n
\n

object

\n

Relationship to project

\n
\n
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Relationship to project object

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier that represents the project

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Project resource type \nAllowed enum values: project

default: project

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: case

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

The user to whom the issue is assigned.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a user.

\n
\n
\n
\n
\n
\n

email

\n
\n

string

\n

Email of the user.

\n
\n \n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Handle of the user.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the user.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

User identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object \nAllowed enum values: user

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 3

\n
\n

object

\n

A team that owns an issue.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object containing the information of a team.

\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

The team's identifier.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The name of the team.

\n
\n \n
\n
\n
\n
\n
\n

summary

\n
\n

string

\n

A brief summary of the team, derived from its description.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Team identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: team

\n
\n \n
\n
\n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "401": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "state": "RESOLVED" + }, + "id": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "error_tracking_issue" + } + }, + "json": { + "data": { + "attributes": { + "state": "RESOLVED" + }, + "id": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "error_tracking_issue" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Update issue state request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Object describing an issue state update request.

\n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

State of the issue \nAllowed enum values: OPEN,ACKNOWLEDGED,RESOLVED,IGNORED,EXCLUDED

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Issue identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the object. \nAllowed enum values: error_tracking_issue

\n
\n \n
\n
\n
\n
" + } + } +} \ No newline at end of file diff --git a/content/en/api/v2/error-tracking/request.SearchIssues.json b/content/en/api/v2/error-tracking/request.SearchIssues.json new file mode 100644 index 0000000000000..5bf7d3b405614 --- /dev/null +++ b/content/en/api/v2/error-tracking/request.SearchIssues.json @@ -0,0 +1,11 @@ +{ + "data": { + "attributes": { + "query": "service:orders-* AND @language:go", + "from": 1671612804000, + "to": 1671620004000, + "track": "trace" + }, + "type": "search_request" + } +} \ No newline at end of file diff --git a/content/en/api/v2/error-tracking/request.UpdateIssueAssignee.json b/content/en/api/v2/error-tracking/request.UpdateIssueAssignee.json new file mode 100644 index 0000000000000..ec371325546f8 --- /dev/null +++ b/content/en/api/v2/error-tracking/request.UpdateIssueAssignee.json @@ -0,0 +1,6 @@ +{ + "data": { + "id": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "assignee" + } +} \ No newline at end of file diff --git a/content/en/api/v2/error-tracking/request.UpdateIssueState.json b/content/en/api/v2/error-tracking/request.UpdateIssueState.json new file mode 100644 index 0000000000000..b14c198b65b3f --- /dev/null +++ b/content/en/api/v2/error-tracking/request.UpdateIssueState.json @@ -0,0 +1,9 @@ +{ + "data": { + "attributes": { + "state": "RESOLVED" + }, + "id": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "error_tracking_issue" + } +} \ No newline at end of file diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index 06c99c42b21af..d3a231ffb9616 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -460,6 +460,27 @@ "description": "Update a downtime returns \"OK\" response" } ], + "SearchIssues": [ + { + "group": "error_tracking", + "suffix": "", + "description": "Search error tracking issues returns \"OK\" response" + } + ], + "UpdateIssueAssignee": [ + { + "group": "error_tracking", + "suffix": "", + "description": "Update the assignee of an issue returns \"OK\" response" + } + ], + "UpdateIssueState": [ + { + "group": "error_tracking", + "suffix": "", + "description": "Update the state of an issue returns \"OK\" response" + } + ], "CreateEvent": [ { "group": "events", diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index dbbe4ecfd00e6..9541e5f0db46d 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -427,6 +427,17 @@ components: required: true schema: type: string + GetIssueIncludeQueryParameter: + description: Comma-separated list of relationship objects that should be included + in the response. + explode: false + in: query + name: include + required: false + schema: + items: + $ref: '#/components/schemas/GetIssueIncludeQueryParameterItem' + type: array HistoricalJobID: description: The ID of the job. in: path @@ -591,6 +602,14 @@ components: required: true schema: type: string + IssueIDPathParameter: + description: The identifier of the issue. + example: c1726a66-1f64-11ee-b338-da7ad0900002 + in: path + name: issue_id + required: true + schema: + type: string KindID: description: Entity kind. in: path @@ -843,6 +862,17 @@ components: required: false schema: $ref: '#/components/schemas/ServiceDefinitionSchemaVersions' + SearchIssuesIncludeQueryParameter: + description: Comma-separated list of relationship objects that should be included + in the response. + explode: false + in: query + name: include + required: false + schema: + items: + $ref: '#/components/schemas/SearchIssuesIncludeQueryParameterItem' + type: array SecurityFilterID: description: The ID of the security filter. in: path @@ -18393,6 +18423,18 @@ components: $ref: '#/components/schemas/GetInterfacesData' type: array type: object + GetIssueIncludeQueryParameterItem: + description: Relationship object that should be included in the response. + enum: + - assignee + - case + - team_owners + example: case + type: string + x-enum-varnames: + - ASSIGNEE + - CASE + - TEAM_OWNERS GetResourceEvaluationFiltersResponse: description: The definition of `GetResourceEvaluationFiltersResponse` object. properties: @@ -21517,6 +21559,773 @@ components: - DOWN - WARNING - 'OFF' + Issue: + description: The issue matching the request. + properties: + attributes: + $ref: '#/components/schemas/IssueAttributes' + id: + description: Issue identifier. + example: c1726a66-1f64-11ee-b338-da7ad0900002 + type: string + relationships: + $ref: '#/components/schemas/IssueRelationships' + type: + $ref: '#/components/schemas/IssueType' + required: + - id + - type + - attributes + type: object + IssueAssigneeRelationship: + description: Relationship between the issue and assignee. + properties: + data: + $ref: '#/components/schemas/IssueUserReference' + required: + - data + type: object + IssueAttributes: + description: Object containing the information of an issue. + properties: + error_message: + description: Error message associated with the issue. + example: object of type 'NoneType' has no len() + type: string + error_type: + description: Type of the error that matches the issue. + example: builtins.TypeError + type: string + file_path: + description: Path of the file where the issue occurred. + example: /django-email/conduit/apps/core/utils.py + type: string + first_seen: + description: Timestamp of the first seen error in milliseconds since the + Unix epoch. + example: 1671612804001 + format: int64 + type: integer + first_seen_version: + description: The application version (for example, git commit hash) where + the issue was first observed. + example: aaf65cd0 + type: string + function_name: + description: Name of the function where the issue occurred. + example: filter_forbidden_tags + type: string + is_crash: + description: Error is a crash. + example: false + type: boolean + languages: + description: Array of programming languages associated with the issue. + example: + - PYTHON + - GO + items: + $ref: '#/components/schemas/IssueLanguage' + type: array + last_seen: + description: Timestamp of the last seen error in milliseconds since the + Unix epoch. + example: 1671620003100 + format: int64 + type: integer + last_seen_version: + description: The application version (for example, git commit hash) where + the issue was last observed. + example: b6199f80 + type: string + platform: + $ref: '#/components/schemas/IssuePlatform' + service: + description: Service name. + example: email-api-py + type: string + state: + $ref: '#/components/schemas/IssueState' + type: object + IssueCase: + description: The case attached to the issue. + properties: + attributes: + $ref: '#/components/schemas/IssueCaseAttributes' + id: + description: Case identifier. + example: 2841440d-e780-4fe2-96cd-6a8c1d194da5 + type: string + relationships: + $ref: '#/components/schemas/IssueCaseRelationships' + type: + $ref: '#/components/schemas/IssueCaseResourceType' + required: + - id + - type + - attributes + type: object + IssueCaseAttributes: + description: Object containing the information of a case. + properties: + archived_at: + description: Timestamp of when the case was archived. + example: '2025-01-01T00:00:00Z' + format: date-time + type: string + closed_at: + description: Timestamp of when the case was closed. + example: '2025-01-01T00:00:00Z' + format: date-time + type: string + created_at: + description: Timestamp of when the case was created. + example: '2025-01-01T00:00:00Z' + format: date-time + type: string + creation_source: + description: Source of the case creation. + example: ERROR_TRACKING + type: string + description: + description: Description of the case. + type: string + due_date: + description: Due date of the case. + example: '2025-01-01' + type: string + insights: + description: Insights of the case. + items: + $ref: '#/components/schemas/IssueCaseInsight' + type: array + jira_issue: + $ref: '#/components/schemas/IssueCaseJiraIssue' + key: + description: Key of the case. + example: ET-123 + type: string + modified_at: + description: Timestamp of when the case was last modified. + example: '2025-01-01T00:00:00Z' + format: date-time + type: string + priority: + $ref: '#/components/schemas/CasePriority' + status: + $ref: '#/components/schemas/CaseStatus' + title: + description: Title of the case. + example: 'Error: HTTP error' + type: string + type: + description: Type of the case. + example: ERROR_TRACKING_ISSUE + type: string + type: object + IssueCaseInsight: + description: Insight of the case. + properties: + ref: + description: Reference of the insight. + example: /error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5 + type: string + resource_id: + description: Insight identifier. + example: 2841440d-e780-4fe2-96cd-6a8c1d194da5 + type: string + type: + description: Type of the insight. + example: ERROR_TRACKING + type: string + type: object + IssueCaseJiraIssue: + description: Jira issue of the case. + properties: + result: + $ref: '#/components/schemas/IssueCaseJiraIssueResult' + status: + description: Creation status of the Jira issue. + example: COMPLETED + type: string + type: object + IssueCaseJiraIssueResult: + description: Contains the identifiers and URL for a successfully created Jira + issue. + properties: + issue_id: + description: Jira issue identifier. + example: '1904866' + type: string + issue_key: + description: Jira issue key. + example: ET-123 + type: string + issue_url: + description: Jira issue URL. + example: https://your-jira-instance.atlassian.net/browse/ET-123 + type: string + project_key: + description: Jira project key. + example: ET + type: string + type: object + IssueCaseReference: + description: The case the issue is attached to. + properties: + id: + description: Case identifier. + example: 2841440d-e780-4fe2-96cd-6a8c1d194da5 + type: string + type: + $ref: '#/components/schemas/IssueCaseResourceType' + required: + - id + - type + type: object + IssueCaseRelationship: + description: Relationship between the issue and case. + properties: + data: + $ref: '#/components/schemas/IssueCaseReference' + required: + - data + type: object + IssueCaseRelationships: + description: Resources related to a case. + properties: + assignee: + $ref: '#/components/schemas/NullableUserRelationship' + created_by: + $ref: '#/components/schemas/NullableUserRelationship' + modified_by: + $ref: '#/components/schemas/NullableUserRelationship' + project: + $ref: '#/components/schemas/ProjectRelationship' + type: object + IssueCaseResourceType: + description: Type of the object. + enum: + - case + example: case + type: string + x-enum-varnames: + - CASE + IssueIncluded: + description: An array of related resources, returned when the `include` query + parameter is used. + oneOf: + - $ref: '#/components/schemas/IssueCase' + - $ref: '#/components/schemas/IssueUser' + - $ref: '#/components/schemas/IssueTeam' + IssueLanguage: + description: Programming language associated with the issue. + enum: + - BRIGHTSCRIPT + - C + - C_PLUS_PLUS + - C_SHARP + - CLOJURE + - DOT_NET + - ELIXIR + - ERLANG + - GO + - GROOVY + - HASKELL + - HCL + - JAVA + - JAVASCRIPT + - JVM + - KOTLIN + - OBJECTIVE_C + - PERL + - PHP + - PYTHON + - RUBY + - RUST + - SCALA + - SWIFT + - TERRAFORM + - TYPESCRIPT + - UNKNOWN + example: PYTHON + type: string + x-enum-varnames: + - BRIGHTSCRIPT + - C + - C_PLUS_PLUS + - C_SHARP + - CLOJURE + - DOT_NET + - ELIXIR + - ERLANG + - GO + - GROOVY + - HASKELL + - HCL + - JAVA + - JAVASCRIPT + - JVM + - KOTLIN + - OBJECTIVE_C + - PERL + - PHP + - PYTHON + - RUBY + - RUST + - SCALA + - SWIFT + - TERRAFORM + - TYPESCRIPT + - UNKNOWN + IssuePlatform: + description: Platform associated with the issue. + enum: + - ANDROID + - BACKEND + - BROWSER + - FLUTTER + - IOS + - REACT_NATIVE + - ROKU + - UNKNOWN + example: BACKEND + type: string + x-enum-varnames: + - ANDROID + - BACKEND + - BROWSER + - FLUTTER + - IOS + - REACT_NATIVE + - ROKU + - UNKNOWN + IssueReference: + description: The issue the search result corresponds to. + properties: + id: + description: Issue identifier. + example: c1726a66-1f64-11ee-b338-da7ad0900002 + type: string + type: + $ref: '#/components/schemas/IssueType' + required: + - id + - type + type: object + IssueRelationships: + description: Relationship between the issue and an assignee, case and/or teams. + properties: + assignee: + $ref: '#/components/schemas/IssueAssigneeRelationship' + case: + $ref: '#/components/schemas/IssueCaseRelationship' + team_owners: + $ref: '#/components/schemas/IssueTeamOwnersRelationship' + type: object + IssueResponse: + description: Response containing error tracking issue data. + properties: + data: + $ref: '#/components/schemas/Issue' + included: + description: Array of resources related to the issue. + items: + $ref: '#/components/schemas/IssueIncluded' + type: array + type: object + IssueState: + description: State of the issue + enum: + - OPEN + - ACKNOWLEDGED + - RESOLVED + - IGNORED + - EXCLUDED + example: RESOLVED + type: string + x-enum-varnames: + - OPEN + - ACKNOWLEDGED + - RESOLVED + - IGNORED + - EXCLUDED + IssueTeam: + description: A team that owns an issue. + properties: + attributes: + $ref: '#/components/schemas/IssueTeamAttributes' + id: + description: Team identifier. + example: 221b0179-6447-4d03-91c3-3ca98bf60e8a + type: string + type: + $ref: '#/components/schemas/IssueTeamType' + required: + - id + - type + - attributes + type: object + IssueTeamAttributes: + description: Object containing the information of a team. + properties: + handle: + description: The team's identifier. + example: team-handle + type: string + name: + description: The name of the team. + example: Team Name + type: string + summary: + description: A brief summary of the team, derived from its description. + example: This is a team. + type: string + type: object + IssueTeamOwnersRelationship: + description: Relationship between the issue and teams. + properties: + data: + description: Array of teams that are owners of the issue. + items: + $ref: '#/components/schemas/IssueTeamReference' + type: array + required: + - data + type: object + IssueTeamReference: + description: A team that owns the issue. + properties: + id: + description: Team identifier. + example: 221b0179-6447-4d03-91c3-3ca98bf60e8a + type: string + type: + $ref: '#/components/schemas/IssueTeamType' + required: + - id + - type + type: object + IssueTeamType: + description: Type of the object. + enum: + - team + example: team + type: string + x-enum-varnames: + - TEAM + IssueType: + description: Type of the object. + enum: + - issue + example: issue + type: string + x-enum-varnames: + - ISSUE + IssueUpdateAssigneeRequest: + description: Update issue assignee request payload. + properties: + data: + $ref: '#/components/schemas/IssueUpdateAssigneeRequestData' + required: + - data + type: object + IssueUpdateAssigneeRequestData: + description: Update issue assignee request. + properties: + id: + description: User identifier. + example: 87cb11a0-278c-440a-99fe-701223c80296 + type: string + type: + $ref: '#/components/schemas/IssueUpdateAssigneeRequestDataType' + required: + - id + - type + type: object + IssueUpdateAssigneeRequestDataType: + description: Type of the object. + enum: + - assignee + example: assignee + type: string + x-enum-varnames: + - ASSIGNEE + IssueUpdateStateRequest: + description: Update issue state request payload. + properties: + data: + $ref: '#/components/schemas/IssueUpdateStateRequestData' + required: + - data + type: object + IssueUpdateStateRequestData: + description: Update issue state request. + properties: + attributes: + $ref: '#/components/schemas/IssueUpdateStateRequestDataAttributes' + id: + description: Issue identifier. + example: c1726a66-1f64-11ee-b338-da7ad0900002 + type: string + type: + $ref: '#/components/schemas/IssueUpdateStateRequestDataType' + required: + - id + - type + - attributes + type: object + IssueUpdateStateRequestDataAttributes: + description: Object describing an issue state update request. + properties: + state: + $ref: '#/components/schemas/IssueState' + required: + - state + type: object + IssueUpdateStateRequestDataType: + description: Type of the object. + enum: + - error_tracking_issue + example: error_tracking_issue + type: string + x-enum-varnames: + - ERROR_TRACKING_ISSUE + IssueUser: + description: The user to whom the issue is assigned. + properties: + attributes: + $ref: '#/components/schemas/IssueUserAttributes' + id: + description: User identifier. + example: 87cb11a0-278c-440a-99fe-701223c80296 + type: string + type: + $ref: '#/components/schemas/IssueUserType' + required: + - id + - type + - attributes + type: object + IssueUserAttributes: + description: Object containing the information of a user. + properties: + email: + description: Email of the user. + example: user@company.com + type: string + handle: + description: Handle of the user. + example: User Handle + type: string + name: + description: Name of the user. + example: User Name + type: string + type: object + IssueUserReference: + description: The user the issue is assigned to. + properties: + id: + description: User identifier. + example: 87cb11a0-278c-440a-99fe-701223c80296 + type: string + type: + $ref: '#/components/schemas/IssueUserType' + required: + - id + - type + type: object + IssueUserType: + description: Type of the object + enum: + - user + example: user + type: string + x-enum-varnames: + - USER + IssuesSearchRequest: + description: Search issues request payload. + properties: + data: + $ref: '#/components/schemas/IssuesSearchRequestData' + required: + - data + type: object + IssuesSearchRequestData: + description: Search issues request. + properties: + attributes: + $ref: '#/components/schemas/IssuesSearchRequestDataAttributes' + type: + $ref: '#/components/schemas/IssuesSearchRequestDataType' + required: + - type + - attributes + type: object + IssuesSearchRequestDataAttributes: + description: Object describing a search issue request. + properties: + from: + description: Start date (inclusive) of the query in milliseconds since the + Unix epoch. + example: 1671612804000 + format: int64 + type: integer + order_by: + $ref: '#/components/schemas/IssuesSearchRequestDataAttributesOrderBy' + persona: + $ref: '#/components/schemas/IssuesSearchRequestDataAttributesPersona' + query: + description: Search query following the event search syntax. + example: service:orders-* AND @language:go + type: string + to: + description: End date (exclusive) of the query in milliseconds since the + Unix epoch. + example: 1671620004000 + format: int64 + type: integer + track: + $ref: '#/components/schemas/IssuesSearchRequestDataAttributesTrack' + required: + - query + - from + - to + type: object + IssuesSearchRequestDataAttributesOrderBy: + description: The attribute to sort the search results by. + enum: + - TOTAL_COUNT + - FIRST_SEEN + - IMPACTED_SESSIONS + - PRIORITY + example: IMPACTED_SESSIONS + type: string + x-enum-varnames: + - TOTAL_COUNT + - FIRST_SEEN + - IMPACTED_SESSIONS + - PRIORITY + IssuesSearchRequestDataAttributesPersona: + description: Persona for the search. Either track(s) or persona(s) must be specified. + enum: + - ALL + - BROWSER + - MOBILE + - BACKEND + example: BACKEND + type: string + x-enum-varnames: + - ALL + - BROWSER + - MOBILE + - BACKEND + IssuesSearchRequestDataAttributesTrack: + description: Track of the events to query. Either track(s) or persona(s) must + be specified. + enum: + - trace + - logs + - rum + example: trace + type: string + x-enum-varnames: + - TRACE + - LOGS + - RUM + IssuesSearchRequestDataType: + description: Type of the object. + enum: + - search_request + example: search_request + type: string + x-enum-varnames: + - SEARCH_REQUEST + IssuesSearchResponse: + description: Search issues response payload. + properties: + data: + description: Array of results matching the search query. + items: + $ref: '#/components/schemas/IssuesSearchResult' + type: array + included: + description: Array of resources related to the search results. + items: + $ref: '#/components/schemas/IssuesSearchResultIncluded' + type: array + type: object + IssuesSearchResult: + description: Result matching the search query. + properties: + attributes: + $ref: '#/components/schemas/IssuesSearchResultAttributes' + id: + description: Search result identifier (matches the nested issue's identifier). + example: c1726a66-1f64-11ee-b338-da7ad0900002 + type: string + relationships: + $ref: '#/components/schemas/IssuesSearchResultRelationships' + type: + $ref: '#/components/schemas/IssuesSearchResultType' + required: + - id + - type + - attributes + type: object + IssuesSearchResultAttributes: + description: Object containing the information of a search result. + properties: + impacted_sessions: + description: Count of sessions impacted by the issue over the queried time + window. + example: 12 + format: int64 + type: integer + impacted_users: + description: Count of users impacted by the issue over the queried time + window. + example: 4 + format: int64 + type: integer + total_count: + description: Total count of errors that match the issue over the queried + time window. + example: 82 + format: int64 + type: integer + type: object + IssuesSearchResultIncluded: + description: An array of related resources, returned when the `include` query + parameter is used. + oneOf: + - $ref: '#/components/schemas/Issue' + - $ref: '#/components/schemas/Case' + - $ref: '#/components/schemas/IssueUser' + - $ref: '#/components/schemas/IssueTeam' + IssuesSearchResultIssueRelationship: + description: Relationship between the search result and the corresponding issue. + properties: + data: + $ref: '#/components/schemas/IssueReference' + required: + - data + type: object + IssuesSearchResultRelationships: + description: Relationships between the search result and other resources. + properties: + issue: + $ref: '#/components/schemas/IssuesSearchResultIssueRelationship' + type: object + IssuesSearchResultType: + description: Type of the object. + enum: + - error_tracking_search_result + example: error_tracking_search_result + type: string + x-enum-varnames: + - ERROR_TRACKING_SEARCH_RESULT JSONAPIErrorItem: description: API error response body properties: @@ -36928,6 +37737,20 @@ components: type: string x-enum-varnames: - SCORECARD + SearchIssuesIncludeQueryParameterItem: + description: Relationship object that should be included in the search response. + enum: + - issue + - issue.assignee + - issue.case + - issue.team_owners + example: issue.case + type: string + x-enum-varnames: + - ISSUE + - ISSUE_ASSIGNEE + - ISSUE_CASE + - ISSUE_TEAM_OWNERS SecurityFilter: description: The security filter's properties. properties: @@ -46411,6 +47234,8 @@ components: data_scanner_write: Edit Data Scanner configurations. embeddable_graphs_share: Generate public links to share embeddable graphs externally. + error_tracking_read: Read Error Tracking data. + error_tracking_write: Edit Error Tracking issues. events_read: Read Events data. hosts_read: List hosts and their attributes. incident_notification_settings_write: Configure Incidents Notification @@ -53376,6 +54201,181 @@ paths: - monitors_downtime x-undo: type: idempotent + /api/v2/error-tracking/issues/search: + post: + description: Search issues endpoint allows you to programmatically search for + issues within your organization. This endpoint returns a list of issues that + match a given search query, following the event search syntax. The search + results are limited to a maximum of 100 issues per request. + operationId: SearchIssues + parameters: + - $ref: '#/components/parameters/SearchIssuesIncludeQueryParameter' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IssuesSearchRequest' + description: Search issues request payload. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IssuesSearchResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - error_tracking_read + summary: Search error tracking issues + tags: + - Error Tracking + x-given: + issue: + parameters: + - name: body + value: "{\n \"data\": {\n \"attributes\": {\n \"query\": \"service:synthetics-browser\",\n + \ \"from\": {{ timestamp(\"now - 15d\") }}000,\n \"to\": {{ + timestamp(\"now\") }}000,\n \"track\": \"rum\"\n },\n \"type\": + \"search_request\"\n }\n}" + source: data[0] + step: there is a valid "issue" in the system + x-menu-order: 1 + x-undo: + type: safe + /api/v2/error-tracking/issues/{issue_id}: + get: + description: Retrieve the full details for a specific error tracking issue, + including attributes and relationships. + operationId: GetIssue + parameters: + - $ref: '#/components/parameters/IssueIDPathParameter' + - $ref: '#/components/parameters/GetIssueIncludeQueryParameter' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IssueResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - error_tracking_read + summary: Get the details of an error tracking issue + tags: + - Error Tracking + x-menu-order: 2 + x-undo: + type: safe + /api/v2/error-tracking/issues/{issue_id}/assignee: + put: + description: Update the assignee of an issue by `issue_id`. + operationId: UpdateIssueAssignee + parameters: + - $ref: '#/components/parameters/IssueIDPathParameter' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IssueUpdateAssigneeRequest' + description: Update issue assignee request payload. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IssueResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - error_tracking_read + - error_tracking_write + - cases_read + - cases_write + summary: Update the assignee of an issue + tags: + - Error Tracking + x-menu-order: 4 + x-undo: + type: idempotent + /api/v2/error-tracking/issues/{issue_id}/state: + put: + description: Update the state of an issue by `issue_id`. Use this endpoint to + move an issue between states such as `OPEN`, `RESOLVED`, or `IGNORED`. + operationId: UpdateIssueState + parameters: + - $ref: '#/components/parameters/IssueIDPathParameter' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IssueUpdateStateRequest' + description: Update issue state request payload. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/IssueResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - error_tracking_read + - error_tracking_write + summary: Update the state of an issue + tags: + - Error Tracking + x-menu-order: 3 + x-undo: + type: idempotent /api/v2/events: get: description: 'List endpoint returns events that match an events search query. @@ -73708,6 +74708,9 @@ tags: end times, prevent all alerting related to specified Datadog tags.' name: Downtimes +- description: View and manage issues within Error Tracking. See the [Error Tracking + page](https://docs.datadoghq.com/error_tracking/) for more information. + name: Error Tracking - description: 'The Event Management API allows you to programmatically post events to the Events Explorer and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/) for more diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index 6d2c4c1a3c3be..594e7fe01ef65 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -623,6 +623,31 @@ "type": "string" } }, + "GetIssueIncludeQueryParameter": { + "description": "Comma-separated list of relationship objects that should be included in the response.", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "description": "Relationship object that should be included in the response.", + "enum": [ + "assignee", + "case", + "team_owners" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "ASSIGNEE", + "CASE", + "TEAM_OWNERS" + ] + }, + "type": "array" + } + }, "HistoricalJobID": { "description": "The ID of the job.", "in": "path", @@ -897,6 +922,16 @@ "type": "string" } }, + "IssueIDPathParameter": { + "description": "The identifier of the issue.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "in": "path", + "name": "issue_id", + "required": true, + "schema": { + "type": "string" + } + }, "KindID": { "description": "Entity kind.", "in": "path", @@ -1232,6 +1267,33 @@ ] } }, + "SearchIssuesIncludeQueryParameter": { + "description": "Comma-separated list of relationship objects that should be included in the response.", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "description": "Relationship object that should be included in the search response.", + "enum": [ + "issue", + "issue.assignee", + "issue.case", + "issue.team_owners" + ], + "example": "issue.case", + "type": "string", + "x-enum-varnames": [ + "ISSUE", + "ISSUE_ASSIGNEE", + "ISSUE_CASE", + "ISSUE_TEAM_OWNERS" + ] + }, + "type": "array" + } + }, "SecurityFilterID": { "description": "The ID of the security filter.", "in": "path", @@ -113951,6 +114013,21 @@ }, "type": "object" }, + "GetIssueIncludeQueryParameterItem": { + "description": "Relationship object that should be included in the response.", + "enum": [ + "assignee", + "case", + "team_owners" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "ASSIGNEE", + "CASE", + "TEAM_OWNERS" + ] + }, "GetResourceEvaluationFiltersResponse": { "description": "The definition of `GetResourceEvaluationFiltersResponse` object.", "properties": { @@ -147014,885 +147091,923 @@ "OFF" ] }, - "JSONAPIErrorItem": { - "description": "API error response body", + "Issue": { + "description": "The issue matching the request.", "properties": { - "detail": { - "description": "A human-readable explanation specific to this occurrence of the error.", - "example": "Missing required attribute in body", - "type": "string" - }, - "meta": { - "additionalProperties": {}, - "description": "Non-standard meta-information about the error", - "type": "object" - }, - "source": { - "description": "References to the source of the error.", + "attributes": { + "description": "Object containing the information of an issue.", "properties": { - "header": { - "description": "A string indicating the name of a single request header which caused the error.", - "example": "Authorization", + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", "type": "string" }, - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "limit", + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", "type": "string" }, - "pointer": { - "description": "A JSON pointer to the value in the request document that caused the error.", - "example": "/data/attributes/title", + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", + "type": "string" + }, + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" + }, + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", + "type": "string" + }, + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" + }, + "is_crash": { + "description": "Error is a crash.", + "example": false, + "type": "boolean" + }, + "languages": { + "description": "Array of programming languages associated with the issue.", + "example": [ + "PYTHON", + "GO" + ], + "items": { + "description": "Programming language associated with the issue.", + "enum": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ], + "example": "PYTHON", + "type": "string", + "x-enum-varnames": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ] + }, + "type": "array" + }, + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" + }, + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ] + }, + "service": { + "description": "Service name.", + "example": "email-api-py", "type": "string" + }, + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] } }, "type": "object" }, - "status": { - "description": "Status code of the response.", - "example": "400", - "type": "string" - }, - "title": { - "description": "Short human-readable summary of the error.", - "example": "Bad Request", - "type": "string" - } - }, - "type": "object" - }, - "JSONAPIErrorItemSource": { - "description": "References to the source of the error.", - "properties": { - "header": { - "description": "A string indicating the name of a single request header which caused the error.", - "example": "Authorization", - "type": "string" - }, - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "limit", + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", "type": "string" }, - "pointer": { - "description": "A JSON pointer to the value in the request document that caused the error.", - "example": "/data/attributes/title", - "type": "string" - } - }, - "type": "object" - }, - "JSONAPIErrorResponse": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", - "items": { - "description": "API error response body", - "properties": { - "detail": { - "description": "A human-readable explanation specific to this occurrence of the error.", - "example": "Missing required attribute in body", - "type": "string" - }, - "meta": { - "additionalProperties": {}, - "description": "Non-standard meta-information about the error", - "type": "object" - }, - "source": { - "description": "References to the source of the error.", - "properties": { - "header": { - "description": "A string indicating the name of a single request header which caused the error.", - "example": "Authorization", - "type": "string" - }, - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "limit", - "type": "string" + "relationships": { + "description": "Relationship between the issue and an assignee, case and/or teams.", + "properties": { + "assignee": { + "description": "Relationship between the issue and assignee.", + "properties": { + "data": { + "description": "The user the issue is assigned to.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } }, - "pointer": { - "description": "A JSON pointer to the value in the request document that caused the error.", - "example": "/data/attributes/title", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "Status code of the response.", - "example": "400", - "type": "string" + "required": [ + "id", + "type" + ], + "type": "object" + } }, - "title": { - "description": "Short human-readable summary of the error.", - "example": "Bad Request", - "type": "string" - } + "required": [ + "data" + ], + "type": "object" }, - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - }, - "JiraIntegrationMetadata": { - "description": "Incident integration metadata for the Jira integration.", - "properties": { - "issues": { - "description": "Array of Jira issues in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Jira integration metadata issue array.", - "properties": { - "account": { - "description": "URL of issue's Jira account.", - "example": "https://example.atlassian.net", - "type": "string" - }, - "issue_key": { - "description": "Jira issue's issue key.", - "example": "PROJ-123", - "type": "string" - }, - "issuetype_id": { - "description": "Jira issue's issue type.", - "example": "1000", - "type": "string" - }, - "project_key": { - "description": "Jira issue's project keys.", - "example": "PROJ", - "type": "string" + "case": { + "description": "Relationship between the issue and case.", + "properties": { + "data": { + "description": "The case the issue is attached to.", + "properties": { + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } }, - "redirect_url": { - "description": "URL redirecting to the Jira issue.", - "example": "https://example.atlassian.net/browse/PROJ-123", - "type": "string" - } - }, - "required": [ - "project_key", - "account" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "issues" - ], - "type": "object" - }, - "JiraIntegrationMetadataIssuesItem": { - "description": "Item in the Jira integration metadata issue array.", - "properties": { - "account": { - "description": "URL of issue's Jira account.", - "example": "https://example.atlassian.net", - "type": "string" - }, - "issue_key": { - "description": "Jira issue's issue key.", - "example": "PROJ-123", - "type": "string" - }, - "issuetype_id": { - "description": "Jira issue's issue type.", - "example": "1000", - "type": "string" - }, - "project_key": { - "description": "Jira issue's project keys.", - "example": "PROJ", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Jira issue.", - "example": "https://example.atlassian.net/browse/PROJ-123", - "type": "string" - } - }, - "required": [ - "project_key", - "account" - ], - "type": "object" - }, - "JiraIssue": { - "description": "Jira issue attached to case", - "nullable": true, - "properties": { - "result": { - "description": "Jira issue information", - "properties": { - "issue_id": { - "description": "Jira issue ID", - "type": "string" - }, - "issue_key": { - "description": "Jira issue key", - "type": "string" - }, - "issue_url": { - "description": "Jira issue URL", - "type": "string" + "required": [ + "data" + ], + "type": "object" }, - "project_key": { - "description": "Jira project key", - "type": "string" + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" } }, "type": "object" }, - "status": { - "default": "IN_PROGRESS", - "description": "Case status", + "type": { + "description": "Type of the object.", "enum": [ - "IN_PROGRESS", - "COMPLETED", - "FAILED" + "issue" ], - "example": "COMPLETED", - "readOnly": true, + "example": "issue", "type": "string", "x-enum-varnames": [ - "IN_PROGRESS", - "COMPLETED", - "FAILED" + "ISSUE" ] } }, - "readOnly": true, - "type": "object" - }, - "JiraIssueResult": { - "description": "Jira issue information", - "properties": { - "issue_id": { - "description": "Jira issue ID", - "type": "string" - }, - "issue_key": { - "description": "Jira issue key", - "type": "string" - }, - "issue_url": { - "description": "Jira issue URL", - "type": "string" - }, - "project_key": { - "description": "Jira project key", - "type": "string" - } - }, + "required": [ + "id", + "type", + "attributes" + ], "type": "object" }, - "JobCreateResponse": { - "description": "Run a historical job response.", + "IssueAssigneeRelationship": { + "description": "Relationship between the issue and assignee.", "properties": { "data": { - "description": "The definition of `JobCreateResponseData` object.", + "description": "The user the issue is assigned to.", "properties": { "id": { - "description": "ID of the created job.", + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", "type": "string" }, "type": { - "description": "Type of payload.", + "description": "Type of the object", "enum": [ - "historicalDetectionsJob" + "user" ], + "example": "user", "type": "string", "x-enum-varnames": [ - "HISTORICALDETECTIONSJOB" + "USER" ] } }, + "required": [ + "id", + "type" + ], "type": "object" } }, + "required": [ + "data" + ], "type": "object" }, - "JobCreateResponseData": { - "description": "The definition of `JobCreateResponseData` object.", + "IssueAttributes": { + "description": "Object containing the information of an issue.", "properties": { - "id": { - "description": "ID of the created job.", + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", "type": "string" }, - "type": { - "description": "Type of payload.", + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", + "type": "string" + }, + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", + "type": "string" + }, + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" + }, + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", + "type": "string" + }, + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" + }, + "is_crash": { + "description": "Error is a crash.", + "example": false, + "type": "boolean" + }, + "languages": { + "description": "Array of programming languages associated with the issue.", + "example": [ + "PYTHON", + "GO" + ], + "items": { + "description": "Programming language associated with the issue.", + "enum": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ], + "example": "PYTHON", + "type": "string", + "x-enum-varnames": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ] + }, + "type": "array" + }, + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" + }, + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", "enum": [ - "historicalDetectionsJob" + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" ], + "example": "BACKEND", "type": "string", "x-enum-varnames": [ - "HISTORICALDETECTIONSJOB" + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ] + }, + "service": { + "description": "Service name.", + "example": "email-api-py", + "type": "string" + }, + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" ] } }, "type": "object" }, - "JobDefinition": { - "description": "Definition of a historical job.", + "IssueCase": { + "description": "The case attached to the issue.", "properties": { - "calculatedFields": { - "description": "Calculated fields.", - "items": { - "description": "Calculated field.", - "properties": { - "expression": { - "description": "Expression.", - "example": "@request_end_timestamp - @request_start_timestamp", - "type": "string" + "attributes": { + "description": "Object containing the information of a case.", + "properties": { + "archived_at": { + "description": "Timestamp of when the case was archived.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "closed_at": { + "description": "Timestamp of when the case was closed.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "created_at": { + "description": "Timestamp of when the case was created.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "creation_source": { + "description": "Source of the case creation.", + "example": "ERROR_TRACKING", + "type": "string" + }, + "description": { + "description": "Description of the case.", + "type": "string" + }, + "due_date": { + "description": "Due date of the case.", + "example": "2025-01-01", + "type": "string" + }, + "insights": { + "description": "Insights of the case.", + "items": { + "description": "Insight of the case.", + "properties": { + "ref": { + "description": "Reference of the insight.", + "example": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "resource_id": { + "description": "Insight identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the insight.", + "example": "ERROR_TRACKING", + "type": "string" + } + }, + "type": "object" }, - "name": { - "description": "Field name.", - "example": "response_time", - "type": "string" - } + "type": "array" }, - "required": [ - "name", - "expression" - ], - "type": "object" - }, - "type": "array" - }, - "cases": { - "description": "Cases used for generating job results.", - "items": { - "description": "Case when signal is generated.", - "properties": { - "actions": { - "description": "Action to perform for each rule case.", - "items": { - "description": "Action to perform when a signal is triggered. Only available for Application Security rule type.", + "jira_issue": { + "description": "Jira issue of the case.", + "properties": { + "result": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", "properties": { - "options": { - "additionalProperties": {}, - "description": "Options for the rule action", - "properties": { - "duration": { - "description": "Duration of the action in seconds. 0 indicates no expiration.", - "example": 0, - "format": "int64", - "minimum": 0, - "type": "integer" - }, - "flaggedIPType": { - "description": "Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses.", - "enum": [ - "SUSPICIOUS", - "FLAGGED" - ], - "example": "FLAGGED", - "type": "string", - "x-enum-varnames": [ - "SUSPICIOUS", - "FLAGGED" - ] - }, - "userBehaviorName": { - "description": "Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.", - "type": "string" - } - }, - "type": "object" + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", + "type": "string" }, - "type": { - "description": "The action type.", - "enum": [ - "block_ip", - "block_user", - "user_behavior", - "flag_ip" - ], - "type": "string", - "x-enum-varnames": [ - "BLOCK_IP", - "BLOCK_USER", - "USER_BEHAVIOR", - "FLAG_IP" - ] + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", + "type": "string" + }, + "project_key": { + "description": "Jira project key.", + "example": "ET", + "type": "string" } }, "type": "object" }, - "type": "array" - }, - "condition": { - "description": "A case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.", - "type": "string" - }, - "name": { - "description": "Name of the case.", - "type": "string" - }, - "notifications": { - "description": "Notification targets.", - "items": { - "description": "Notification.", + "status": { + "description": "Creation status of the Jira issue.", + "example": "COMPLETED", "type": "string" - }, - "type": "array" + } }, - "status": { - "description": "Severity of the Security Signal.", - "enum": [ - "info", - "low", - "medium", - "high", - "critical" - ], - "example": "critical", - "type": "string", - "x-enum-varnames": [ - "INFO", - "LOW", - "MEDIUM", - "HIGH", - "CRITICAL" - ] - } + "type": "object" }, - "required": [ - "status" - ], - "type": "object" - }, - "type": "array" - }, - "from": { - "description": "Starting time of data analyzed by the job.", - "example": 1729843470000, - "format": "int64", - "type": "integer" - }, - "groupSignalsBy": { - "description": "Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.", - "example": [ - "service" - ], - "items": { - "description": "Field to group by.", - "type": "string" - }, - "type": "array" - }, - "index": { - "description": "Index used to load the data.", - "example": "cloud_siem", - "type": "string" - }, - "message": { - "description": "Message for generated results.", - "example": "A large number of failed login attempts.", - "type": "string" - }, - "name": { - "description": "Job name.", - "example": "Excessive number of failed attempts.", - "type": "string" - }, - "options": { - "description": "Job options.", - "properties": { - "detectionMethod": { - "description": "The detection method.", + "key": { + "description": "Key of the case.", + "example": "ET-123", + "type": "string" + }, + "modified_at": { + "description": "Timestamp of when the case was last modified.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", "enum": [ - "threshold", - "new_value", - "anomaly_detection", - "impossible_travel", - "hardcoded", - "third_party", - "anomaly_threshold" + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" ], + "example": "NOT_DEFINED", "type": "string", "x-enum-varnames": [ - "THRESHOLD", - "NEW_VALUE", - "ANOMALY_DETECTION", - "IMPOSSIBLE_TRAVEL", - "HARDCODED", - "THIRD_PARTY", - "ANOMALY_THRESHOLD" + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" ] }, - "evaluationWindow": { - "description": "A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used.", + "status": { + "description": "Case status", "enum": [ - 0, - 60, - 300, - 600, - 900, - 1800, - 3600, - 7200, - 10800, - 21600, - 43200, - 86400 + "OPEN", + "IN_PROGRESS", + "CLOSED" ], - "format": "int32", - "type": "integer", + "example": "OPEN", + "type": "string", "x-enum-varnames": [ - "ZERO_MINUTES", - "ONE_MINUTE", - "FIVE_MINUTES", - "TEN_MINUTES", - "FIFTEEN_MINUTES", - "THIRTY_MINUTES", - "ONE_HOUR", - "TWO_HOURS", - "THREE_HOURS", - "SIX_HOURS", - "TWELVE_HOURS", - "ONE_DAY" + "OPEN", + "IN_PROGRESS", + "CLOSED" ] }, - "impossibleTravelOptions": { - "description": "Options on impossible travel detection method.", + "title": { + "description": "Title of the case.", + "example": "Error: HTTP error", + "type": "string" + }, + "type": { + "description": "Type of the case.", + "example": "ERROR_TRACKING_ISSUE", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "relationships": { + "description": "Resources related to a case.", + "properties": { + "assignee": { + "description": "Relationship to user.", + "nullable": true, "properties": { - "baselineUserLocations": { - "description": "If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.", - "example": true, - "type": "boolean" + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" } }, - "type": "object" - }, - "keepAlive": { - "description": "Once a signal is generated, the signal will remain \"open\" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used.", - "enum": [ - 0, - 60, - 300, - 600, - 900, - 1800, - 3600, - 7200, - 10800, - 21600, - 43200, - 86400 - ], - "format": "int32", - "type": "integer", - "x-enum-varnames": [ - "ZERO_MINUTES", - "ONE_MINUTE", - "FIVE_MINUTES", - "TEN_MINUTES", - "FIFTEEN_MINUTES", - "THIRTY_MINUTES", - "ONE_HOUR", - "TWO_HOURS", - "THREE_HOURS", - "SIX_HOURS", - "TWELVE_HOURS", - "ONE_DAY" - ] - }, - "maxSignalDuration": { - "description": "A signal will \"close\" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp.", - "enum": [ - 0, - 60, - 300, - 600, - 900, - 1800, - 3600, - 7200, - 10800, - 21600, - 43200, - 86400 + "required": [ + "data" ], - "format": "int32", - "type": "integer", - "x-enum-varnames": [ - "ZERO_MINUTES", - "ONE_MINUTE", - "FIVE_MINUTES", - "TEN_MINUTES", - "FIFTEEN_MINUTES", - "THIRTY_MINUTES", - "ONE_HOUR", - "TWO_HOURS", - "THREE_HOURS", - "SIX_HOURS", - "TWELVE_HOURS", - "ONE_DAY" - ] + "type": "object" }, - "newValueOptions": { - "description": "Options on new value detection method.", + "created_by": { + "description": "Relationship to user.", + "nullable": true, "properties": { - "forgetAfter": { - "description": "The duration in days after which a learned value is forgotten.", - "enum": [ - 1, - 2, - 7, - 14, - 21, - 28 - ], - "format": "int32", - "type": "integer", - "x-enum-varnames": [ - "ONE_DAY", - "TWO_DAYS", - "ONE_WEEK", - "TWO_WEEKS", - "THREE_WEEKS", - "FOUR_WEEKS" - ] - }, - "learningDuration": { - "default": 0, - "description": "The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned.", - "enum": [ - 0, - 1, - 7 - ], - "format": "int32", - "type": "integer", - "x-enum-varnames": [ - "ZERO_DAYS", - "ONE_DAY", - "SEVEN_DAYS" - ] - }, - "learningMethod": { - "default": "duration", - "description": "The learning method used to determine when signals should be generated for values that weren't learned.", - "enum": [ - "duration", - "threshold" - ], - "type": "string", - "x-enum-varnames": [ - "DURATION", - "THRESHOLD" - ] - }, - "learningThreshold": { - "default": 0, - "description": "A number of occurrences after which signals will be generated for values that weren't learned.", - "enum": [ - 0, - 1 + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" ], - "format": "int32", - "type": "integer", - "x-enum-varnames": [ - "ZERO_OCCURRENCES", - "ONE_OCCURRENCE" - ] + "type": "object" } }, + "required": [ + "data" + ], "type": "object" }, - "thirdPartyRuleOptions": { - "description": "Options on third party detection method.", + "modified_by": { + "description": "Relationship to user.", + "nullable": true, "properties": { - "defaultNotifications": { - "description": "Notification targets for the logs that do not correspond to any of the cases.", - "items": { - "description": "Notification.", - "type": "string" + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } }, - "type": "array" - }, - "defaultStatus": { - "description": "Severity of the Security Signal.", - "enum": [ - "info", - "low", - "medium", - "high", - "critical" + "required": [ + "id", + "type" ], - "example": "critical", - "type": "string", - "x-enum-varnames": [ - "INFO", - "LOW", - "MEDIUM", - "HIGH", - "CRITICAL" - ] - }, - "rootQueries": { - "description": "Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.", - "items": { - "description": "A query to be combined with the third party case query.", - "properties": { - "groupByFields": { - "description": "Fields to group by.", - "items": { - "description": "Field.", - "type": "string" - }, - "type": "array" - }, - "query": { - "description": "Query to run on logs.", - "example": "source:cloudtrail", - "type": "string" - } + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "project": { + "description": "Relationship to project", + "properties": { + "data": { + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" }, - "type": "object" + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] + } }, - "type": "array" - }, - "signalTitleTemplate": { - "description": "A template for the signal title; if omitted, the title is generated based on the case name.", - "type": "string" + "required": [ + "id", + "type" + ], + "type": "object" } }, + "required": [ + "data" + ], "type": "object" } }, "type": "object" }, - "queries": { - "description": "Queries for selecting logs analyzed by the job.", - "items": { - "description": "Query for selecting logs analyzed by the historical job.", - "properties": { - "aggregation": { - "description": "The aggregation type.", - "enum": [ - "count", - "cardinality", - "sum", - "max", - "new_value", - "geo_data", - "event_count", - "none" - ], - "type": "string", - "x-enum-varnames": [ - "COUNT", - "CARDINALITY", - "SUM", - "MAX", - "NEW_VALUE", - "GEO_DATA", - "EVENT_COUNT", - "NONE" - ] - }, - "dataSource": { - "default": "logs", - "description": "Source of events, either logs, audit trail, or Datadog events.", - "enum": [ - "logs", - "audit", - "app_sec_spans", - "spans", - "security_runtime", - "network", - "events" - ], - "example": "logs", - "type": "string", - "x-enum-varnames": [ - "LOGS", - "AUDIT", - "APP_SEC_SPANS", - "SPANS", - "SECURITY_RUNTIME", - "NETWORK", - "EVENTS" - ] - }, - "distinctFields": { - "description": "Field for which the cardinality is measured. Sent as an array.", - "items": { - "description": "Field.", - "type": "string" - }, - "type": "array" - }, - "groupByFields": { - "description": "Fields to group by.", - "items": { - "description": "Field.", - "type": "string" - }, - "type": "array" - }, - "hasOptionalGroupByFields": { - "description": "When false, events without a group-by value are ignored by the query. When true, events with missing group-by fields are processed with `N/A`, replacing the missing values.", - "example": false, - "readOnly": true, - "type": "boolean" - }, - "metrics": { - "description": "Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.", - "items": { - "description": "Field.", - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name of the query.", - "type": "string" - }, - "query": { - "description": "Query to run on logs.", - "example": "a > 3", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "IssueCaseAttributes": { + "description": "Object containing the information of a case.", + "properties": { + "archived_at": { + "description": "Timestamp of when the case was archived.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" }, - "referenceTables": { - "description": "Reference tables used in the queries.", + "closed_at": { + "description": "Timestamp of when the case was closed.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "created_at": { + "description": "Timestamp of when the case was created.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "creation_source": { + "description": "Source of the case creation.", + "example": "ERROR_TRACKING", + "type": "string" + }, + "description": { + "description": "Description of the case.", + "type": "string" + }, + "due_date": { + "description": "Due date of the case.", + "example": "2025-01-01", + "type": "string" + }, + "insights": { + "description": "Insights of the case.", "items": { - "description": "Reference tables used in the queries.", + "description": "Insight of the case.", "properties": { - "checkPresence": { - "description": "Whether to include or exclude the matched values.", - "type": "boolean" - }, - "columnName": { - "description": "The name of the column in the reference table.", - "type": "string" - }, - "logFieldPath": { - "description": "The field in the log to match against the reference table.", + "ref": { + "description": "Reference of the insight.", + "example": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, - "ruleQueryName": { - "description": "The name of the query to apply the reference table to.", + "resource_id": { + "description": "Insight identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, - "tableName": { - "description": "The name of the reference table.", + "type": { + "description": "Type of the insight.", + "example": "ERROR_TRACKING", "type": "string" } }, @@ -147900,682 +148015,6152 @@ }, "type": "array" }, - "tags": { - "description": "Tags for generated signals.", - "items": { - "type": "string" - }, - "type": "array" - }, - "thirdPartyCases": { - "description": "Cases for generating results from third-party detection method. Only available for third-party detection method.", - "example": [], - "items": { - "description": "Case when a signal is generated by a third party rule.", - "properties": { - "name": { - "description": "Name of the case.", - "type": "string" - }, - "notifications": { - "description": "Notification targets for each case.", - "items": { - "description": "Notification.", + "jira_issue": { + "description": "Jira issue of the case.", + "properties": { + "result": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", + "properties": { + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", "type": "string" }, - "type": "array" - }, - "query": { - "description": "A query to map a third party event to this case.", - "type": "string" + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", + "type": "string" + }, + "project_key": { + "description": "Jira project key.", + "example": "ET", + "type": "string" + } }, - "status": { - "description": "Severity of the Security Signal.", - "enum": [ - "info", - "low", - "medium", - "high", - "critical" - ], - "example": "critical", - "type": "string", - "x-enum-varnames": [ - "INFO", - "LOW", - "MEDIUM", - "HIGH", - "CRITICAL" - ] - } + "type": "object" }, - "required": [ - "status" - ], - "type": "object" + "status": { + "description": "Creation status of the Jira issue.", + "example": "COMPLETED", + "type": "string" + } }, - "type": "array" - }, - "to": { - "description": "Ending time of data analyzed by the job.", - "example": 1729847070000, - "format": "int64", - "type": "integer" + "type": "object" }, - "type": { - "description": "Job type.", + "key": { + "description": "Key of the case.", + "example": "ET-123", "type": "string" - } - }, - "required": [ - "from", - "to", - "index", - "name", - "cases", - "queries", - "message" - ], - "type": "object" - }, - "JobDefinitionFromRule": { - "description": "Definition of a historical job based on a security monitoring rule.", - "properties": { - "from": { - "description": "Starting time of data analyzed by the job.", - "example": 1729843470000, - "format": "int64", - "type": "integer" }, - "id": { - "description": "ID of the detection rule used to create the job.", - "example": "abc-def-ghi", + "modified_at": { + "description": "Timestamp of when the case was last modified.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", "type": "string" }, - "index": { - "description": "Index used to load the data.", - "example": "cloud_siem", - "type": "string" + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] }, - "notifications": { - "description": "Notifications sent when the job is completed.", - "example": [ - "@sns-cloudtrail-results" + "status": { + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" ], - "items": { - "type": "string" - }, - "type": "array" + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] }, - "to": { - "description": "Ending time of data analyzed by the job.", - "example": 1729847070000, - "format": "int64", - "type": "integer" + "title": { + "description": "Title of the case.", + "example": "Error: HTTP error", + "type": "string" + }, + "type": { + "description": "Type of the case.", + "example": "ERROR_TRACKING_ISSUE", + "type": "string" } }, - "required": [ - "id", - "from", - "to", - "index" - ], "type": "object" }, - "KindAttributes": { - "description": "Kind attributes.", + "IssueCaseInsight": { + "description": "Insight of the case.", "properties": { - "description": { - "description": "Short description of the kind.", + "ref": { + "description": "Reference of the insight.", + "example": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, - "displayName": { - "description": "User friendly name of the kind.", + "resource_id": { + "description": "Insight identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, - "name": { - "description": "The kind name.", - "example": "my-job", - "minLength": 1, + "type": { + "description": "Type of the insight.", + "example": "ERROR_TRACKING", "type": "string" } }, "type": "object" }, - "KindData": { - "description": "Schema that defines the structure of a Kind object in the Software Catalog.", + "IssueCaseJiraIssue": { + "description": "Jira issue of the case.", "properties": { - "attributes": { - "description": "Kind attributes.", + "result": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", "properties": { - "description": { - "description": "Short description of the kind.", + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", "type": "string" }, - "displayName": { - "description": "User friendly name of the kind.", + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", "type": "string" }, - "name": { - "description": "The kind name.", - "example": "my-job", - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.", - "example": "4b163705-23c0-4573-b2fb-f6cea2163fcb", - "minLength": 1, - "type": "string" - }, - "meta": { - "description": "Kind metadata.", - "properties": { - "createdAt": { - "description": "The creation time.", + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", "type": "string" }, - "modifiedAt": { - "description": "The modification time.", + "project_key": { + "description": "Jira project key.", + "example": "ET", "type": "string" } }, "type": "object" }, - "type": { - "description": "Kind.", - "type": "string" - } - }, - "type": "object" - }, - "KindMetadata": { - "description": "Kind metadata.", - "properties": { - "createdAt": { - "description": "The creation time.", - "type": "string" - }, - "modifiedAt": { - "description": "The modification time.", + "status": { + "description": "Creation status of the Jira issue.", + "example": "COMPLETED", "type": "string" } }, "type": "object" }, - "KindObj": { - "description": "Schema for kind.", + "IssueCaseJiraIssueResult": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", "properties": { - "description": { - "description": "Short description of the kind.", + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", "type": "string" }, - "displayName": { - "description": "The display name of the kind. Automatically generated if not provided.", + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", "type": "string" }, - "kind": { - "description": "The name of the kind to create or update. This must be in kebab-case format.", - "example": "my-job", + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", "type": "string" - } - }, - "required": [ - "kind" - ], - "type": "object" - }, - "KindRaw": { - "description": "Kind definition in raw JSON or YAML representation.", - "example": "kind: service\ndisplayName: Service\ndescription: A service entity in the catalog.\n", - "type": "string" - }, - "KindResponseData": { - "description": "List of kind responses.", - "items": { - "description": "Schema that defines the structure of a Kind object in the Software Catalog.", - "properties": { - "attributes": { - "description": "Kind attributes.", - "properties": { - "description": { - "description": "Short description of the kind.", - "type": "string" - }, - "displayName": { - "description": "User friendly name of the kind.", - "type": "string" - }, - "name": { - "description": "The kind name.", - "example": "my-job", - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.", - "example": "4b163705-23c0-4573-b2fb-f6cea2163fcb", - "minLength": 1, - "type": "string" - }, - "meta": { - "description": "Kind metadata.", - "properties": { - "createdAt": { - "description": "The creation time.", - "type": "string" - }, - "modifiedAt": { - "description": "The modification time.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Kind.", - "type": "string" - } }, - "type": "object" - }, - "type": "array" - }, - "KindResponseMeta": { - "description": "Kind response metadata.", - "properties": { - "count": { - "description": "Total kinds count.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "LaunchDarklyAPIKey": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", - "properties": { - "api_token": { - "description": "The `LaunchDarklyAPIKey` `api_token`.", - "example": "", + "project_key": { + "description": "Jira project key.", + "example": "ET", "type": "string" - }, - "type": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", - "enum": [ - "LaunchDarklyAPIKey" - ], - "example": "LaunchDarklyAPIKey", - "type": "string", - "x-enum-varnames": [ - "LAUNCHDARKLYAPIKEY" - ] } }, - "required": [ - "type", - "api_token" - ], "type": "object" }, - "LaunchDarklyAPIKeyType": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", - "enum": [ - "LaunchDarklyAPIKey" - ], - "example": "LaunchDarklyAPIKey", - "type": "string", - "x-enum-varnames": [ - "LAUNCHDARKLYAPIKEY" - ] - }, - "LaunchDarklyAPIKeyUpdate": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + "IssueCaseReference": { + "description": "The case the issue is attached to.", "properties": { - "api_token": { - "description": "The `LaunchDarklyAPIKeyUpdate` `api_token`.", + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, "type": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + "description": "Type of the object.", "enum": [ - "LaunchDarklyAPIKey" + "case" ], - "example": "LaunchDarklyAPIKey", + "example": "case", "type": "string", "x-enum-varnames": [ - "LAUNCHDARKLYAPIKEY" + "CASE" ] } }, "required": [ + "id", "type" ], "type": "object" }, - "LaunchDarklyCredentials": { - "description": "The definition of the `LaunchDarklyCredentials` object.", - "oneOf": [ - { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + "IssueCaseRelationship": { + "description": "Relationship between the issue and case.", + "properties": { + "data": { + "description": "The case the issue is attached to.", "properties": { - "api_token": { - "description": "The `LaunchDarklyAPIKey` `api_token`.", - "example": "", + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, "type": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + "description": "Type of the object.", "enum": [ - "LaunchDarklyAPIKey" + "case" ], - "example": "LaunchDarklyAPIKey", + "example": "case", "type": "string", "x-enum-varnames": [ - "LAUNCHDARKLYAPIKEY" + "CASE" ] } }, "required": [ - "type", - "api_token" + "id", + "type" ], "type": "object" } - ] + }, + "required": [ + "data" + ], + "type": "object" }, - "LaunchDarklyCredentialsUpdate": { - "description": "The definition of the `LaunchDarklyCredentialsUpdate` object.", - "oneOf": [ - { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + "IssueCaseRelationships": { + "description": "Resources related to a case.", + "properties": { + "assignee": { + "description": "Relationship to user.", + "nullable": true, "properties": { - "api_token": { - "description": "The `LaunchDarklyAPIKeyUpdate` `api_token`.", - "type": "string" - }, - "type": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", - "enum": [ - "LaunchDarklyAPIKey" + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" ], - "example": "LaunchDarklyAPIKey", - "type": "string", - "x-enum-varnames": [ - "LAUNCHDARKLYAPIKEY" - ] + "type": "object" } }, "required": [ - "type" + "data" ], "type": "object" - } - ] - }, - "LaunchDarklyIntegration": { - "description": "The definition of the `LaunchDarklyIntegration` object.", - "properties": { - "credentials": { - "description": "The definition of the `LaunchDarklyCredentials` object.", - "oneOf": [ - { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + }, + "created_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, "properties": { - "api_token": { - "description": "The `LaunchDarklyAPIKey` `api_token`.", - "example": "", + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" }, "type": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + "default": "user", + "description": "User resource type.", "enum": [ - "LaunchDarklyAPIKey" + "user" ], - "example": "LaunchDarklyAPIKey", + "example": "user", "type": "string", "x-enum-varnames": [ - "LAUNCHDARKLYAPIKEY" + "USER" ] } }, "required": [ - "type", - "api_token" + "id", + "type" ], "type": "object" } - ] - }, - "type": { - "description": "The definition of the `LaunchDarklyIntegrationType` object.", - "enum": [ - "LaunchDarkly" + }, + "required": [ + "data" ], - "example": "LaunchDarkly", - "type": "string", - "x-enum-varnames": [ - "LAUNCHDARKLY" - ] - } - }, - "required": [ - "type", - "credentials" - ], - "type": "object" - }, - "LaunchDarklyIntegrationType": { - "description": "The definition of the `LaunchDarklyIntegrationType` object.", - "enum": [ - "LaunchDarkly" - ], - "example": "LaunchDarkly", - "type": "string", - "x-enum-varnames": [ - "LAUNCHDARKLY" - ] - }, - "LaunchDarklyIntegrationUpdate": { - "description": "The definition of the `LaunchDarklyIntegrationUpdate` object.", - "properties": { - "credentials": { - "description": "The definition of the `LaunchDarklyCredentialsUpdate` object.", - "oneOf": [ - { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + "type": "object" + }, + "modified_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, "properties": { - "api_token": { - "description": "The `LaunchDarklyAPIKeyUpdate` `api_token`.", + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" }, "type": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + "default": "user", + "description": "User resource type.", "enum": [ - "LaunchDarklyAPIKey" + "user" ], - "example": "LaunchDarklyAPIKey", + "example": "user", "type": "string", "x-enum-varnames": [ - "LAUNCHDARKLYAPIKEY" + "USER" ] } }, "required": [ + "id", "type" ], "type": "object" } - ] - }, - "type": { - "description": "The definition of the `LaunchDarklyIntegrationType` object.", - "enum": [ - "LaunchDarkly" + }, + "required": [ + "data" ], - "example": "LaunchDarkly", - "type": "string", - "x-enum-varnames": [ - "LAUNCHDARKLY" - ] - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "Layer": { - "description": "Encapsulates a layer resource, holding attributes like rotation details, plus relationships to the members covering that layer.", - "properties": { - "attributes": { - "description": "Describes key properties of a Layer, including rotation details, name, start/end times, and any restrictions.", + "type": "object" + }, + "project": { + "description": "Relationship to project", "properties": { - "effective_date": { - "description": "When the layer becomes active (ISO 8601).", - "format": "date-time", - "type": "string" - }, - "end_date": { - "description": "When the layer ceases to be active (ISO 8601).", - "format": "date-time", - "type": "string" - }, - "interval": { - "description": "Defines how often the rotation repeats, using a combination of days and optional seconds. Should be at least 1 hour.", + "data": { + "description": "Relationship to project object", "properties": { - "days": { - "description": "The number of days in each rotation cycle.", - "example": 1, - "format": "int32", - "maximum": 400, - "type": "integer" + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" }, - "seconds": { - "description": "Any additional seconds for the rotation cycle (up to 30 days).", - "example": 300, - "format": "int64", - "maximum": 2592000, - "type": "integer" + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] } }, + "required": [ + "id", + "type" + ], "type": "object" - }, - "name": { - "description": "The name of this layer.", - "example": "Weekend Layer", - "type": "string" - }, - "restrictions": { - "description": "An optional list of time restrictions for when this layer is in effect.", - "items": { - "description": "Defines a single time restriction rule with start and end times and the applicable weekdays.", - "properties": { - "end_day": { - "description": "A day of the week.", - "enum": [ - "monday", - "tuesday", - "wednesday", - "thursday", - "friday", - "saturday", - "sunday" - ], - "type": "string", - "x-enum-varnames": [ - "MONDAY", - "TUESDAY", - "WEDNESDAY", - "THURSDAY", - "FRIDAY", - "SATURDAY", - "SUNDAY" - ] - }, - "end_time": { - "description": "Specifies the ending time for this restriction.", - "type": "string" - }, - "start_day": { - "description": "A day of the week.", - "enum": [ - "monday", - "tuesday", - "wednesday", - "thursday", - "friday", - "saturday", - "sunday" - ], - "type": "string", - "x-enum-varnames": [ - "MONDAY", - "TUESDAY", - "WEDNESDAY", - "THURSDAY", - "FRIDAY", - "SATURDAY", - "SUNDAY" - ] - }, - "start_time": { - "description": "Specifies the starting time for this restriction.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "rotation_start": { - "description": "The date/time when the rotation starts (ISO 8601).", - "format": "date-time", - "type": "string" } }, + "required": [ + "data" + ], "type": "object" - }, - "id": { - "description": "A unique identifier for this layer.", - "type": "string" - }, - "relationships": { - "description": "Holds references to objects related to the Layer entity, such as its members.", + } + }, + "type": "object" + }, + "IssueCaseResourceType": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + }, + "IssueIncluded": { + "description": "An array of related resources, returned when the `include` query parameter is used.", + "oneOf": [ + { + "description": "The case attached to the issue.", "properties": { - "members": { - "description": "Holds an array of references to the members of a Layer, each containing member IDs.", + "attributes": { + "description": "Object containing the information of a case.", "properties": { - "data": { - "description": "The list of members who belong to this layer.", + "archived_at": { + "description": "Timestamp of when the case was archived.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "closed_at": { + "description": "Timestamp of when the case was closed.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "created_at": { + "description": "Timestamp of when the case was created.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "creation_source": { + "description": "Source of the case creation.", + "example": "ERROR_TRACKING", + "type": "string" + }, + "description": { + "description": "Description of the case.", + "type": "string" + }, + "due_date": { + "description": "Due date of the case.", + "example": "2025-01-01", + "type": "string" + }, + "insights": { + "description": "Insights of the case.", "items": { - "description": "Represents a single member object in a layer's `members` array, referencing\na unique Datadog user ID.", + "description": "Insight of the case.", "properties": { - "id": { - "description": "The unique user ID of the layer member.", - "example": "00000000-0000-0000-0000-000000000002", + "ref": { + "description": "Reference of the insight.", + "example": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "resource_id": { + "description": "Insight identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, "type": { - "default": "members", - "description": "Members resource type.", - "enum": [ - "members" - ], - "example": "members", - "type": "string", - "x-enum-varnames": [ - "MEMBERS" - ] + "description": "Type of the insight.", + "example": "ERROR_TRACKING", + "type": "string" } }, - "required": [ + "type": "object" + }, + "type": "array" + }, + "jira_issue": { + "description": "Jira issue of the case.", + "properties": { + "result": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", + "properties": { + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", + "type": "string" + }, + "project_key": { + "description": "Jira project key.", + "example": "ET", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Creation status of the Jira issue.", + "example": "COMPLETED", + "type": "string" + } + }, + "type": "object" + }, + "key": { + "description": "Key of the case.", + "example": "ET-123", + "type": "string" + }, + "modified_at": { + "description": "Timestamp of when the case was last modified.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] + }, + "status": { + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ], + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] + }, + "title": { + "description": "Title of the case.", + "example": "Error: HTTP error", + "type": "string" + }, + "type": { + "description": "Type of the case.", + "example": "ERROR_TRACKING_ISSUE", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "relationships": { + "description": "Resources related to a case.", + "properties": { + "assignee": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "created_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modified_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "project": { + "description": "Relationship to project", + "properties": { + "data": { + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" + }, + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "The user to whom the issue is assigned.", + "properties": { + "attributes": { + "description": "Object containing the information of a user.", + "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "User Name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + ] + }, + "IssueLanguage": { + "description": "Programming language associated with the issue.", + "enum": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ], + "example": "PYTHON", + "type": "string", + "x-enum-varnames": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ] + }, + "IssuePlatform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ] + }, + "IssueReference": { + "description": "The issue the search result corresponds to.", + "properties": { + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "IssueRelationships": { + "description": "Relationship between the issue and an assignee, case and/or teams.", + "properties": { + "assignee": { + "description": "Relationship between the issue and assignee.", + "properties": { + "data": { + "description": "The user the issue is assigned to.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "case": { + "description": "Relationship between the issue and case.", + "properties": { + "data": { + "description": "The case the issue is attached to.", + "properties": { + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "IssueResponse": { + "description": "Response containing error tracking issue data.", + "properties": { + "data": { + "description": "The issue matching the request.", + "properties": { + "attributes": { + "description": "Object containing the information of an issue.", + "properties": { + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", + "type": "string" + }, + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", + "type": "string" + }, + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", + "type": "string" + }, + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" + }, + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", + "type": "string" + }, + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" + }, + "is_crash": { + "description": "Error is a crash.", + "example": false, + "type": "boolean" + }, + "languages": { + "description": "Array of programming languages associated with the issue.", + "example": [ + "PYTHON", + "GO" + ], + "items": { + "description": "Programming language associated with the issue.", + "enum": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ], + "example": "PYTHON", + "type": "string", + "x-enum-varnames": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ] + }, + "type": "array" + }, + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" + }, + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ] + }, + "service": { + "description": "Service name.", + "example": "email-api-py", + "type": "string" + }, + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "type": "object" + }, + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "relationships": { + "description": "Relationship between the issue and an assignee, case and/or teams.", + "properties": { + "assignee": { + "description": "Relationship between the issue and assignee.", + "properties": { + "data": { + "description": "The user the issue is assigned to.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "case": { + "description": "Relationship between the issue and case.", + "properties": { + "data": { + "description": "The case the issue is attached to.", + "properties": { + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "included": { + "description": "Array of resources related to the issue.", + "items": { + "description": "An array of related resources, returned when the `include` query parameter is used.", + "oneOf": [ + { + "description": "The case attached to the issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a case.", + "properties": { + "archived_at": { + "description": "Timestamp of when the case was archived.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "closed_at": { + "description": "Timestamp of when the case was closed.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "created_at": { + "description": "Timestamp of when the case was created.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "creation_source": { + "description": "Source of the case creation.", + "example": "ERROR_TRACKING", + "type": "string" + }, + "description": { + "description": "Description of the case.", + "type": "string" + }, + "due_date": { + "description": "Due date of the case.", + "example": "2025-01-01", + "type": "string" + }, + "insights": { + "description": "Insights of the case.", + "items": { + "description": "Insight of the case.", + "properties": { + "ref": { + "description": "Reference of the insight.", + "example": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "resource_id": { + "description": "Insight identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the insight.", + "example": "ERROR_TRACKING", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "jira_issue": { + "description": "Jira issue of the case.", + "properties": { + "result": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", + "properties": { + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", + "type": "string" + }, + "project_key": { + "description": "Jira project key.", + "example": "ET", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Creation status of the Jira issue.", + "example": "COMPLETED", + "type": "string" + } + }, + "type": "object" + }, + "key": { + "description": "Key of the case.", + "example": "ET-123", + "type": "string" + }, + "modified_at": { + "description": "Timestamp of when the case was last modified.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] + }, + "status": { + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ], + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] + }, + "title": { + "description": "Title of the case.", + "example": "Error: HTTP error", + "type": "string" + }, + "type": { + "description": "Type of the case.", + "example": "ERROR_TRACKING_ISSUE", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "relationships": { + "description": "Resources related to a case.", + "properties": { + "assignee": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "created_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modified_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "project": { + "description": "Relationship to project", + "properties": { + "data": { + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" + }, + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "The user to whom the issue is assigned.", + "properties": { + "attributes": { + "description": "Object containing the information of a user.", + "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "User Name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + ] + }, + "type": "array" + } + }, + "type": "object" + }, + "IssueState": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + }, + "IssueTeam": { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "IssueTeamAttributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "IssueTeamOwnersRelationship": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IssueTeamReference": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "IssueTeamType": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + }, + "IssueType": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + }, + "IssueUpdateAssigneeRequest": { + "description": "Update issue assignee request payload.", + "properties": { + "data": { + "description": "Update issue assignee request.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "assignee" + ], + "example": "assignee", + "type": "string", + "x-enum-varnames": [ + "ASSIGNEE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IssueUpdateAssigneeRequestData": { + "description": "Update issue assignee request.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "assignee" + ], + "example": "assignee", + "type": "string", + "x-enum-varnames": [ + "ASSIGNEE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "IssueUpdateAssigneeRequestDataType": { + "description": "Type of the object.", + "enum": [ + "assignee" + ], + "example": "assignee", + "type": "string", + "x-enum-varnames": [ + "ASSIGNEE" + ] + }, + "IssueUpdateStateRequest": { + "description": "Update issue state request payload.", + "properties": { + "data": { + "description": "Update issue state request.", + "properties": { + "attributes": { + "description": "Object describing an issue state update request.", + "properties": { + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "required": [ + "state" + ], + "type": "object" + }, + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "error_tracking_issue" + ], + "example": "error_tracking_issue", + "type": "string", + "x-enum-varnames": [ + "ERROR_TRACKING_ISSUE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IssueUpdateStateRequestData": { + "description": "Update issue state request.", + "properties": { + "attributes": { + "description": "Object describing an issue state update request.", + "properties": { + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "required": [ + "state" + ], + "type": "object" + }, + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "error_tracking_issue" + ], + "example": "error_tracking_issue", + "type": "string", + "x-enum-varnames": [ + "ERROR_TRACKING_ISSUE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "IssueUpdateStateRequestDataAttributes": { + "description": "Object describing an issue state update request.", + "properties": { + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "required": [ + "state" + ], + "type": "object" + }, + "IssueUpdateStateRequestDataType": { + "description": "Type of the object.", + "enum": [ + "error_tracking_issue" + ], + "example": "error_tracking_issue", + "type": "string", + "x-enum-varnames": [ + "ERROR_TRACKING_ISSUE" + ] + }, + "IssueUser": { + "description": "The user to whom the issue is assigned.", + "properties": { + "attributes": { + "description": "Object containing the information of a user.", + "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "User Name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "IssueUserAttributes": { + "description": "Object containing the information of a user.", + "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "User Name", + "type": "string" + } + }, + "type": "object" + }, + "IssueUserReference": { + "description": "The user the issue is assigned to.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "IssueUserType": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + }, + "IssuesSearchRequest": { + "description": "Search issues request payload.", + "properties": { + "data": { + "description": "Search issues request.", + "properties": { + "attributes": { + "description": "Object describing a search issue request.", + "properties": { + "from": { + "description": "Start date (inclusive) of the query in milliseconds since the Unix epoch.", + "example": 1671612804000, + "format": "int64", + "type": "integer" + }, + "order_by": { + "description": "The attribute to sort the search results by.", + "enum": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ], + "example": "IMPACTED_SESSIONS", + "type": "string", + "x-enum-varnames": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ] + }, + "persona": { + "description": "Persona for the search. Either track(s) or persona(s) must be specified.", + "enum": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ] + }, + "query": { + "description": "Search query following the event search syntax.", + "example": "service:orders-* AND @language:go", + "type": "string" + }, + "to": { + "description": "End date (exclusive) of the query in milliseconds since the Unix epoch.", + "example": 1671620004000, + "format": "int64", + "type": "integer" + }, + "track": { + "description": "Track of the events to query. Either track(s) or persona(s) must be specified.", + "enum": [ + "trace", + "logs", + "rum" + ], + "example": "trace", + "type": "string", + "x-enum-varnames": [ + "TRACE", + "LOGS", + "RUM" + ] + } + }, + "required": [ + "query", + "from", + "to" + ], + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "search_request" + ], + "example": "search_request", + "type": "string", + "x-enum-varnames": [ + "SEARCH_REQUEST" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IssuesSearchRequestData": { + "description": "Search issues request.", + "properties": { + "attributes": { + "description": "Object describing a search issue request.", + "properties": { + "from": { + "description": "Start date (inclusive) of the query in milliseconds since the Unix epoch.", + "example": 1671612804000, + "format": "int64", + "type": "integer" + }, + "order_by": { + "description": "The attribute to sort the search results by.", + "enum": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ], + "example": "IMPACTED_SESSIONS", + "type": "string", + "x-enum-varnames": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ] + }, + "persona": { + "description": "Persona for the search. Either track(s) or persona(s) must be specified.", + "enum": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ] + }, + "query": { + "description": "Search query following the event search syntax.", + "example": "service:orders-* AND @language:go", + "type": "string" + }, + "to": { + "description": "End date (exclusive) of the query in milliseconds since the Unix epoch.", + "example": 1671620004000, + "format": "int64", + "type": "integer" + }, + "track": { + "description": "Track of the events to query. Either track(s) or persona(s) must be specified.", + "enum": [ + "trace", + "logs", + "rum" + ], + "example": "trace", + "type": "string", + "x-enum-varnames": [ + "TRACE", + "LOGS", + "RUM" + ] + } + }, + "required": [ + "query", + "from", + "to" + ], + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "search_request" + ], + "example": "search_request", + "type": "string", + "x-enum-varnames": [ + "SEARCH_REQUEST" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + }, + "IssuesSearchRequestDataAttributes": { + "description": "Object describing a search issue request.", + "properties": { + "from": { + "description": "Start date (inclusive) of the query in milliseconds since the Unix epoch.", + "example": 1671612804000, + "format": "int64", + "type": "integer" + }, + "order_by": { + "description": "The attribute to sort the search results by.", + "enum": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ], + "example": "IMPACTED_SESSIONS", + "type": "string", + "x-enum-varnames": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ] + }, + "persona": { + "description": "Persona for the search. Either track(s) or persona(s) must be specified.", + "enum": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ] + }, + "query": { + "description": "Search query following the event search syntax.", + "example": "service:orders-* AND @language:go", + "type": "string" + }, + "to": { + "description": "End date (exclusive) of the query in milliseconds since the Unix epoch.", + "example": 1671620004000, + "format": "int64", + "type": "integer" + }, + "track": { + "description": "Track of the events to query. Either track(s) or persona(s) must be specified.", + "enum": [ + "trace", + "logs", + "rum" + ], + "example": "trace", + "type": "string", + "x-enum-varnames": [ + "TRACE", + "LOGS", + "RUM" + ] + } + }, + "required": [ + "query", + "from", + "to" + ], + "type": "object" + }, + "IssuesSearchRequestDataAttributesOrderBy": { + "description": "The attribute to sort the search results by.", + "enum": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ], + "example": "IMPACTED_SESSIONS", + "type": "string", + "x-enum-varnames": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ] + }, + "IssuesSearchRequestDataAttributesPersona": { + "description": "Persona for the search. Either track(s) or persona(s) must be specified.", + "enum": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ] + }, + "IssuesSearchRequestDataAttributesTrack": { + "description": "Track of the events to query. Either track(s) or persona(s) must be specified.", + "enum": [ + "trace", + "logs", + "rum" + ], + "example": "trace", + "type": "string", + "x-enum-varnames": [ + "TRACE", + "LOGS", + "RUM" + ] + }, + "IssuesSearchRequestDataType": { + "description": "Type of the object.", + "enum": [ + "search_request" + ], + "example": "search_request", + "type": "string", + "x-enum-varnames": [ + "SEARCH_REQUEST" + ] + }, + "IssuesSearchResponse": { + "description": "Search issues response payload.", + "properties": { + "data": { + "description": "Array of results matching the search query.", + "items": { + "description": "Result matching the search query.", + "properties": { + "attributes": { + "description": "Object containing the information of a search result.", + "properties": { + "impacted_sessions": { + "description": "Count of sessions impacted by the issue over the queried time window.", + "example": 12, + "format": "int64", + "type": "integer" + }, + "impacted_users": { + "description": "Count of users impacted by the issue over the queried time window.", + "example": 4, + "format": "int64", + "type": "integer" + }, + "total_count": { + "description": "Total count of errors that match the issue over the queried time window.", + "example": 82, + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "Search result identifier (matches the nested issue's identifier).", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "relationships": { + "description": "Relationships between the search result and other resources.", + "properties": { + "issue": { + "description": "Relationship between the search result and the corresponding issue.", + "properties": { + "data": { + "description": "The issue the search result corresponds to.", + "properties": { + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "error_tracking_search_result" + ], + "example": "error_tracking_search_result", + "type": "string", + "x-enum-varnames": [ + "ERROR_TRACKING_SEARCH_RESULT" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Array of resources related to the search results.", + "items": { + "description": "An array of related resources, returned when the `include` query parameter is used.", + "oneOf": [ + { + "description": "The issue matching the request.", + "properties": { + "attributes": { + "description": "Object containing the information of an issue.", + "properties": { + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", + "type": "string" + }, + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", + "type": "string" + }, + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", + "type": "string" + }, + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" + }, + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", + "type": "string" + }, + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" + }, + "is_crash": { + "description": "Error is a crash.", + "example": false, + "type": "boolean" + }, + "languages": { + "description": "Array of programming languages associated with the issue.", + "example": [ + "PYTHON", + "GO" + ], + "items": { + "description": "Programming language associated with the issue.", + "enum": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ], + "example": "PYTHON", + "type": "string", + "x-enum-varnames": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ] + }, + "type": "array" + }, + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" + }, + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ] + }, + "service": { + "description": "Service name.", + "example": "email-api-py", + "type": "string" + }, + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "type": "object" + }, + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "relationships": { + "description": "Relationship between the issue and an assignee, case and/or teams.", + "properties": { + "assignee": { + "description": "Relationship between the issue and assignee.", + "properties": { + "data": { + "description": "The user the issue is assigned to.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "case": { + "description": "Relationship between the issue and case.", + "properties": { + "data": { + "description": "The case the issue is attached to.", + "properties": { + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A case", + "properties": { + "attributes": { + "description": "Case resource attributes", + "properties": { + "archived_at": { + "description": "Timestamp of when the case was archived", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "attributes": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, + "description": "The definition of `CaseObjectAttributes` object.", + "type": "object" + }, + "closed_at": { + "description": "Timestamp of when the case was closed", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "created_at": { + "description": "Timestamp of when the case was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description", + "type": "string" + }, + "jira_issue": { + "description": "Jira issue attached to case", + "nullable": true, + "properties": { + "result": { + "description": "Jira issue information", + "properties": { + "issue_id": { + "description": "Jira issue ID", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL", + "type": "string" + }, + "project_key": { + "description": "Jira project key", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "default": "IN_PROGRESS", + "description": "Case status", + "enum": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ], + "example": "COMPLETED", + "readOnly": true, + "type": "string", + "x-enum-varnames": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + } + }, + "readOnly": true, + "type": "object" + }, + "key": { + "description": "Key", + "example": "CASEM-4523", + "type": "string" + }, + "modified_at": { + "description": "Timestamp of when the case was last modified", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] + }, + "service_now_ticket": { + "description": "ServiceNow ticket attached to case", + "nullable": true, + "properties": { + "result": { + "description": "ServiceNow ticket information", + "properties": { + "sys_target_link": { + "description": "Link to the Incident created on ServiceNow", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "default": "IN_PROGRESS", + "description": "Case status", + "enum": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ], + "example": "COMPLETED", + "readOnly": true, + "type": "string", + "x-enum-varnames": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + } + }, + "readOnly": true, + "type": "object" + }, + "status": { + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ], + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] + }, + "title": { + "description": "Title", + "example": "Memory leak investigation on API", + "type": "string" + }, + "type": { + "description": "Case type", + "enum": [ + "STANDARD" + ], + "example": "STANDARD", + "type": "string", + "x-enum-varnames": [ + "STANDARD" + ] + } + }, + "type": "object" + }, + "id": { + "description": "Case's identifier", + "example": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "relationships": { + "description": "Resources related to a case", + "properties": { + "assignee": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "created_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modified_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "project": { + "description": "Relationship to project", + "properties": { + "data": { + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" + }, + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "case", + "description": "Case resource type", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "The user to whom the issue is assigned.", + "properties": { + "attributes": { + "description": "Object containing the information of a user.", + "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "User Name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + ] + }, + "type": "array" + } + }, + "type": "object" + }, + "IssuesSearchResult": { + "description": "Result matching the search query.", + "properties": { + "attributes": { + "description": "Object containing the information of a search result.", + "properties": { + "impacted_sessions": { + "description": "Count of sessions impacted by the issue over the queried time window.", + "example": 12, + "format": "int64", + "type": "integer" + }, + "impacted_users": { + "description": "Count of users impacted by the issue over the queried time window.", + "example": 4, + "format": "int64", + "type": "integer" + }, + "total_count": { + "description": "Total count of errors that match the issue over the queried time window.", + "example": 82, + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "Search result identifier (matches the nested issue's identifier).", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "relationships": { + "description": "Relationships between the search result and other resources.", + "properties": { + "issue": { + "description": "Relationship between the search result and the corresponding issue.", + "properties": { + "data": { + "description": "The issue the search result corresponds to.", + "properties": { + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "error_tracking_search_result" + ], + "example": "error_tracking_search_result", + "type": "string", + "x-enum-varnames": [ + "ERROR_TRACKING_SEARCH_RESULT" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "IssuesSearchResultAttributes": { + "description": "Object containing the information of a search result.", + "properties": { + "impacted_sessions": { + "description": "Count of sessions impacted by the issue over the queried time window.", + "example": 12, + "format": "int64", + "type": "integer" + }, + "impacted_users": { + "description": "Count of users impacted by the issue over the queried time window.", + "example": 4, + "format": "int64", + "type": "integer" + }, + "total_count": { + "description": "Total count of errors that match the issue over the queried time window.", + "example": 82, + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "IssuesSearchResultIncluded": { + "description": "An array of related resources, returned when the `include` query parameter is used.", + "oneOf": [ + { + "description": "The issue matching the request.", + "properties": { + "attributes": { + "description": "Object containing the information of an issue.", + "properties": { + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", + "type": "string" + }, + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", + "type": "string" + }, + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", + "type": "string" + }, + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" + }, + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", + "type": "string" + }, + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" + }, + "is_crash": { + "description": "Error is a crash.", + "example": false, + "type": "boolean" + }, + "languages": { + "description": "Array of programming languages associated with the issue.", + "example": [ + "PYTHON", + "GO" + ], + "items": { + "description": "Programming language associated with the issue.", + "enum": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ], + "example": "PYTHON", + "type": "string", + "x-enum-varnames": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ] + }, + "type": "array" + }, + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" + }, + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ] + }, + "service": { + "description": "Service name.", + "example": "email-api-py", + "type": "string" + }, + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "type": "object" + }, + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "relationships": { + "description": "Relationship between the issue and an assignee, case and/or teams.", + "properties": { + "assignee": { + "description": "Relationship between the issue and assignee.", + "properties": { + "data": { + "description": "The user the issue is assigned to.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "case": { + "description": "Relationship between the issue and case.", + "properties": { + "data": { + "description": "The case the issue is attached to.", + "properties": { + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A case", + "properties": { + "attributes": { + "description": "Case resource attributes", + "properties": { + "archived_at": { + "description": "Timestamp of when the case was archived", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "attributes": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, + "description": "The definition of `CaseObjectAttributes` object.", + "type": "object" + }, + "closed_at": { + "description": "Timestamp of when the case was closed", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "created_at": { + "description": "Timestamp of when the case was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description", + "type": "string" + }, + "jira_issue": { + "description": "Jira issue attached to case", + "nullable": true, + "properties": { + "result": { + "description": "Jira issue information", + "properties": { + "issue_id": { + "description": "Jira issue ID", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL", + "type": "string" + }, + "project_key": { + "description": "Jira project key", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "default": "IN_PROGRESS", + "description": "Case status", + "enum": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ], + "example": "COMPLETED", + "readOnly": true, + "type": "string", + "x-enum-varnames": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + } + }, + "readOnly": true, + "type": "object" + }, + "key": { + "description": "Key", + "example": "CASEM-4523", + "type": "string" + }, + "modified_at": { + "description": "Timestamp of when the case was last modified", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] + }, + "service_now_ticket": { + "description": "ServiceNow ticket attached to case", + "nullable": true, + "properties": { + "result": { + "description": "ServiceNow ticket information", + "properties": { + "sys_target_link": { + "description": "Link to the Incident created on ServiceNow", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "default": "IN_PROGRESS", + "description": "Case status", + "enum": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ], + "example": "COMPLETED", + "readOnly": true, + "type": "string", + "x-enum-varnames": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + } + }, + "readOnly": true, + "type": "object" + }, + "status": { + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ], + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] + }, + "title": { + "description": "Title", + "example": "Memory leak investigation on API", + "type": "string" + }, + "type": { + "description": "Case type", + "enum": [ + "STANDARD" + ], + "example": "STANDARD", + "type": "string", + "x-enum-varnames": [ + "STANDARD" + ] + } + }, + "type": "object" + }, + "id": { + "description": "Case's identifier", + "example": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "relationships": { + "description": "Resources related to a case", + "properties": { + "assignee": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "created_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modified_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "project": { + "description": "Relationship to project", + "properties": { + "data": { + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" + }, + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "case", + "description": "Case resource type", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "The user to whom the issue is assigned.", + "properties": { + "attributes": { + "description": "Object containing the information of a user.", + "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "User Name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + ] + }, + "IssuesSearchResultIssueRelationship": { + "description": "Relationship between the search result and the corresponding issue.", + "properties": { + "data": { + "description": "The issue the search result corresponds to.", + "properties": { + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IssuesSearchResultRelationships": { + "description": "Relationships between the search result and other resources.", + "properties": { + "issue": { + "description": "Relationship between the search result and the corresponding issue.", + "properties": { + "data": { + "description": "The issue the search result corresponds to.", + "properties": { + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "IssuesSearchResultType": { + "description": "Type of the object.", + "enum": [ + "error_tracking_search_result" + ], + "example": "error_tracking_search_result", + "type": "string", + "x-enum-varnames": [ + "ERROR_TRACKING_SEARCH_RESULT" + ] + }, + "JSONAPIErrorItem": { + "description": "API error response body", + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the error.", + "example": "Missing required attribute in body", + "type": "string" + }, + "meta": { + "additionalProperties": {}, + "description": "Non-standard meta-information about the error", + "type": "object" + }, + "source": { + "description": "References to the source of the error.", + "properties": { + "header": { + "description": "A string indicating the name of a single request header which caused the error.", + "example": "Authorization", + "type": "string" + }, + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "limit", + "type": "string" + }, + "pointer": { + "description": "A JSON pointer to the value in the request document that caused the error.", + "example": "/data/attributes/title", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Status code of the response.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short human-readable summary of the error.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "JSONAPIErrorItemSource": { + "description": "References to the source of the error.", + "properties": { + "header": { + "description": "A string indicating the name of a single request header which caused the error.", + "example": "Authorization", + "type": "string" + }, + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "limit", + "type": "string" + }, + "pointer": { + "description": "A JSON pointer to the value in the request document that caused the error.", + "example": "/data/attributes/title", + "type": "string" + } + }, + "type": "object" + }, + "JSONAPIErrorResponse": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "items": { + "description": "API error response body", + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the error.", + "example": "Missing required attribute in body", + "type": "string" + }, + "meta": { + "additionalProperties": {}, + "description": "Non-standard meta-information about the error", + "type": "object" + }, + "source": { + "description": "References to the source of the error.", + "properties": { + "header": { + "description": "A string indicating the name of a single request header which caused the error.", + "example": "Authorization", + "type": "string" + }, + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "limit", + "type": "string" + }, + "pointer": { + "description": "A JSON pointer to the value in the request document that caused the error.", + "example": "/data/attributes/title", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Status code of the response.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short human-readable summary of the error.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + }, + "JiraIntegrationMetadata": { + "description": "Incident integration metadata for the Jira integration.", + "properties": { + "issues": { + "description": "Array of Jira issues in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Jira integration metadata issue array.", + "properties": { + "account": { + "description": "URL of issue's Jira account.", + "example": "https://example.atlassian.net", + "type": "string" + }, + "issue_key": { + "description": "Jira issue's issue key.", + "example": "PROJ-123", + "type": "string" + }, + "issuetype_id": { + "description": "Jira issue's issue type.", + "example": "1000", + "type": "string" + }, + "project_key": { + "description": "Jira issue's project keys.", + "example": "PROJ", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Jira issue.", + "example": "https://example.atlassian.net/browse/PROJ-123", + "type": "string" + } + }, + "required": [ + "project_key", + "account" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "issues" + ], + "type": "object" + }, + "JiraIntegrationMetadataIssuesItem": { + "description": "Item in the Jira integration metadata issue array.", + "properties": { + "account": { + "description": "URL of issue's Jira account.", + "example": "https://example.atlassian.net", + "type": "string" + }, + "issue_key": { + "description": "Jira issue's issue key.", + "example": "PROJ-123", + "type": "string" + }, + "issuetype_id": { + "description": "Jira issue's issue type.", + "example": "1000", + "type": "string" + }, + "project_key": { + "description": "Jira issue's project keys.", + "example": "PROJ", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Jira issue.", + "example": "https://example.atlassian.net/browse/PROJ-123", + "type": "string" + } + }, + "required": [ + "project_key", + "account" + ], + "type": "object" + }, + "JiraIssue": { + "description": "Jira issue attached to case", + "nullable": true, + "properties": { + "result": { + "description": "Jira issue information", + "properties": { + "issue_id": { + "description": "Jira issue ID", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL", + "type": "string" + }, + "project_key": { + "description": "Jira project key", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "default": "IN_PROGRESS", + "description": "Case status", + "enum": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ], + "example": "COMPLETED", + "readOnly": true, + "type": "string", + "x-enum-varnames": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + } + }, + "readOnly": true, + "type": "object" + }, + "JiraIssueResult": { + "description": "Jira issue information", + "properties": { + "issue_id": { + "description": "Jira issue ID", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL", + "type": "string" + }, + "project_key": { + "description": "Jira project key", + "type": "string" + } + }, + "type": "object" + }, + "JobCreateResponse": { + "description": "Run a historical job response.", + "properties": { + "data": { + "description": "The definition of `JobCreateResponseData` object.", + "properties": { + "id": { + "description": "ID of the created job.", + "type": "string" + }, + "type": { + "description": "Type of payload.", + "enum": [ + "historicalDetectionsJob" + ], + "type": "string", + "x-enum-varnames": [ + "HISTORICALDETECTIONSJOB" + ] + } + }, + "type": "object" + } + }, + "type": "object" + }, + "JobCreateResponseData": { + "description": "The definition of `JobCreateResponseData` object.", + "properties": { + "id": { + "description": "ID of the created job.", + "type": "string" + }, + "type": { + "description": "Type of payload.", + "enum": [ + "historicalDetectionsJob" + ], + "type": "string", + "x-enum-varnames": [ + "HISTORICALDETECTIONSJOB" + ] + } + }, + "type": "object" + }, + "JobDefinition": { + "description": "Definition of a historical job.", + "properties": { + "calculatedFields": { + "description": "Calculated fields.", + "items": { + "description": "Calculated field.", + "properties": { + "expression": { + "description": "Expression.", + "example": "@request_end_timestamp - @request_start_timestamp", + "type": "string" + }, + "name": { + "description": "Field name.", + "example": "response_time", + "type": "string" + } + }, + "required": [ + "name", + "expression" + ], + "type": "object" + }, + "type": "array" + }, + "cases": { + "description": "Cases used for generating job results.", + "items": { + "description": "Case when signal is generated.", + "properties": { + "actions": { + "description": "Action to perform for each rule case.", + "items": { + "description": "Action to perform when a signal is triggered. Only available for Application Security rule type.", + "properties": { + "options": { + "additionalProperties": {}, + "description": "Options for the rule action", + "properties": { + "duration": { + "description": "Duration of the action in seconds. 0 indicates no expiration.", + "example": 0, + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "flaggedIPType": { + "description": "Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses.", + "enum": [ + "SUSPICIOUS", + "FLAGGED" + ], + "example": "FLAGGED", + "type": "string", + "x-enum-varnames": [ + "SUSPICIOUS", + "FLAGGED" + ] + }, + "userBehaviorName": { + "description": "Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "description": "The action type.", + "enum": [ + "block_ip", + "block_user", + "user_behavior", + "flag_ip" + ], + "type": "string", + "x-enum-varnames": [ + "BLOCK_IP", + "BLOCK_USER", + "USER_BEHAVIOR", + "FLAG_IP" + ] + } + }, + "type": "object" + }, + "type": "array" + }, + "condition": { + "description": "A case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.", + "type": "string" + }, + "name": { + "description": "Name of the case.", + "type": "string" + }, + "notifications": { + "description": "Notification targets.", + "items": { + "description": "Notification.", + "type": "string" + }, + "type": "array" + }, + "status": { + "description": "Severity of the Security Signal.", + "enum": [ + "info", + "low", + "medium", + "high", + "critical" + ], + "example": "critical", + "type": "string", + "x-enum-varnames": [ + "INFO", + "LOW", + "MEDIUM", + "HIGH", + "CRITICAL" + ] + } + }, + "required": [ + "status" + ], + "type": "object" + }, + "type": "array" + }, + "from": { + "description": "Starting time of data analyzed by the job.", + "example": 1729843470000, + "format": "int64", + "type": "integer" + }, + "groupSignalsBy": { + "description": "Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.", + "example": [ + "service" + ], + "items": { + "description": "Field to group by.", + "type": "string" + }, + "type": "array" + }, + "index": { + "description": "Index used to load the data.", + "example": "cloud_siem", + "type": "string" + }, + "message": { + "description": "Message for generated results.", + "example": "A large number of failed login attempts.", + "type": "string" + }, + "name": { + "description": "Job name.", + "example": "Excessive number of failed attempts.", + "type": "string" + }, + "options": { + "description": "Job options.", + "properties": { + "detectionMethod": { + "description": "The detection method.", + "enum": [ + "threshold", + "new_value", + "anomaly_detection", + "impossible_travel", + "hardcoded", + "third_party", + "anomaly_threshold" + ], + "type": "string", + "x-enum-varnames": [ + "THRESHOLD", + "NEW_VALUE", + "ANOMALY_DETECTION", + "IMPOSSIBLE_TRAVEL", + "HARDCODED", + "THIRD_PARTY", + "ANOMALY_THRESHOLD" + ] + }, + "evaluationWindow": { + "description": "A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used.", + "enum": [ + 0, + 60, + 300, + 600, + 900, + 1800, + 3600, + 7200, + 10800, + 21600, + 43200, + 86400 + ], + "format": "int32", + "type": "integer", + "x-enum-varnames": [ + "ZERO_MINUTES", + "ONE_MINUTE", + "FIVE_MINUTES", + "TEN_MINUTES", + "FIFTEEN_MINUTES", + "THIRTY_MINUTES", + "ONE_HOUR", + "TWO_HOURS", + "THREE_HOURS", + "SIX_HOURS", + "TWELVE_HOURS", + "ONE_DAY" + ] + }, + "impossibleTravelOptions": { + "description": "Options on impossible travel detection method.", + "properties": { + "baselineUserLocations": { + "description": "If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "keepAlive": { + "description": "Once a signal is generated, the signal will remain \"open\" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used.", + "enum": [ + 0, + 60, + 300, + 600, + 900, + 1800, + 3600, + 7200, + 10800, + 21600, + 43200, + 86400 + ], + "format": "int32", + "type": "integer", + "x-enum-varnames": [ + "ZERO_MINUTES", + "ONE_MINUTE", + "FIVE_MINUTES", + "TEN_MINUTES", + "FIFTEEN_MINUTES", + "THIRTY_MINUTES", + "ONE_HOUR", + "TWO_HOURS", + "THREE_HOURS", + "SIX_HOURS", + "TWELVE_HOURS", + "ONE_DAY" + ] + }, + "maxSignalDuration": { + "description": "A signal will \"close\" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp.", + "enum": [ + 0, + 60, + 300, + 600, + 900, + 1800, + 3600, + 7200, + 10800, + 21600, + 43200, + 86400 + ], + "format": "int32", + "type": "integer", + "x-enum-varnames": [ + "ZERO_MINUTES", + "ONE_MINUTE", + "FIVE_MINUTES", + "TEN_MINUTES", + "FIFTEEN_MINUTES", + "THIRTY_MINUTES", + "ONE_HOUR", + "TWO_HOURS", + "THREE_HOURS", + "SIX_HOURS", + "TWELVE_HOURS", + "ONE_DAY" + ] + }, + "newValueOptions": { + "description": "Options on new value detection method.", + "properties": { + "forgetAfter": { + "description": "The duration in days after which a learned value is forgotten.", + "enum": [ + 1, + 2, + 7, + 14, + 21, + 28 + ], + "format": "int32", + "type": "integer", + "x-enum-varnames": [ + "ONE_DAY", + "TWO_DAYS", + "ONE_WEEK", + "TWO_WEEKS", + "THREE_WEEKS", + "FOUR_WEEKS" + ] + }, + "learningDuration": { + "default": 0, + "description": "The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned.", + "enum": [ + 0, + 1, + 7 + ], + "format": "int32", + "type": "integer", + "x-enum-varnames": [ + "ZERO_DAYS", + "ONE_DAY", + "SEVEN_DAYS" + ] + }, + "learningMethod": { + "default": "duration", + "description": "The learning method used to determine when signals should be generated for values that weren't learned.", + "enum": [ + "duration", + "threshold" + ], + "type": "string", + "x-enum-varnames": [ + "DURATION", + "THRESHOLD" + ] + }, + "learningThreshold": { + "default": 0, + "description": "A number of occurrences after which signals will be generated for values that weren't learned.", + "enum": [ + 0, + 1 + ], + "format": "int32", + "type": "integer", + "x-enum-varnames": [ + "ZERO_OCCURRENCES", + "ONE_OCCURRENCE" + ] + } + }, + "type": "object" + }, + "thirdPartyRuleOptions": { + "description": "Options on third party detection method.", + "properties": { + "defaultNotifications": { + "description": "Notification targets for the logs that do not correspond to any of the cases.", + "items": { + "description": "Notification.", + "type": "string" + }, + "type": "array" + }, + "defaultStatus": { + "description": "Severity of the Security Signal.", + "enum": [ + "info", + "low", + "medium", + "high", + "critical" + ], + "example": "critical", + "type": "string", + "x-enum-varnames": [ + "INFO", + "LOW", + "MEDIUM", + "HIGH", + "CRITICAL" + ] + }, + "rootQueries": { + "description": "Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.", + "items": { + "description": "A query to be combined with the third party case query.", + "properties": { + "groupByFields": { + "description": "Fields to group by.", + "items": { + "description": "Field.", + "type": "string" + }, + "type": "array" + }, + "query": { + "description": "Query to run on logs.", + "example": "source:cloudtrail", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "signalTitleTemplate": { + "description": "A template for the signal title; if omitted, the title is generated based on the case name.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "queries": { + "description": "Queries for selecting logs analyzed by the job.", + "items": { + "description": "Query for selecting logs analyzed by the historical job.", + "properties": { + "aggregation": { + "description": "The aggregation type.", + "enum": [ + "count", + "cardinality", + "sum", + "max", + "new_value", + "geo_data", + "event_count", + "none" + ], + "type": "string", + "x-enum-varnames": [ + "COUNT", + "CARDINALITY", + "SUM", + "MAX", + "NEW_VALUE", + "GEO_DATA", + "EVENT_COUNT", + "NONE" + ] + }, + "dataSource": { + "default": "logs", + "description": "Source of events, either logs, audit trail, or Datadog events.", + "enum": [ + "logs", + "audit", + "app_sec_spans", + "spans", + "security_runtime", + "network", + "events" + ], + "example": "logs", + "type": "string", + "x-enum-varnames": [ + "LOGS", + "AUDIT", + "APP_SEC_SPANS", + "SPANS", + "SECURITY_RUNTIME", + "NETWORK", + "EVENTS" + ] + }, + "distinctFields": { + "description": "Field for which the cardinality is measured. Sent as an array.", + "items": { + "description": "Field.", + "type": "string" + }, + "type": "array" + }, + "groupByFields": { + "description": "Fields to group by.", + "items": { + "description": "Field.", + "type": "string" + }, + "type": "array" + }, + "hasOptionalGroupByFields": { + "description": "When false, events without a group-by value are ignored by the query. When true, events with missing group-by fields are processed with `N/A`, replacing the missing values.", + "example": false, + "readOnly": true, + "type": "boolean" + }, + "metrics": { + "description": "Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.", + "items": { + "description": "Field.", + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name of the query.", + "type": "string" + }, + "query": { + "description": "Query to run on logs.", + "example": "a > 3", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "referenceTables": { + "description": "Reference tables used in the queries.", + "items": { + "description": "Reference tables used in the queries.", + "properties": { + "checkPresence": { + "description": "Whether to include or exclude the matched values.", + "type": "boolean" + }, + "columnName": { + "description": "The name of the column in the reference table.", + "type": "string" + }, + "logFieldPath": { + "description": "The field in the log to match against the reference table.", + "type": "string" + }, + "ruleQueryName": { + "description": "The name of the query to apply the reference table to.", + "type": "string" + }, + "tableName": { + "description": "The name of the reference table.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tags": { + "description": "Tags for generated signals.", + "items": { + "type": "string" + }, + "type": "array" + }, + "thirdPartyCases": { + "description": "Cases for generating results from third-party detection method. Only available for third-party detection method.", + "example": [], + "items": { + "description": "Case when a signal is generated by a third party rule.", + "properties": { + "name": { + "description": "Name of the case.", + "type": "string" + }, + "notifications": { + "description": "Notification targets for each case.", + "items": { + "description": "Notification.", + "type": "string" + }, + "type": "array" + }, + "query": { + "description": "A query to map a third party event to this case.", + "type": "string" + }, + "status": { + "description": "Severity of the Security Signal.", + "enum": [ + "info", + "low", + "medium", + "high", + "critical" + ], + "example": "critical", + "type": "string", + "x-enum-varnames": [ + "INFO", + "LOW", + "MEDIUM", + "HIGH", + "CRITICAL" + ] + } + }, + "required": [ + "status" + ], + "type": "object" + }, + "type": "array" + }, + "to": { + "description": "Ending time of data analyzed by the job.", + "example": 1729847070000, + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Job type.", + "type": "string" + } + }, + "required": [ + "from", + "to", + "index", + "name", + "cases", + "queries", + "message" + ], + "type": "object" + }, + "JobDefinitionFromRule": { + "description": "Definition of a historical job based on a security monitoring rule.", + "properties": { + "from": { + "description": "Starting time of data analyzed by the job.", + "example": 1729843470000, + "format": "int64", + "type": "integer" + }, + "id": { + "description": "ID of the detection rule used to create the job.", + "example": "abc-def-ghi", + "type": "string" + }, + "index": { + "description": "Index used to load the data.", + "example": "cloud_siem", + "type": "string" + }, + "notifications": { + "description": "Notifications sent when the job is completed.", + "example": [ + "@sns-cloudtrail-results" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "to": { + "description": "Ending time of data analyzed by the job.", + "example": 1729847070000, + "format": "int64", + "type": "integer" + } + }, + "required": [ + "id", + "from", + "to", + "index" + ], + "type": "object" + }, + "KindAttributes": { + "description": "Kind attributes.", + "properties": { + "description": { + "description": "Short description of the kind.", + "type": "string" + }, + "displayName": { + "description": "User friendly name of the kind.", + "type": "string" + }, + "name": { + "description": "The kind name.", + "example": "my-job", + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "KindData": { + "description": "Schema that defines the structure of a Kind object in the Software Catalog.", + "properties": { + "attributes": { + "description": "Kind attributes.", + "properties": { + "description": { + "description": "Short description of the kind.", + "type": "string" + }, + "displayName": { + "description": "User friendly name of the kind.", + "type": "string" + }, + "name": { + "description": "The kind name.", + "example": "my-job", + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.", + "example": "4b163705-23c0-4573-b2fb-f6cea2163fcb", + "minLength": 1, + "type": "string" + }, + "meta": { + "description": "Kind metadata.", + "properties": { + "createdAt": { + "description": "The creation time.", + "type": "string" + }, + "modifiedAt": { + "description": "The modification time.", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "description": "Kind.", + "type": "string" + } + }, + "type": "object" + }, + "KindMetadata": { + "description": "Kind metadata.", + "properties": { + "createdAt": { + "description": "The creation time.", + "type": "string" + }, + "modifiedAt": { + "description": "The modification time.", + "type": "string" + } + }, + "type": "object" + }, + "KindObj": { + "description": "Schema for kind.", + "properties": { + "description": { + "description": "Short description of the kind.", + "type": "string" + }, + "displayName": { + "description": "The display name of the kind. Automatically generated if not provided.", + "type": "string" + }, + "kind": { + "description": "The name of the kind to create or update. This must be in kebab-case format.", + "example": "my-job", + "type": "string" + } + }, + "required": [ + "kind" + ], + "type": "object" + }, + "KindRaw": { + "description": "Kind definition in raw JSON or YAML representation.", + "example": "kind: service\ndisplayName: Service\ndescription: A service entity in the catalog.\n", + "type": "string" + }, + "KindResponseData": { + "description": "List of kind responses.", + "items": { + "description": "Schema that defines the structure of a Kind object in the Software Catalog.", + "properties": { + "attributes": { + "description": "Kind attributes.", + "properties": { + "description": { + "description": "Short description of the kind.", + "type": "string" + }, + "displayName": { + "description": "User friendly name of the kind.", + "type": "string" + }, + "name": { + "description": "The kind name.", + "example": "my-job", + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.", + "example": "4b163705-23c0-4573-b2fb-f6cea2163fcb", + "minLength": 1, + "type": "string" + }, + "meta": { + "description": "Kind metadata.", + "properties": { + "createdAt": { + "description": "The creation time.", + "type": "string" + }, + "modifiedAt": { + "description": "The modification time.", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "description": "Kind.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "KindResponseMeta": { + "description": "Kind response metadata.", + "properties": { + "count": { + "description": "Total kinds count.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "LaunchDarklyAPIKey": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "properties": { + "api_token": { + "description": "The `LaunchDarklyAPIKey` `api_token`.", + "example": "", + "type": "string" + }, + "type": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "enum": [ + "LaunchDarklyAPIKey" + ], + "example": "LaunchDarklyAPIKey", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLYAPIKEY" + ] + } + }, + "required": [ + "type", + "api_token" + ], + "type": "object" + }, + "LaunchDarklyAPIKeyType": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "enum": [ + "LaunchDarklyAPIKey" + ], + "example": "LaunchDarklyAPIKey", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLYAPIKEY" + ] + }, + "LaunchDarklyAPIKeyUpdate": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "properties": { + "api_token": { + "description": "The `LaunchDarklyAPIKeyUpdate` `api_token`.", + "type": "string" + }, + "type": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "enum": [ + "LaunchDarklyAPIKey" + ], + "example": "LaunchDarklyAPIKey", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLYAPIKEY" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "LaunchDarklyCredentials": { + "description": "The definition of the `LaunchDarklyCredentials` object.", + "oneOf": [ + { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "properties": { + "api_token": { + "description": "The `LaunchDarklyAPIKey` `api_token`.", + "example": "", + "type": "string" + }, + "type": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "enum": [ + "LaunchDarklyAPIKey" + ], + "example": "LaunchDarklyAPIKey", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLYAPIKEY" + ] + } + }, + "required": [ + "type", + "api_token" + ], + "type": "object" + } + ] + }, + "LaunchDarklyCredentialsUpdate": { + "description": "The definition of the `LaunchDarklyCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "properties": { + "api_token": { + "description": "The `LaunchDarklyAPIKeyUpdate` `api_token`.", + "type": "string" + }, + "type": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "enum": [ + "LaunchDarklyAPIKey" + ], + "example": "LaunchDarklyAPIKey", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLYAPIKEY" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "LaunchDarklyIntegration": { + "description": "The definition of the `LaunchDarklyIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of the `LaunchDarklyCredentials` object.", + "oneOf": [ + { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "properties": { + "api_token": { + "description": "The `LaunchDarklyAPIKey` `api_token`.", + "example": "", + "type": "string" + }, + "type": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "enum": [ + "LaunchDarklyAPIKey" + ], + "example": "LaunchDarklyAPIKey", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLYAPIKEY" + ] + } + }, + "required": [ + "type", + "api_token" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of the `LaunchDarklyIntegrationType` object.", + "enum": [ + "LaunchDarkly" + ], + "example": "LaunchDarkly", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLY" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + "LaunchDarklyIntegrationType": { + "description": "The definition of the `LaunchDarklyIntegrationType` object.", + "enum": [ + "LaunchDarkly" + ], + "example": "LaunchDarkly", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLY" + ] + }, + "LaunchDarklyIntegrationUpdate": { + "description": "The definition of the `LaunchDarklyIntegrationUpdate` object.", + "properties": { + "credentials": { + "description": "The definition of the `LaunchDarklyCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "properties": { + "api_token": { + "description": "The `LaunchDarklyAPIKeyUpdate` `api_token`.", + "type": "string" + }, + "type": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "enum": [ + "LaunchDarklyAPIKey" + ], + "example": "LaunchDarklyAPIKey", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLYAPIKEY" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of the `LaunchDarklyIntegrationType` object.", + "enum": [ + "LaunchDarkly" + ], + "example": "LaunchDarkly", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLY" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "Layer": { + "description": "Encapsulates a layer resource, holding attributes like rotation details, plus relationships to the members covering that layer.", + "properties": { + "attributes": { + "description": "Describes key properties of a Layer, including rotation details, name, start/end times, and any restrictions.", + "properties": { + "effective_date": { + "description": "When the layer becomes active (ISO 8601).", + "format": "date-time", + "type": "string" + }, + "end_date": { + "description": "When the layer ceases to be active (ISO 8601).", + "format": "date-time", + "type": "string" + }, + "interval": { + "description": "Defines how often the rotation repeats, using a combination of days and optional seconds. Should be at least 1 hour.", + "properties": { + "days": { + "description": "The number of days in each rotation cycle.", + "example": 1, + "format": "int32", + "maximum": 400, + "type": "integer" + }, + "seconds": { + "description": "Any additional seconds for the rotation cycle (up to 30 days).", + "example": 300, + "format": "int64", + "maximum": 2592000, + "type": "integer" + } + }, + "type": "object" + }, + "name": { + "description": "The name of this layer.", + "example": "Weekend Layer", + "type": "string" + }, + "restrictions": { + "description": "An optional list of time restrictions for when this layer is in effect.", + "items": { + "description": "Defines a single time restriction rule with start and end times and the applicable weekdays.", + "properties": { + "end_day": { + "description": "A day of the week.", + "enum": [ + "monday", + "tuesday", + "wednesday", + "thursday", + "friday", + "saturday", + "sunday" + ], + "type": "string", + "x-enum-varnames": [ + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ] + }, + "end_time": { + "description": "Specifies the ending time for this restriction.", + "type": "string" + }, + "start_day": { + "description": "A day of the week.", + "enum": [ + "monday", + "tuesday", + "wednesday", + "thursday", + "friday", + "saturday", + "sunday" + ], + "type": "string", + "x-enum-varnames": [ + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ] + }, + "start_time": { + "description": "Specifies the starting time for this restriction.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "rotation_start": { + "description": "The date/time when the rotation starts (ISO 8601).", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "A unique identifier for this layer.", + "type": "string" + }, + "relationships": { + "description": "Holds references to objects related to the Layer entity, such as its members.", + "properties": { + "members": { + "description": "Holds an array of references to the members of a Layer, each containing member IDs.", + "properties": { + "data": { + "description": "The list of members who belong to this layer.", + "items": { + "description": "Represents a single member object in a layer's `members` array, referencing\na unique Datadog user ID.", + "properties": { + "id": { + "description": "The unique user ID of the layer member.", + "example": "00000000-0000-0000-0000-000000000002", + "type": "string" + }, + "type": { + "default": "members", + "description": "Members resource type.", + "enum": [ + "members" + ], + "example": "members", + "type": "string", + "x-enum-varnames": [ + "MEMBERS" + ] + } + }, + "required": [ "type", "id" ], @@ -262676,6 +268261,23 @@ "SCORECARD" ] }, + "SearchIssuesIncludeQueryParameterItem": { + "description": "Relationship object that should be included in the search response.", + "enum": [ + "issue", + "issue.assignee", + "issue.case", + "issue.team_owners" + ], + "example": "issue.case", + "type": "string", + "x-enum-varnames": [ + "ISSUE", + "ISSUE_ASSIGNEE", + "ISSUE_CASE", + "ISSUE_TEAM_OWNERS" + ] + }, "SecurityFilter": { "description": "The security filter's properties.", "properties": { @@ -349795,6 +355397,8 @@ "data_scanner_read": "View Data Scanner configurations.", "data_scanner_write": "Edit Data Scanner configurations.", "embeddable_graphs_share": "Generate public links to share embeddable graphs externally.", + "error_tracking_read": "Read Error Tracking data.", + "error_tracking_write": "Edit Error Tracking issues.", "events_read": "Read Events data.", "hosts_read": "List hosts and their attributes.", "incident_notification_settings_write": "Configure Incidents Notification settings.", @@ -415569,14 +421173,800 @@ "required": [ "type" ], - "type": "object" + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "org_management" + ] + }, + { + "AuthZ": [ + "monitors_write" + ] + } + ], + "summary": "Get Domain Allowlist", + "tags": [ + "Domain Allowlist" + ], + "x-menu-order": 1, + "x-permission": { + "operator": "OR", + "permissions": [ + "org_management", + "monitors_write", + "generate_dashboard_reports", + "generate_log_reports", + "manage_log_reports" + ] + }, + "x-undo": { + "type": "safe" + } + }, + "patch": { + "description": "Update the domain allowlist for an organization.", + "operationId": "PatchDomainAllowlist", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request containing the desired email domain allowlist configuration.", + "properties": { + "data": { + "description": "The email domain allowlist for an org.", + "properties": { + "attributes": { + "description": "The details of the email domain allowlist.", + "properties": { + "domains": { + "description": "The list of domains in the email domain allowlist.", + "items": { + "type": "string" + }, + "type": "array" + }, + "enabled": { + "description": "Whether the email domain allowlist is enabled for the org.", + "type": "boolean" + } + }, + "type": "object", + "x-ignore-duplicate-object": true + }, + "id": { + "description": "The unique identifier of the org.", + "nullable": true, + "type": "string" + }, + "type": { + "default": "domain_allowlist", + "description": "Email domain allowlist allowlist type.", + "enum": [ + "domain_allowlist" + ], + "example": "domain_allowlist", + "type": "string", + "x-enum-varnames": [ + "DOMAIN_ALLOWLIST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response containing information about the email domain allowlist.", + "properties": { + "data": { + "description": "The email domain allowlist response for an org.", + "properties": { + "attributes": { + "description": "The details of the email domain allowlist.", + "properties": { + "domains": { + "description": "The list of domains in the email domain allowlist.", + "items": { + "type": "string" + }, + "type": "array" + }, + "enabled": { + "description": "Whether the email domain allowlist is enabled for the org.", + "type": "boolean" + } + }, + "type": "object", + "x-ignore-duplicate-object": true + }, + "id": { + "description": "The unique identifier of the org.", + "nullable": true, + "type": "string" + }, + "type": { + "default": "domain_allowlist", + "description": "Email domain allowlist allowlist type.", + "enum": [ + "domain_allowlist" + ], + "example": "domain_allowlist", + "type": "string", + "x-enum-varnames": [ + "DOMAIN_ALLOWLIST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "org_management" + ] + }, + { + "AuthZ": [ + "monitors_write" + ] + } + ], + "summary": "Sets Domain Allowlist", + "tags": [ + "Domain Allowlist" + ], + "x-menu-order": 2, + "x-permission": { + "operator": "OR", + "permissions": [ + "org_management", + "monitors_write", + "generate_dashboard_reports", + "generate_log_reports", + "manage_log_reports" + ] + }, + "x-undo": { + "type": "idempotent" + } + } + }, + "/api/v2/dora/deployment": { + "post": { + "description": "Use this API endpoint to provide data about deployments for DORA metrics.\n\nThis is necessary for:\n- Deployment Frequency\n- Change Lead Time\n- Change Failure Rate", + "operationId": "CreateDORADeployment", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request to create a DORA deployment event.", + "properties": { + "data": { + "description": "The JSON:API data.", + "properties": { + "attributes": { + "description": "Attributes to create a DORA deployment event.", + "properties": { + "custom_tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern. Up to 100 may be added per event.", + "example": [ + "language:java", + "department:engineering" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "env": { + "description": "Environment name to where the service was deployed.", + "example": "staging", + "type": "string" + }, + "finished_at": { + "description": "Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds, and it should not be older than 1 hour.", + "example": 1693491984000000000, + "format": "int64", + "type": "integer" + }, + "git": { + "description": "Git info for DORA Metrics events.", + "properties": { + "commit_sha": { + "description": "Git Commit SHA.", + "example": "66adc9350f2cc9b250b69abddab733dd55e1a588", + "pattern": "^[a-fA-F0-9]{40,}$", + "type": "string" + }, + "repository_url": { + "description": "Git Repository URL", + "example": "https://github.com/organization/example-repository", + "type": "string" + } + }, + "required": [ + "repository_url", + "commit_sha" + ], + "type": "object" + }, + "id": { + "description": "Deployment ID.", + "type": "string" + }, + "service": { + "description": "Service name.", + "example": "shopist", + "type": "string" + }, + "started_at": { + "description": "Unix timestamp when the deployment started. It must be in nanoseconds, milliseconds, or seconds.", + "example": 1693491974000000000, + "format": "int64", + "type": "integer" + }, + "team": { + "description": "Name of the team owning the deployed service. If not provided, this is automatically populated with the team associated with the service in the Service Catalog.", + "example": "backend", + "type": "string" + }, + "version": { + "description": "Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/).", + "example": "v1.12.07", + "type": "string" + } + }, + "required": [ + "service", + "started_at", + "finished_at" + ], + "type": "object" + } + }, + "required": [ + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response after receiving a DORA deployment event.", + "properties": { + "data": { + "description": "The JSON:API data.", + "properties": { + "id": { + "description": "The ID of the received DORA deployment event.", + "example": "4242fcdd31586083", + "type": "string" + }, + "type": { + "default": "dora_deployment", + "description": "JSON:API type for DORA deployment events.", + "enum": [ + "dora_deployment" + ], + "example": "dora_deployment", + "type": "string", + "x-enum-varnames": [ + "DORA_DEPLOYMENT" + ] + } + }, + "required": [ + "id" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "OK" + }, + "202": { + "content": { + "application/json": { + "schema": { + "description": "Response after receiving a DORA deployment event.", + "properties": { + "data": { + "description": "The JSON:API data.", + "properties": { + "id": { + "description": "The ID of the received DORA deployment event.", + "example": "4242fcdd31586083", + "type": "string" + }, + "type": { + "default": "dora_deployment", + "description": "JSON:API type for DORA deployment events.", + "enum": [ + "dora_deployment" + ], + "example": "dora_deployment", + "type": "string", + "x-enum-varnames": [ + "DORA_DEPLOYMENT" + ] + } + }, + "required": [ + "id" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "OK - but delayed due to incident" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "items": { + "description": "API error response body", + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the error.", + "example": "Missing required attribute in body", + "type": "string" + }, + "meta": { + "additionalProperties": {}, + "description": "Non-standard meta-information about the error", + "type": "object" + }, + "source": { + "description": "References to the source of the error.", + "properties": { + "header": { + "description": "A string indicating the name of a single request header which caused the error.", + "example": "Authorization", + "type": "string" + }, + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "limit", + "type": "string" + }, + "pointer": { + "description": "A JSON pointer to the value in the request document that caused the error.", + "example": "/data/attributes/title", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Status code of the response.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short human-readable summary of the error.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Authorized" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "summary": "Send a deployment event for DORA Metrics", + "tags": [ + "DORA Metrics" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 1, + "x-undo": { + "type": "idempotent" + } + } + }, + "/api/v2/dora/deployments": { + "post": { + "description": "Use this API endpoint to get a list of deployment events.", + "operationId": "ListDORADeployments", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request to get a list of deployments.", + "properties": { + "data": { + "description": "The JSON:API data.", + "properties": { + "attributes": { + "description": "Attributes to get a list of deployments.", + "properties": { + "from": { + "description": "Minimum timestamp for requested events.", + "format": "date-time", + "type": "string" + }, + "limit": { + "default": 10, + "description": "Maximum number of events in the response.", + "format": "int32", + "maximum": 1000, + "type": "integer" + }, + "query": { + "description": "Search query with event platform syntax.", + "type": "string" + }, + "sort": { + "description": "Sort order (prefixed with `-` for descending).", + "type": "string" + }, + "to": { + "description": "Maximum timestamp for requested events.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "description": "The definition of `DORAListDeploymentsRequestDataType` object.", + "enum": [ + "dora_deployments_list_request" + ], + "type": "string", + "x-enum-varnames": [ + "DORA_DEPLOYMENTS_LIST_REQUEST" + ] + } + }, + "required": [ + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response for the DORA list endpoints.", + "properties": { + "data": { + "description": "The list of DORA events.", + "items": { + "description": "A DORA event.", + "properties": { + "attributes": { + "description": "The attributes of the event.", + "type": "object" + }, + "id": { + "description": "The ID of the event.", + "type": "string" + }, + "type": { + "description": "The type of the event.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "items": { + "description": "API error response body", + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the error.", + "example": "Missing required attribute in body", + "type": "string" + }, + "meta": { + "additionalProperties": {}, + "description": "Non-standard meta-information about the error", + "type": "object" + }, + "source": { + "description": "References to the source of the error.", + "properties": { + "header": { + "description": "A string indicating the name of a single request header which caused the error.", + "example": "Authorization", + "type": "string" + }, + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "limit", + "type": "string" + }, + "pointer": { + "description": "A JSON pointer to the value in the request document that caused the error.", + "example": "/data/attributes/title", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Status code of the response.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short human-readable summary of the error.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" } }, + "required": [ + "errors" + ], "type": "object" } } }, - "description": "OK" + "description": "Not Authorized" }, "429": { "content": { @@ -415611,149 +422001,63 @@ { "apiKeyAuth": [], "appKeyAuth": [] - }, - { - "AuthZ": [ - "org_management" - ] - }, - { - "AuthZ": [ - "monitors_write" - ] } ], - "summary": "Get Domain Allowlist", + "summary": "Get a list of deployment events", "tags": [ - "Domain Allowlist" + "DORA Metrics" ], - "x-menu-order": 1, + "x-codegen-request-body-name": "body", + "x-menu-order": 3, "x-permission": { "operator": "OR", "permissions": [ - "org_management", - "monitors_write", - "generate_dashboard_reports", - "generate_log_reports", - "manage_log_reports" + "dora_metrics_read" ] }, "x-undo": { "type": "safe" } - }, - "patch": { - "description": "Update the domain allowlist for an organization.", - "operationId": "PatchDomainAllowlist", - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Request containing the desired email domain allowlist configuration.", - "properties": { - "data": { - "description": "The email domain allowlist for an org.", - "properties": { - "attributes": { - "description": "The details of the email domain allowlist.", - "properties": { - "domains": { - "description": "The list of domains in the email domain allowlist.", - "items": { - "type": "string" - }, - "type": "array" - }, - "enabled": { - "description": "Whether the email domain allowlist is enabled for the org.", - "type": "boolean" - } - }, - "type": "object", - "x-ignore-duplicate-object": true - }, - "id": { - "description": "The unique identifier of the org.", - "nullable": true, - "type": "string" - }, - "type": { - "default": "domain_allowlist", - "description": "Email domain allowlist allowlist type.", - "enum": [ - "domain_allowlist" - ], - "example": "domain_allowlist", - "type": "string", - "x-enum-varnames": [ - "DOMAIN_ALLOWLIST" - ] - } - }, - "required": [ - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } + } + }, + "/api/v2/dora/deployments/{deployment_id}": { + "get": { + "description": "Use this API endpoint to get a deployment event.", + "operationId": "GetDORADeployment", + "parameters": [ + { + "description": "The ID of the deployment event.", + "in": "path", + "name": "deployment_id", + "required": true, + "schema": { + "type": "string" } - }, - "required": true - }, + } + ], "responses": { "200": { "content": { "application/json": { "schema": { - "description": "Response containing information about the email domain allowlist.", + "description": "Response for the DORA fetch endpoints.", "properties": { "data": { - "description": "The email domain allowlist response for an org.", + "description": "A DORA event.", "properties": { "attributes": { - "description": "The details of the email domain allowlist.", - "properties": { - "domains": { - "description": "The list of domains in the email domain allowlist.", - "items": { - "type": "string" - }, - "type": "array" - }, - "enabled": { - "description": "Whether the email domain allowlist is enabled for the org.", - "type": "boolean" - } - }, - "type": "object", - "x-ignore-duplicate-object": true + "description": "The attributes of the event.", + "type": "object" }, "id": { - "description": "The unique identifier of the org.", - "nullable": true, + "description": "The ID of the event.", "type": "string" }, "type": { - "default": "domain_allowlist", - "description": "Email domain allowlist allowlist type.", - "enum": [ - "domain_allowlist" - ], - "example": "domain_allowlist", - "type": "string", - "x-enum-varnames": [ - "DOMAIN_ALLOWLIST" - ] + "description": "The type of the event.", + "type": "string" } }, - "required": [ - "type" - ], "type": "object" } }, @@ -415763,6 +422067,101 @@ }, "description": "OK" }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "items": { + "description": "API error response body", + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the error.", + "example": "Missing required attribute in body", + "type": "string" + }, + "meta": { + "additionalProperties": {}, + "description": "Non-standard meta-information about the error", + "type": "object" + }, + "source": { + "description": "References to the source of the error.", + "properties": { + "header": { + "description": "A string indicating the name of a single request header which caused the error.", + "example": "Authorization", + "type": "string" + }, + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "limit", + "type": "string" + }, + "pointer": { + "description": "A JSON pointer to the value in the request document that caused the error.", + "example": "/data/attributes/title", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Status code of the response.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short human-readable summary of the error.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Authorized" + }, "429": { "content": { "application/json": { @@ -415794,55 +422193,44 @@ }, "security": [ { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "org_management" - ] + "apiKeyAuth": [] }, { - "AuthZ": [ - "monitors_write" - ] + "appKeyAuth": [] } ], - "summary": "Sets Domain Allowlist", + "summary": "Get a deployment event", "tags": [ - "Domain Allowlist" + "DORA Metrics" ], - "x-menu-order": 2, + "x-codegen-request-body-name": "body", + "x-menu-order": 5, "x-permission": { "operator": "OR", "permissions": [ - "org_management", - "monitors_write", - "generate_dashboard_reports", - "generate_log_reports", - "manage_log_reports" + "dora_metrics_read" ] }, "x-undo": { - "type": "idempotent" + "type": "safe" } } }, - "/api/v2/dora/deployment": { + "/api/v2/dora/failure": { "post": { - "description": "Use this API endpoint to provide data about deployments for DORA metrics.\n\nThis is necessary for:\n- Deployment Frequency\n- Change Lead Time\n- Change Failure Rate", - "operationId": "CreateDORADeployment", + "description": "Use this API endpoint to provide failure data for DORA metrics.\n\nThis is necessary for:\n- Change Failure Rate\n- Time to Restore", + "operationId": "CreateDORAFailure", "requestBody": { "content": { "application/json": { "schema": { - "description": "Request to create a DORA deployment event.", + "description": "Request to create a DORA failure event.", "properties": { "data": { "description": "The JSON:API data.", "properties": { "attributes": { - "description": "Attributes to create a DORA deployment event.", + "description": "Attributes to create a DORA failure event.", "properties": { "custom_tags": { "description": "A list of user-defined tags. The tags must follow the `key:value` pattern. Up to 100 may be added per event.", @@ -415858,12 +422246,12 @@ "type": "array" }, "env": { - "description": "Environment name to where the service was deployed.", + "description": "Environment name that was impacted by the failure.", "example": "staging", "type": "string" }, "finished_at": { - "description": "Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds, and it should not be older than 1 hour.", + "description": "Unix timestamp when the failure finished. It must be in nanoseconds, milliseconds, or seconds, and it should not be older than 1 hour.", "example": 1693491984000000000, "format": "int64", "type": "integer" @@ -415890,22 +422278,37 @@ "type": "object" }, "id": { - "description": "Deployment ID.", + "description": "Failure ID. Must have at least 16 characters. Required to update a previously sent failure.", "type": "string" }, - "service": { - "description": "Service name.", - "example": "shopist", + "name": { + "description": "Failure name.", + "example": "Webserver is down failing all requests.", + "type": "string" + }, + "services": { + "description": "Service names impacted by the failure. If possible, use names registered in the Service Catalog. Required when the team field is not provided.", + "example": [ + "shopist" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "severity": { + "description": "Failure severity.", + "example": "High", "type": "string" }, "started_at": { - "description": "Unix timestamp when the deployment started. It must be in nanoseconds, milliseconds, or seconds.", + "description": "Unix timestamp when the failure started. It must be in nanoseconds, milliseconds, or seconds.", "example": 1693491974000000000, "format": "int64", "type": "integer" }, "team": { - "description": "Name of the team owning the deployed service. If not provided, this is automatically populated with the team associated with the service in the Service Catalog.", + "description": "Name of the team owning the services impacted. If possible, use team handles registered in Datadog. Required when the services field is not provided.", "example": "backend", "type": "string" }, @@ -415916,9 +422319,7 @@ } }, "required": [ - "service", - "started_at", - "finished_at" + "started_at" ], "type": "object" } @@ -415943,26 +422344,26 @@ "content": { "application/json": { "schema": { - "description": "Response after receiving a DORA deployment event.", + "description": "Response after receiving a DORA failure event.", "properties": { "data": { - "description": "The JSON:API data.", + "description": "Response after receiving a DORA failure event.", "properties": { "id": { - "description": "The ID of the received DORA deployment event.", + "description": "The ID of the received DORA failure event.", "example": "4242fcdd31586083", "type": "string" }, "type": { - "default": "dora_deployment", - "description": "JSON:API type for DORA deployment events.", + "default": "dora_failure", + "description": "JSON:API type for DORA failure events.", "enum": [ - "dora_deployment" + "dora_failure" ], - "example": "dora_deployment", + "example": "dora_failure", "type": "string", "x-enum-varnames": [ - "DORA_DEPLOYMENT" + "DORA_FAILURE" ] } }, @@ -415985,26 +422386,26 @@ "content": { "application/json": { "schema": { - "description": "Response after receiving a DORA deployment event.", + "description": "Response after receiving a DORA failure event.", "properties": { "data": { - "description": "The JSON:API data.", + "description": "Response after receiving a DORA failure event.", "properties": { "id": { - "description": "The ID of the received DORA deployment event.", + "description": "The ID of the received DORA failure event.", "example": "4242fcdd31586083", "type": "string" }, "type": { - "default": "dora_deployment", - "description": "JSON:API type for DORA deployment events.", + "default": "dora_failure", + "description": "JSON:API type for DORA failure events.", "enum": [ - "dora_deployment" + "dora_failure" ], - "example": "dora_deployment", + "example": "dora_failure", "type": "string", "x-enum-varnames": [ - "DORA_DEPLOYMENT" + "DORA_FAILURE" ] } }, @@ -416152,32 +422553,32 @@ "apiKeyAuth": [] } ], - "summary": "Send a deployment event for DORA Metrics", + "summary": "Send a failure event for DORA Metrics", "tags": [ "DORA Metrics" ], "x-codegen-request-body-name": "body", - "x-menu-order": 1, + "x-menu-order": 2, "x-undo": { "type": "idempotent" } } }, - "/api/v2/dora/deployments": { + "/api/v2/dora/failures": { "post": { - "description": "Use this API endpoint to get a list of deployment events.", - "operationId": "ListDORADeployments", + "description": "Use this API endpoint to get a list of failure events.", + "operationId": "ListDORAFailures", "requestBody": { "content": { "application/json": { "schema": { - "description": "Request to get a list of deployments.", + "description": "Request to get a list of failures.", "properties": { "data": { "description": "The JSON:API data.", "properties": { "attributes": { - "description": "Attributes to get a list of deployments.", + "description": "Attributes to get a list of failures.", "properties": { "from": { "description": "Minimum timestamp for requested events.", @@ -416208,13 +422609,13 @@ "type": "object" }, "type": { - "description": "The definition of `DORAListDeploymentsRequestDataType` object.", + "description": "The definition of `DORAListFailuresRequestDataType` object.", "enum": [ - "dora_deployments_list_request" + "dora_failures_list_request" ], "type": "string", "x-enum-varnames": [ - "DORA_DEPLOYMENTS_LIST_REQUEST" + "DORA_FAILURES_LIST_REQUEST" ] } }, @@ -416399,12 +422800,12 @@ "appKeyAuth": [] } ], - "summary": "Get a list of deployment events", + "summary": "Get a list of failure events", "tags": [ "DORA Metrics" ], "x-codegen-request-body-name": "body", - "x-menu-order": 3, + "x-menu-order": 4, "x-permission": { "operator": "OR", "permissions": [ @@ -416416,15 +422817,15 @@ } } }, - "/api/v2/dora/deployments/{deployment_id}": { + "/api/v2/dora/failures/{failure_id}": { "get": { - "description": "Use this API endpoint to get a deployment event.", - "operationId": "GetDORADeployment", + "description": "Use this API endpoint to get a failure event.", + "operationId": "GetDORAFailure", "parameters": [ { - "description": "The ID of the deployment event.", + "description": "The ID of the failure event.", "in": "path", - "name": "deployment_id", + "name": "failure_id", "required": true, "schema": { "type": "string" @@ -416595,12 +422996,12 @@ "appKeyAuth": [] } ], - "summary": "Get a deployment event", + "summary": "Get a failure event", "tags": [ "DORA Metrics" ], "x-codegen-request-body-name": "body", - "x-menu-order": 5, + "x-menu-order": 6, "x-permission": { "operator": "OR", "permissions": [ @@ -416612,10 +423013,11 @@ } } }, - "/api/v2/dora/failure": { + "/api/v2/dora/incident": { "post": { - "description": "Use this API endpoint to provide failure data for DORA metrics.\n\nThis is necessary for:\n- Change Failure Rate\n- Time to Restore", - "operationId": "CreateDORAFailure", + "deprecated": true, + "description": "**Note**: This endpoint is deprecated. Please use `/api/v2/dora/failure` instead.\n\nUse this API endpoint to provide failure data for DORA metrics.\n\nThis is necessary for:\n- Change Failure Rate\n- Time to Restore", + "operationId": "CreateDORAIncident", "requestBody": { "content": { "application/json": { @@ -416949,7 +423351,7 @@ "apiKeyAuth": [] } ], - "summary": "Send a failure event for DORA Metrics", + "summary": "Send an incident event for DORA Metrics", "tags": [ "DORA Metrics" ], @@ -416960,178 +423362,717 @@ } } }, - "/api/v2/dora/failures": { - "post": { - "description": "Use this API endpoint to get a list of failure events.", - "operationId": "ListDORAFailures", - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Request to get a list of failures.", - "properties": { - "data": { - "description": "The JSON:API data.", - "properties": { - "attributes": { - "description": "Attributes to get a list of failures.", - "properties": { - "from": { - "description": "Minimum timestamp for requested events.", - "format": "date-time", - "type": "string" - }, - "limit": { - "default": 10, - "description": "Maximum number of events in the response.", - "format": "int32", - "maximum": 1000, - "type": "integer" - }, - "query": { - "description": "Search query with event platform syntax.", - "type": "string" - }, - "sort": { - "description": "Sort order (prefixed with `-` for descending).", - "type": "string" - }, - "to": { - "description": "Maximum timestamp for requested events.", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "The definition of `DORAListFailuresRequestDataType` object.", - "enum": [ - "dora_failures_list_request" - ], - "type": "string", - "x-enum-varnames": [ - "DORA_FAILURES_LIST_REQUEST" - ] - } - }, - "required": [ - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } + "/api/v2/downtime": { + "get": { + "description": "Get all scheduled downtimes.", + "operationId": "ListDowntimes", + "parameters": [ + { + "description": "Only return downtimes that are active when the request is made.", + "in": "query", + "name": "current_only", + "required": false, + "schema": { + "type": "boolean" } }, - "required": true - }, + { + "description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "example": "created_by,monitor", + "type": "string" + } + }, + { + "description": "Specific offset to use as the beginning of the returned page.", + "in": "query", + "name": "page[offset]", + "required": false, + "schema": { + "default": 0, + "example": 0, + "format": "int64", + "type": "integer" + } + }, + { + "description": "Maximum number of downtimes in the response.", + "example": 100, + "in": "query", + "name": "page[limit]", + "required": false, + "schema": { + "default": 30, + "format": "int64", + "type": "integer" + } + } + ], "responses": { "200": { "content": { "application/json": { "schema": { - "description": "Response for the DORA list endpoints.", + "description": "Response for retrieving all downtimes.", "properties": { "data": { - "description": "The list of DORA events.", + "description": "An array of downtimes.", "items": { - "description": "A DORA event.", + "description": "Downtime data.", "properties": { "attributes": { - "description": "The attributes of the event.", + "description": "Downtime details.", + "properties": { + "canceled": { + "description": "Time that the downtime was canceled.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "created": { + "description": "Creation time of the downtime.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "type": "string" + }, + "display_timezone": { + "default": "UTC", + "description": "The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.", + "example": "America/New_York", + "nullable": true, + "type": "string" + }, + "message": { + "description": "A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same `@username` notation as events.", + "example": "Message about the downtime", + "nullable": true, + "type": "string" + }, + "modified": { + "description": "Time that the downtime was last modified.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "type": "string" + }, + "monitor_identifier": { + "description": "Monitor identifier for the downtime.", + "oneOf": [ + { + "additionalProperties": {}, + "description": "Object of the monitor identifier.", + "properties": { + "monitor_id": { + "description": "ID of the monitor to prevent notifications.", + "example": 123, + "format": "int64", + "type": "integer" + } + }, + "required": [ + "monitor_id" + ], + "type": "object" + }, + { + "additionalProperties": {}, + "description": "Object of the monitor tags.", + "properties": { + "monitor_tags": { + "description": "A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`\nto `[*]` configures the downtime to mute all monitors for the given scope.", + "example": [ + "service:postgres", + "team:frontend" + ], + "items": { + "description": "A list of monitor tags.", + "example": "service:postgres", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "monitor_tags" + ], + "type": "object" + } + ] + }, + "mute_first_recovery_notification": { + "description": "If the first recovery notification during a downtime should be muted.", + "example": false, + "type": "boolean" + }, + "notify_end_states": { + "description": "States that will trigger a monitor notification when the `notify_end_types` action occurs.", + "example": [ + "alert", + "warn" + ], + "items": { + "description": "State that will trigger a monitor notification when the `notify_end_types` action occurs.", + "enum": [ + "alert", + "no data", + "warn" + ], + "example": "alert", + "type": "string", + "x-enum-varnames": [ + "ALERT", + "NO_DATA", + "WARN" + ] + }, + "type": "array" + }, + "notify_end_types": { + "description": "Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", + "example": [ + "canceled", + "expired" + ], + "items": { + "description": "Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", + "enum": [ + "canceled", + "expired" + ], + "example": "canceled", + "type": "string", + "x-enum-varnames": [ + "CANCELED", + "EXPIRED" + ] + }, + "type": "array" + }, + "schedule": { + "description": "The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.", + "oneOf": [ + { + "description": "A recurring downtime schedule definition.", + "properties": { + "current_downtime": { + "description": "The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.", + "properties": { + "end": { + "description": "The end of the current downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "start": { + "description": "The start of the current downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "recurrences": { + "description": "A list of downtime recurrences.", + "items": { + "description": "An RRULE-based recurring downtime.", + "properties": { + "duration": { + "description": "The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.", + "example": "123d", + "type": "string" + }, + "rrule": { + "description": "The `RRULE` standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.\nMost common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.\n\n**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).\nMore examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).", + "example": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1", + "type": "string" + }, + "start": { + "description": "ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.", + "example": "2020-01-02T03:04", + "type": "string" + } + }, + "type": "object" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "timezone": { + "default": "UTC", + "description": "The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match `display_timezone`.", + "example": "America/New_York", + "type": "string" + } + }, + "required": [ + "recurrences" + ], + "type": "object" + }, + { + "description": "A one-time downtime definition.", + "properties": { + "end": { + "description": "ISO-8601 Datetime to end the downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "start": { + "description": "ISO-8601 Datetime to start the downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "start" + ], + "type": "object" + } + ] + }, + "scope": { + "description": "The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).", + "example": "env:(staging OR prod) AND datacenter:us-east-1", + "type": "string" + }, + "status": { + "description": "The current status of the downtime.", + "enum": [ + "active", + "canceled", + "ended", + "scheduled" + ], + "example": "active", + "type": "string", + "x-enum-varnames": [ + "ACTIVE", + "CANCELED", + "ENDED", + "SCHEDULED" + ] + } + }, "type": "object" }, "id": { - "description": "The ID of the event.", + "description": "The downtime ID.", + "example": "00000000-0000-1234-0000-000000000000", "type": "string" }, + "relationships": { + "description": "All relationships associated with downtime.", + "properties": { + "created_by": { + "description": "The user who created the downtime.", + "properties": { + "data": { + "description": "Data for the user who created the downtime.", + "nullable": true, + "properties": { + "id": { + "description": "User ID of the downtime creator.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + } + }, + "type": "object" + }, + "monitor": { + "description": "The monitor identified by the downtime.", + "properties": { + "data": { + "description": "Data for the monitor.", + "nullable": true, + "properties": { + "id": { + "description": "Monitor ID of the downtime.", + "example": "12345", + "type": "string" + }, + "type": { + "default": "monitors", + "description": "Monitor resource type.", + "enum": [ + "monitors" + ], + "example": "monitors", + "type": "string", + "x-enum-varnames": [ + "MONITORS" + ] + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, "type": { - "description": "The type of the event.", - "type": "string" + "default": "downtime", + "description": "Downtime resource type.", + "enum": [ + "downtime" + ], + "example": "downtime", + "type": "string", + "x-enum-varnames": [ + "DOWNTIME" + ] } }, "type": "object" }, "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - }, - "400": { - "content": { - "application/json": { - "schema": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", + }, + "included": { + "description": "Array of objects related to the downtimes.", "items": { - "description": "API error response body", - "properties": { - "detail": { - "description": "A human-readable explanation specific to this occurrence of the error.", - "example": "Missing required attribute in body", - "type": "string" - }, - "meta": { - "additionalProperties": {}, - "description": "Non-standard meta-information about the error", - "type": "object" - }, - "source": { - "description": "References to the source of the error.", + "description": "An object related to a downtime.", + "oneOf": [ + { + "description": "User object returned by the API.", "properties": { - "header": { - "description": "A string indicating the name of a single request header which caused the error.", - "example": "Authorization", - "type": "string" + "attributes": { + "description": "Attributes of user object returned by the API.", + "properties": { + "created_at": { + "description": "Creation time of the user.", + "format": "date-time", + "type": "string" + }, + "disabled": { + "description": "Whether the user is disabled.", + "type": "boolean" + }, + "email": { + "description": "Email of the user.", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "type": "string" + }, + "icon": { + "description": "URL of the user's icon.", + "type": "string" + }, + "mfa_enabled": { + "description": "If user has MFA enabled.", + "readOnly": true, + "type": "boolean" + }, + "modified_at": { + "description": "Time that the user was last modified.", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "nullable": true, + "type": "string" + }, + "service_account": { + "description": "Whether the user is a service account.", + "type": "boolean" + }, + "status": { + "description": "Status of the user.", + "type": "string" + }, + "title": { + "description": "Title of the user.", + "nullable": true, + "type": "string" + }, + "verified": { + "description": "Whether the user is verified.", + "type": "boolean" + } + }, + "type": "object" }, - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "limit", + "id": { + "description": "ID of the user.", "type": "string" }, - "pointer": { - "description": "A JSON pointer to the value in the request document that caused the error.", - "example": "/data/attributes/title", - "type": "string" + "relationships": { + "description": "Relationships of the user object returned by the API.", + "properties": { + "org": { + "description": "Relationship to an organization.", + "properties": { + "data": { + "description": "Relationship to organization object.", + "properties": { + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", + "type": "string" + }, + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "other_orgs": { + "description": "Relationship to organizations.", + "properties": { + "data": { + "description": "Relationships to organization objects.", + "example": [], + "items": { + "description": "Relationship to organization object.", + "properties": { + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", + "type": "string" + }, + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "other_users": { + "description": "Relationship to users.", + "properties": { + "data": { + "description": "Relationships to user objects.", + "example": [], + "items": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "roles": { + "description": "Relationship to roles.", + "properties": { + "data": { + "description": "An array containing type and the unique identifier of a role.", + "items": { + "description": "Relationship to role object.", + "properties": { + "id": { + "description": "The unique identifier of the role.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" + }, + "type": { + "default": "roles", + "description": "Roles type.", + "enum": [ + "roles" + ], + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "properties": false + } + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] } }, - "type": "object" - }, - "status": { - "description": "Status code of the response.", - "example": "400", - "type": "string" + "type": "object", + "x-merge-override": { + "required": false + } }, - "title": { - "description": "Short human-readable summary of the error.", - "example": "Bad Request", - "type": "string" + { + "description": "Information about the monitor identified by the downtime.", + "properties": { + "attributes": { + "description": "Attributes of the monitor identified by the downtime.", + "properties": { + "name": { + "description": "The name of the monitor identified by the downtime.", + "example": "A monitor name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the monitor identified by the downtime.", + "example": 12345, + "format": "int64", + "type": "integer" + }, + "type": { + "default": "monitors", + "description": "Monitor resource type.", + "enum": [ + "monitors" + ], + "example": "monitors", + "type": "string", + "x-enum-varnames": [ + "MONITORS" + ] + } + }, + "type": "object" } - }, - "type": "object" + ] }, "type": "array" + }, + "meta": { + "description": "Pagination metadata returned by the API.", + "properties": { + "page": { + "description": "Object containing the total filtered count.", + "properties": { + "total_filtered_count": { + "description": "Total count of elements matched by the filter.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" } }, - "required": [ - "errors" - ], "type": "object" } } }, - "description": "Bad Request" + "description": "OK" }, "403": { "content": { @@ -417159,7 +424100,7 @@ } } }, - "description": "Not Authorized" + "description": "Forbidden" }, "429": { "content": { @@ -417194,64 +424135,903 @@ { "apiKeyAuth": [], "appKeyAuth": [] + }, + { + "AuthZ": [ + "monitors_downtime" + ] } ], - "summary": "Get a list of failure events", + "summary": "Get all downtimes", "tags": [ - "DORA Metrics" + "Downtimes" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 4, + "x-menu-order": 1, + "x-pagination": { + "limitParam": "page[limit]", + "pageOffsetParam": "page[offset]", + "resultsPath": "data" + }, "x-permission": { "operator": "OR", "permissions": [ - "dora_metrics_read" + "monitors_downtime" ] }, "x-undo": { "type": "safe" } - } - }, - "/api/v2/dora/failures/{failure_id}": { - "get": { - "description": "Use this API endpoint to get a failure event.", - "operationId": "GetDORAFailure", - "parameters": [ - { - "description": "The ID of the failure event.", - "in": "path", - "name": "failure_id", - "required": true, - "schema": { - "type": "string" + }, + "post": { + "description": "Schedule a downtime.", + "operationId": "CreateDowntime", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request for creating a downtime.", + "properties": { + "data": { + "description": "Object to create a downtime.", + "properties": { + "attributes": { + "description": "Downtime details.", + "properties": { + "display_timezone": { + "default": "UTC", + "description": "The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.", + "example": "America/New_York", + "nullable": true, + "type": "string" + }, + "message": { + "description": "A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same `@username` notation as events.", + "example": "Message about the downtime", + "nullable": true, + "type": "string" + }, + "monitor_identifier": { + "description": "Monitor identifier for the downtime.", + "oneOf": [ + { + "additionalProperties": {}, + "description": "Object of the monitor identifier.", + "properties": { + "monitor_id": { + "description": "ID of the monitor to prevent notifications.", + "example": 123, + "format": "int64", + "type": "integer" + } + }, + "required": [ + "monitor_id" + ], + "type": "object" + }, + { + "additionalProperties": {}, + "description": "Object of the monitor tags.", + "properties": { + "monitor_tags": { + "description": "A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`\nto `[*]` configures the downtime to mute all monitors for the given scope.", + "example": [ + "service:postgres", + "team:frontend" + ], + "items": { + "description": "A list of monitor tags.", + "example": "service:postgres", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "monitor_tags" + ], + "type": "object" + } + ] + }, + "mute_first_recovery_notification": { + "description": "If the first recovery notification during a downtime should be muted.", + "example": false, + "type": "boolean" + }, + "notify_end_states": { + "description": "States that will trigger a monitor notification when the `notify_end_types` action occurs.", + "example": [ + "alert", + "warn" + ], + "items": { + "description": "State that will trigger a monitor notification when the `notify_end_types` action occurs.", + "enum": [ + "alert", + "no data", + "warn" + ], + "example": "alert", + "type": "string", + "x-enum-varnames": [ + "ALERT", + "NO_DATA", + "WARN" + ] + }, + "type": "array" + }, + "notify_end_types": { + "description": "Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", + "example": [ + "canceled", + "expired" + ], + "items": { + "description": "Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", + "enum": [ + "canceled", + "expired" + ], + "example": "canceled", + "type": "string", + "x-enum-varnames": [ + "CANCELED", + "EXPIRED" + ] + }, + "type": "array" + }, + "schedule": { + "description": "Schedule for the downtime.", + "oneOf": [ + { + "description": "A recurring downtime schedule definition.", + "properties": { + "recurrences": { + "description": "A list of downtime recurrences.", + "items": { + "additionalProperties": {}, + "description": "An object defining the recurrence of the downtime.", + "properties": { + "duration": { + "description": "The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.", + "example": "123d", + "type": "string" + }, + "rrule": { + "description": "The `RRULE` standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.\nMost common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.\n\n**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).\nMore examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).", + "example": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1", + "type": "string" + }, + "start": { + "description": "ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.", + "example": "2020-01-02T03:04", + "nullable": true, + "type": "string" + } + }, + "required": [ + "duration", + "rrule" + ], + "type": "object" + }, + "type": "array" + }, + "timezone": { + "default": "UTC", + "description": "The timezone in which to schedule the downtime.", + "example": "America/New_York", + "type": "string" + } + }, + "required": [ + "recurrences" + ], + "type": "object" + }, + { + "additionalProperties": false, + "description": "A one-time downtime definition.", + "properties": { + "end": { + "description": "ISO-8601 Datetime to end the downtime. Must include a UTC offset of zero. If not provided, the\ndowntime continues forever.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "start": { + "description": "ISO-8601 Datetime to start the downtime. Must include a UTC offset of zero. If not provided, the\ndowntime starts the moment it is created.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "nullable": true, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "scope": { + "description": "The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).", + "example": "env:(staging OR prod) AND datacenter:us-east-1", + "type": "string" + } + }, + "required": [ + "scope", + "monitor_identifier" + ], + "type": "object" + }, + "type": { + "default": "downtime", + "description": "Downtime resource type.", + "enum": [ + "downtime" + ], + "example": "downtime", + "type": "string", + "x-enum-varnames": [ + "DOWNTIME" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } } - } - ], + }, + "description": "Schedule a downtime request body.", + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "description": "Response for the DORA fetch endpoints.", + "description": "Downtiming gives you greater control over monitor notifications by\nallowing you to globally exclude scopes from alerting.\nDowntime settings, which can be scheduled with start and end times,\nprevent all alerting related to specified Datadog tags.", "properties": { "data": { - "description": "A DORA event.", + "description": "Downtime data.", "properties": { "attributes": { - "description": "The attributes of the event.", + "description": "Downtime details.", + "properties": { + "canceled": { + "description": "Time that the downtime was canceled.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "created": { + "description": "Creation time of the downtime.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "type": "string" + }, + "display_timezone": { + "default": "UTC", + "description": "The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.", + "example": "America/New_York", + "nullable": true, + "type": "string" + }, + "message": { + "description": "A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same `@username` notation as events.", + "example": "Message about the downtime", + "nullable": true, + "type": "string" + }, + "modified": { + "description": "Time that the downtime was last modified.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "type": "string" + }, + "monitor_identifier": { + "description": "Monitor identifier for the downtime.", + "oneOf": [ + { + "additionalProperties": {}, + "description": "Object of the monitor identifier.", + "properties": { + "monitor_id": { + "description": "ID of the monitor to prevent notifications.", + "example": 123, + "format": "int64", + "type": "integer" + } + }, + "required": [ + "monitor_id" + ], + "type": "object" + }, + { + "additionalProperties": {}, + "description": "Object of the monitor tags.", + "properties": { + "monitor_tags": { + "description": "A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`\nto `[*]` configures the downtime to mute all monitors for the given scope.", + "example": [ + "service:postgres", + "team:frontend" + ], + "items": { + "description": "A list of monitor tags.", + "example": "service:postgres", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "monitor_tags" + ], + "type": "object" + } + ] + }, + "mute_first_recovery_notification": { + "description": "If the first recovery notification during a downtime should be muted.", + "example": false, + "type": "boolean" + }, + "notify_end_states": { + "description": "States that will trigger a monitor notification when the `notify_end_types` action occurs.", + "example": [ + "alert", + "warn" + ], + "items": { + "description": "State that will trigger a monitor notification when the `notify_end_types` action occurs.", + "enum": [ + "alert", + "no data", + "warn" + ], + "example": "alert", + "type": "string", + "x-enum-varnames": [ + "ALERT", + "NO_DATA", + "WARN" + ] + }, + "type": "array" + }, + "notify_end_types": { + "description": "Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", + "example": [ + "canceled", + "expired" + ], + "items": { + "description": "Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", + "enum": [ + "canceled", + "expired" + ], + "example": "canceled", + "type": "string", + "x-enum-varnames": [ + "CANCELED", + "EXPIRED" + ] + }, + "type": "array" + }, + "schedule": { + "description": "The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.", + "oneOf": [ + { + "description": "A recurring downtime schedule definition.", + "properties": { + "current_downtime": { + "description": "The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.", + "properties": { + "end": { + "description": "The end of the current downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "start": { + "description": "The start of the current downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "recurrences": { + "description": "A list of downtime recurrences.", + "items": { + "description": "An RRULE-based recurring downtime.", + "properties": { + "duration": { + "description": "The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.", + "example": "123d", + "type": "string" + }, + "rrule": { + "description": "The `RRULE` standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.\nMost common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.\n\n**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).\nMore examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).", + "example": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1", + "type": "string" + }, + "start": { + "description": "ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.", + "example": "2020-01-02T03:04", + "type": "string" + } + }, + "type": "object" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "timezone": { + "default": "UTC", + "description": "The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match `display_timezone`.", + "example": "America/New_York", + "type": "string" + } + }, + "required": [ + "recurrences" + ], + "type": "object" + }, + { + "description": "A one-time downtime definition.", + "properties": { + "end": { + "description": "ISO-8601 Datetime to end the downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "start": { + "description": "ISO-8601 Datetime to start the downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "start" + ], + "type": "object" + } + ] + }, + "scope": { + "description": "The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).", + "example": "env:(staging OR prod) AND datacenter:us-east-1", + "type": "string" + }, + "status": { + "description": "The current status of the downtime.", + "enum": [ + "active", + "canceled", + "ended", + "scheduled" + ], + "example": "active", + "type": "string", + "x-enum-varnames": [ + "ACTIVE", + "CANCELED", + "ENDED", + "SCHEDULED" + ] + } + }, "type": "object" }, "id": { - "description": "The ID of the event.", + "description": "The downtime ID.", + "example": "00000000-0000-1234-0000-000000000000", "type": "string" }, + "relationships": { + "description": "All relationships associated with downtime.", + "properties": { + "created_by": { + "description": "The user who created the downtime.", + "properties": { + "data": { + "description": "Data for the user who created the downtime.", + "nullable": true, + "properties": { + "id": { + "description": "User ID of the downtime creator.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + } + }, + "type": "object" + }, + "monitor": { + "description": "The monitor identified by the downtime.", + "properties": { + "data": { + "description": "Data for the monitor.", + "nullable": true, + "properties": { + "id": { + "description": "Monitor ID of the downtime.", + "example": "12345", + "type": "string" + }, + "type": { + "default": "monitors", + "description": "Monitor resource type.", + "enum": [ + "monitors" + ], + "example": "monitors", + "type": "string", + "x-enum-varnames": [ + "MONITORS" + ] + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, "type": { - "description": "The type of the event.", - "type": "string" + "default": "downtime", + "description": "Downtime resource type.", + "enum": [ + "downtime" + ], + "example": "downtime", + "type": "string", + "x-enum-varnames": [ + "DOWNTIME" + ] } }, - "type": "object" + "type": "object" + }, + "included": { + "description": "Array of objects related to the downtime that the user requested.", + "items": { + "description": "An object related to a downtime.", + "oneOf": [ + { + "description": "User object returned by the API.", + "properties": { + "attributes": { + "description": "Attributes of user object returned by the API.", + "properties": { + "created_at": { + "description": "Creation time of the user.", + "format": "date-time", + "type": "string" + }, + "disabled": { + "description": "Whether the user is disabled.", + "type": "boolean" + }, + "email": { + "description": "Email of the user.", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "type": "string" + }, + "icon": { + "description": "URL of the user's icon.", + "type": "string" + }, + "mfa_enabled": { + "description": "If user has MFA enabled.", + "readOnly": true, + "type": "boolean" + }, + "modified_at": { + "description": "Time that the user was last modified.", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "nullable": true, + "type": "string" + }, + "service_account": { + "description": "Whether the user is a service account.", + "type": "boolean" + }, + "status": { + "description": "Status of the user.", + "type": "string" + }, + "title": { + "description": "Title of the user.", + "nullable": true, + "type": "string" + }, + "verified": { + "description": "Whether the user is verified.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the user.", + "type": "string" + }, + "relationships": { + "description": "Relationships of the user object returned by the API.", + "properties": { + "org": { + "description": "Relationship to an organization.", + "properties": { + "data": { + "description": "Relationship to organization object.", + "properties": { + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", + "type": "string" + }, + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "other_orgs": { + "description": "Relationship to organizations.", + "properties": { + "data": { + "description": "Relationships to organization objects.", + "example": [], + "items": { + "description": "Relationship to organization object.", + "properties": { + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", + "type": "string" + }, + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "other_users": { + "description": "Relationship to users.", + "properties": { + "data": { + "description": "Relationships to user objects.", + "example": [], + "items": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "roles": { + "description": "Relationship to roles.", + "properties": { + "data": { + "description": "An array containing type and the unique identifier of a role.", + "items": { + "description": "Relationship to role object.", + "properties": { + "id": { + "description": "The unique identifier of the role.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" + }, + "type": { + "default": "roles", + "description": "Roles type.", + "enum": [ + "roles" + ], + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "properties": false + } + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + { + "description": "Information about the monitor identified by the downtime.", + "properties": { + "attributes": { + "description": "Attributes of the monitor identified by the downtime.", + "properties": { + "name": { + "description": "The name of the monitor identified by the downtime.", + "example": "A monitor name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the monitor identified by the downtime.", + "example": 12345, + "format": "int64", + "type": "integer" + }, + "type": { + "default": "monitors", + "description": "Monitor resource type.", + "enum": [ + "monitors" + ], + "example": "monitors", + "type": "string", + "x-enum-varnames": [ + "MONITORS" + ] + } + }, + "type": "object" + } + ] + }, + "type": "array" } }, "type": "object" @@ -417268,52 +425048,13 @@ "properties": { "errors": { "description": "A list of errors.", + "example": [ + "Bad Request" + ], "items": { - "description": "API error response body", - "properties": { - "detail": { - "description": "A human-readable explanation specific to this occurrence of the error.", - "example": "Missing required attribute in body", - "type": "string" - }, - "meta": { - "additionalProperties": {}, - "description": "Non-standard meta-information about the error", - "type": "object" - }, - "source": { - "description": "References to the source of the error.", - "properties": { - "header": { - "description": "A string indicating the name of a single request header which caused the error.", - "example": "Authorization", - "type": "string" - }, - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "limit", - "type": "string" - }, - "pointer": { - "description": "A JSON pointer to the value in the request document that caused the error.", - "example": "/data/attributes/title", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "Status code of the response.", - "example": "400", - "type": "string" - }, - "title": { - "description": "Short human-readable summary of the error.", - "example": "Bad Request", - "type": "string" - } - }, - "type": "object" + "description": "A list of items.", + "example": "Bad Request", + "type": "string" }, "type": "array" } @@ -417353,7 +425094,7 @@ } } }, - "description": "Not Authorized" + "description": "Forbidden" }, "429": { "content": { @@ -417386,239 +425127,71 @@ }, "security": [ { - "apiKeyAuth": [] + "apiKeyAuth": [], + "appKeyAuth": [] }, { - "appKeyAuth": [] + "AuthZ": [ + "monitors_downtime" + ] } ], - "summary": "Get a failure event", + "summary": "Schedule a downtime", "tags": [ - "DORA Metrics" + "Downtimes" ], "x-codegen-request-body-name": "body", - "x-menu-order": 6, + "x-given": { + "downtime_v2": { + "parameters": [ + { + "name": "body", + "value": "{\n \"data\": {\n \"attributes\": {\n \"message\": \"test message\",\n \"monitor_identifier\": {\n \"monitor_tags\": [\"cat:hat\"]\n },\n \"scope\": \"test:{{ unique_lower_alnum }}\",\n \"schedule\": {\n \"start\": null\n }\n },\n \"type\": \"downtime\"\n }\n}" + } + ], + "step": "there is a valid \"downtime_v2\" in the system" + } + }, + "x-menu-order": 2, "x-permission": { "operator": "OR", "permissions": [ - "dora_metrics_read" + "monitors_downtime" ] }, "x-undo": { - "type": "safe" + "operationId": "CancelDowntime", + "parameters": [ + { + "name": "downtime_id", + "source": "data.id" + } + ], + "type": "unsafe" } } }, - "/api/v2/dora/incident": { - "post": { - "deprecated": true, - "description": "**Note**: This endpoint is deprecated. Please use `/api/v2/dora/failure` instead.\n\nUse this API endpoint to provide failure data for DORA metrics.\n\nThis is necessary for:\n- Change Failure Rate\n- Time to Restore", - "operationId": "CreateDORAIncident", - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Request to create a DORA failure event.", - "properties": { - "data": { - "description": "The JSON:API data.", - "properties": { - "attributes": { - "description": "Attributes to create a DORA failure event.", - "properties": { - "custom_tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern. Up to 100 may be added per event.", - "example": [ - "language:java", - "department:engineering" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "env": { - "description": "Environment name that was impacted by the failure.", - "example": "staging", - "type": "string" - }, - "finished_at": { - "description": "Unix timestamp when the failure finished. It must be in nanoseconds, milliseconds, or seconds, and it should not be older than 1 hour.", - "example": 1693491984000000000, - "format": "int64", - "type": "integer" - }, - "git": { - "description": "Git info for DORA Metrics events.", - "properties": { - "commit_sha": { - "description": "Git Commit SHA.", - "example": "66adc9350f2cc9b250b69abddab733dd55e1a588", - "pattern": "^[a-fA-F0-9]{40,}$", - "type": "string" - }, - "repository_url": { - "description": "Git Repository URL", - "example": "https://github.com/organization/example-repository", - "type": "string" - } - }, - "required": [ - "repository_url", - "commit_sha" - ], - "type": "object" - }, - "id": { - "description": "Failure ID. Must have at least 16 characters. Required to update a previously sent failure.", - "type": "string" - }, - "name": { - "description": "Failure name.", - "example": "Webserver is down failing all requests.", - "type": "string" - }, - "services": { - "description": "Service names impacted by the failure. If possible, use names registered in the Service Catalog. Required when the team field is not provided.", - "example": [ - "shopist" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "severity": { - "description": "Failure severity.", - "example": "High", - "type": "string" - }, - "started_at": { - "description": "Unix timestamp when the failure started. It must be in nanoseconds, milliseconds, or seconds.", - "example": 1693491974000000000, - "format": "int64", - "type": "integer" - }, - "team": { - "description": "Name of the team owning the services impacted. If possible, use team handles registered in Datadog. Required when the services field is not provided.", - "example": "backend", - "type": "string" - }, - "version": { - "description": "Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/).", - "example": "v1.12.07", - "type": "string" - } - }, - "required": [ - "started_at" - ], - "type": "object" - } - }, - "required": [ - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } + "/api/v2/downtime/{downtime_id}": { + "delete": { + "description": "Cancel a downtime.\n\n**Note**: Downtimes canceled through the API are no longer active, but are retained for approximately two days before being permanently removed. The downtime may still appear in search results until it is permanently removed.", + "operationId": "CancelDowntime", + "parameters": [ + { + "description": "ID of the downtime to cancel.", + "in": "path", + "name": "downtime_id", + "required": true, + "schema": { + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" } - }, - "required": true - }, + } + ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "Response after receiving a DORA failure event.", - "properties": { - "data": { - "description": "Response after receiving a DORA failure event.", - "properties": { - "id": { - "description": "The ID of the received DORA failure event.", - "example": "4242fcdd31586083", - "type": "string" - }, - "type": { - "default": "dora_failure", - "description": "JSON:API type for DORA failure events.", - "enum": [ - "dora_failure" - ], - "example": "dora_failure", - "type": "string", - "x-enum-varnames": [ - "DORA_FAILURE" - ] - } - }, - "required": [ - "id" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, + "204": { "description": "OK" }, - "202": { - "content": { - "application/json": { - "schema": { - "description": "Response after receiving a DORA failure event.", - "properties": { - "data": { - "description": "Response after receiving a DORA failure event.", - "properties": { - "id": { - "description": "The ID of the received DORA failure event.", - "example": "4242fcdd31586083", - "type": "string" - }, - "type": { - "default": "dora_failure", - "description": "JSON:API type for DORA failure events.", - "enum": [ - "dora_failure" - ], - "example": "dora_failure", - "type": "string", - "x-enum-varnames": [ - "DORA_FAILURE" - ] - } - }, - "required": [ - "id" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "description": "OK - but delayed due to incident" - }, - "400": { + "403": { "content": { "application/json": { "schema": { @@ -417626,52 +425199,13 @@ "properties": { "errors": { "description": "A list of errors.", + "example": [ + "Bad Request" + ], "items": { - "description": "API error response body", - "properties": { - "detail": { - "description": "A human-readable explanation specific to this occurrence of the error.", - "example": "Missing required attribute in body", - "type": "string" - }, - "meta": { - "additionalProperties": {}, - "description": "Non-standard meta-information about the error", - "type": "object" - }, - "source": { - "description": "References to the source of the error.", - "properties": { - "header": { - "description": "A string indicating the name of a single request header which caused the error.", - "example": "Authorization", - "type": "string" - }, - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "limit", - "type": "string" - }, - "pointer": { - "description": "A JSON pointer to the value in the request document that caused the error.", - "example": "/data/attributes/title", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "Status code of the response.", - "example": "400", - "type": "string" - }, - "title": { - "description": "Short human-readable summary of the error.", - "example": "Bad Request", - "type": "string" - } - }, - "type": "object" + "description": "A list of items.", + "example": "Bad Request", + "type": "string" }, "type": "array" } @@ -417683,9 +425217,9 @@ } } }, - "description": "Bad Request" + "description": "Forbidden" }, - "403": { + "404": { "content": { "application/json": { "schema": { @@ -417711,7 +425245,7 @@ } } }, - "description": "Not Authorized" + "description": "Downtime not found" }, "429": { "content": { @@ -417744,32 +425278,42 @@ }, "security": [ { - "apiKeyAuth": [] + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "monitors_downtime" + ] } ], - "summary": "Send an incident event for DORA Metrics", + "summary": "Cancel a downtime", "tags": [ - "DORA Metrics" + "Downtimes" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 2, + "x-menu-order": 4, + "x-permission": { + "operator": "OR", + "permissions": [ + "monitors_downtime" + ] + }, "x-undo": { "type": "idempotent" } - } - }, - "/api/v2/downtime": { + }, "get": { - "description": "Get all scheduled downtimes.", - "operationId": "ListDowntimes", + "description": "Get downtime detail by `downtime_id`.", + "operationId": "GetDowntime", "parameters": [ { - "description": "Only return downtimes that are active when the request is made.", - "in": "query", - "name": "current_only", - "required": false, + "description": "ID of the downtime to fetch.", + "in": "path", + "name": "downtime_id", + "required": true, "schema": { - "type": "boolean" + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" } }, { @@ -417781,30 +425325,6 @@ "example": "created_by,monitor", "type": "string" } - }, - { - "description": "Specific offset to use as the beginning of the returned page.", - "in": "query", - "name": "page[offset]", - "required": false, - "schema": { - "default": 0, - "example": 0, - "format": "int64", - "type": "integer" - } - }, - { - "description": "Maximum number of downtimes in the response.", - "example": 100, - "in": "query", - "name": "page[limit]", - "required": false, - "schema": { - "default": 30, - "format": "int64", - "type": "integer" - } } ], "responses": { @@ -417812,345 +425332,341 @@ "content": { "application/json": { "schema": { - "description": "Response for retrieving all downtimes.", + "description": "Downtiming gives you greater control over monitor notifications by\nallowing you to globally exclude scopes from alerting.\nDowntime settings, which can be scheduled with start and end times,\nprevent all alerting related to specified Datadog tags.", "properties": { "data": { - "description": "An array of downtimes.", - "items": { - "description": "Downtime data.", - "properties": { - "attributes": { - "description": "Downtime details.", - "properties": { - "canceled": { - "description": "Time that the downtime was canceled.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "created": { - "description": "Creation time of the downtime.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", - "type": "string" - }, - "display_timezone": { - "default": "UTC", - "description": "The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.", - "example": "America/New_York", - "nullable": true, - "type": "string" - }, - "message": { - "description": "A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same `@username` notation as events.", - "example": "Message about the downtime", - "nullable": true, - "type": "string" - }, - "modified": { - "description": "Time that the downtime was last modified.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", - "type": "string" - }, - "monitor_identifier": { - "description": "Monitor identifier for the downtime.", - "oneOf": [ - { - "additionalProperties": {}, - "description": "Object of the monitor identifier.", - "properties": { - "monitor_id": { - "description": "ID of the monitor to prevent notifications.", - "example": 123, - "format": "int64", - "type": "integer" - } - }, - "required": [ - "monitor_id" - ], - "type": "object" + "description": "Downtime data.", + "properties": { + "attributes": { + "description": "Downtime details.", + "properties": { + "canceled": { + "description": "Time that the downtime was canceled.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "created": { + "description": "Creation time of the downtime.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "type": "string" + }, + "display_timezone": { + "default": "UTC", + "description": "The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.", + "example": "America/New_York", + "nullable": true, + "type": "string" + }, + "message": { + "description": "A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same `@username` notation as events.", + "example": "Message about the downtime", + "nullable": true, + "type": "string" + }, + "modified": { + "description": "Time that the downtime was last modified.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "type": "string" + }, + "monitor_identifier": { + "description": "Monitor identifier for the downtime.", + "oneOf": [ + { + "additionalProperties": {}, + "description": "Object of the monitor identifier.", + "properties": { + "monitor_id": { + "description": "ID of the monitor to prevent notifications.", + "example": 123, + "format": "int64", + "type": "integer" + } }, - { - "additionalProperties": {}, - "description": "Object of the monitor tags.", - "properties": { - "monitor_tags": { - "description": "A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`\nto `[*]` configures the downtime to mute all monitors for the given scope.", - "example": [ - "service:postgres", - "team:frontend" - ], - "items": { - "description": "A list of monitor tags.", - "example": "service:postgres", - "type": "string" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "monitor_tags" - ], - "type": "object" - } - ] - }, - "mute_first_recovery_notification": { - "description": "If the first recovery notification during a downtime should be muted.", - "example": false, - "type": "boolean" - }, - "notify_end_states": { - "description": "States that will trigger a monitor notification when the `notify_end_types` action occurs.", - "example": [ + "required": [ + "monitor_id" + ], + "type": "object" + }, + { + "additionalProperties": {}, + "description": "Object of the monitor tags.", + "properties": { + "monitor_tags": { + "description": "A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`\nto `[*]` configures the downtime to mute all monitors for the given scope.", + "example": [ + "service:postgres", + "team:frontend" + ], + "items": { + "description": "A list of monitor tags.", + "example": "service:postgres", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "monitor_tags" + ], + "type": "object" + } + ] + }, + "mute_first_recovery_notification": { + "description": "If the first recovery notification during a downtime should be muted.", + "example": false, + "type": "boolean" + }, + "notify_end_states": { + "description": "States that will trigger a monitor notification when the `notify_end_types` action occurs.", + "example": [ + "alert", + "warn" + ], + "items": { + "description": "State that will trigger a monitor notification when the `notify_end_types` action occurs.", + "enum": [ "alert", + "no data", "warn" ], - "items": { - "description": "State that will trigger a monitor notification when the `notify_end_types` action occurs.", - "enum": [ - "alert", - "no data", - "warn" - ], - "example": "alert", - "type": "string", - "x-enum-varnames": [ - "ALERT", - "NO_DATA", - "WARN" - ] - }, - "type": "array" + "example": "alert", + "type": "string", + "x-enum-varnames": [ + "ALERT", + "NO_DATA", + "WARN" + ] }, - "notify_end_types": { - "description": "Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", - "example": [ + "type": "array" + }, + "notify_end_types": { + "description": "Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", + "example": [ + "canceled", + "expired" + ], + "items": { + "description": "Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", + "enum": [ "canceled", "expired" ], - "items": { - "description": "Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", - "enum": [ - "canceled", - "expired" - ], - "example": "canceled", - "type": "string", - "x-enum-varnames": [ - "CANCELED", - "EXPIRED" - ] - }, - "type": "array" + "example": "canceled", + "type": "string", + "x-enum-varnames": [ + "CANCELED", + "EXPIRED" + ] }, - "schedule": { - "description": "The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.", - "oneOf": [ - { - "description": "A recurring downtime schedule definition.", - "properties": { - "current_downtime": { - "description": "The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.", + "type": "array" + }, + "schedule": { + "description": "The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.", + "oneOf": [ + { + "description": "A recurring downtime schedule definition.", + "properties": { + "current_downtime": { + "description": "The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.", + "properties": { + "end": { + "description": "The end of the current downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "start": { + "description": "The start of the current downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "recurrences": { + "description": "A list of downtime recurrences.", + "items": { + "description": "An RRULE-based recurring downtime.", "properties": { - "end": { - "description": "The end of the current downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "nullable": true, + "duration": { + "description": "The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.", + "example": "123d", + "type": "string" + }, + "rrule": { + "description": "The `RRULE` standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.\nMost common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.\n\n**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).\nMore examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).", + "example": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1", "type": "string" }, "start": { - "description": "The start of the current downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", + "description": "ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.", + "example": "2020-01-02T03:04", "type": "string" } }, "type": "object" }, - "recurrences": { - "description": "A list of downtime recurrences.", - "items": { - "description": "An RRULE-based recurring downtime.", - "properties": { - "duration": { - "description": "The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.", - "example": "123d", - "type": "string" - }, - "rrule": { - "description": "The `RRULE` standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.\nMost common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.\n\n**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).\nMore examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).", - "example": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1", - "type": "string" - }, - "start": { - "description": "ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.", - "example": "2020-01-02T03:04", - "type": "string" - } - }, - "type": "object" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "timezone": { - "default": "UTC", - "description": "The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match `display_timezone`.", - "example": "America/New_York", - "type": "string" - } + "maxItems": 5, + "minItems": 1, + "type": "array" }, - "required": [ - "recurrences" - ], - "type": "object" + "timezone": { + "default": "UTC", + "description": "The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match `display_timezone`.", + "example": "America/New_York", + "type": "string" + } }, - { - "description": "A one-time downtime definition.", - "properties": { - "end": { - "description": "ISO-8601 Datetime to end the downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "start": { - "description": "ISO-8601 Datetime to start the downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "type": "string" - } + "required": [ + "recurrences" + ], + "type": "object" + }, + { + "description": "A one-time downtime definition.", + "properties": { + "end": { + "description": "ISO-8601 Datetime to end the downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "nullable": true, + "type": "string" }, - "required": [ - "start" - ], - "type": "object" - } - ] - }, - "scope": { - "description": "The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).", - "example": "env:(staging OR prod) AND datacenter:us-east-1", - "type": "string" - }, - "status": { - "description": "The current status of the downtime.", - "enum": [ - "active", - "canceled", - "ended", - "scheduled" - ], - "example": "active", - "type": "string", - "x-enum-varnames": [ - "ACTIVE", - "CANCELED", - "ENDED", - "SCHEDULED" - ] - } + "start": { + "description": "ISO-8601 Datetime to start the downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "start" + ], + "type": "object" + } + ] }, - "type": "object" - }, - "id": { - "description": "The downtime ID.", - "example": "00000000-0000-1234-0000-000000000000", - "type": "string" + "scope": { + "description": "The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).", + "example": "env:(staging OR prod) AND datacenter:us-east-1", + "type": "string" + }, + "status": { + "description": "The current status of the downtime.", + "enum": [ + "active", + "canceled", + "ended", + "scheduled" + ], + "example": "active", + "type": "string", + "x-enum-varnames": [ + "ACTIVE", + "CANCELED", + "ENDED", + "SCHEDULED" + ] + } }, - "relationships": { - "description": "All relationships associated with downtime.", - "properties": { - "created_by": { - "description": "The user who created the downtime.", - "properties": { - "data": { - "description": "Data for the user who created the downtime.", - "nullable": true, - "properties": { - "id": { - "description": "User ID of the downtime creator.", - "example": "00000000-0000-1234-0000-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } + "type": "object" + }, + "id": { + "description": "The downtime ID.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, + "relationships": { + "description": "All relationships associated with downtime.", + "properties": { + "created_by": { + "description": "The user who created the downtime.", + "properties": { + "data": { + "description": "Data for the user who created the downtime.", + "nullable": true, + "properties": { + "id": { + "description": "User ID of the downtime creator.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" }, - "type": "object" - } - }, - "type": "object" + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + } }, - "monitor": { - "description": "The monitor identified by the downtime.", - "properties": { - "data": { - "description": "Data for the monitor.", - "nullable": true, - "properties": { - "id": { - "description": "Monitor ID of the downtime.", - "example": "12345", - "type": "string" - }, - "type": { - "default": "monitors", - "description": "Monitor resource type.", - "enum": [ - "monitors" - ], - "example": "monitors", - "type": "string", - "x-enum-varnames": [ - "MONITORS" - ] - } - }, - "type": "object" - } - }, - "type": "object" - } + "type": "object" }, - "type": "object" + "monitor": { + "description": "The monitor identified by the downtime.", + "properties": { + "data": { + "description": "Data for the monitor.", + "nullable": true, + "properties": { + "id": { + "description": "Monitor ID of the downtime.", + "example": "12345", + "type": "string" + }, + "type": { + "default": "monitors", + "description": "Monitor resource type.", + "enum": [ + "monitors" + ], + "example": "monitors", + "type": "string", + "x-enum-varnames": [ + "MONITORS" + ] + } + }, + "type": "object" + } + }, + "type": "object" + } }, - "type": { - "default": "downtime", - "description": "Downtime resource type.", - "enum": [ - "downtime" - ], - "example": "downtime", - "type": "string", - "x-enum-varnames": [ - "DOWNTIME" - ] - } + "type": "object" }, - "type": "object" + "type": { + "default": "downtime", + "description": "Downtime resource type.", + "enum": [ + "downtime" + ], + "example": "downtime", + "type": "string", + "x-enum-varnames": [ + "DOWNTIME" + ] + } }, - "type": "array" + "type": "object" }, "included": { - "description": "Array of objects related to the downtimes.", + "description": "Array of objects related to the downtime that the user requested.", "items": { "description": "An object related to a downtime.", "oneOf": [ @@ -418445,23 +425961,6 @@ ] }, "type": "array" - }, - "meta": { - "description": "Pagination metadata returned by the API.", - "properties": { - "page": { - "description": "Object containing the total filtered count.", - "properties": { - "total_filtered_count": { - "description": "Total count of elements matched by the filter.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - } - }, - "type": "object" } }, "type": "object" @@ -418470,6 +425969,34 @@ }, "description": "OK" }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, "403": { "content": { "application/json": { @@ -418498,6 +426025,34 @@ }, "description": "Forbidden" }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, "429": { "content": { "application/json": { @@ -418538,16 +426093,11 @@ ] } ], - "summary": "Get all downtimes", + "summary": "Get a downtime", "tags": [ "Downtimes" ], - "x-menu-order": 1, - "x-pagination": { - "limitParam": "page[limit]", - "pageOffsetParam": "page[offset]", - "resultsPath": "data" - }, + "x-menu-order": 5, "x-permission": { "operator": "OR", "permissions": [ @@ -418558,20 +426108,32 @@ "type": "safe" } }, - "post": { - "description": "Schedule a downtime.", - "operationId": "CreateDowntime", + "patch": { + "description": "Update a downtime by `downtime_id`.", + "operationId": "UpdateDowntime", + "parameters": [ + { + "description": "ID of the downtime to update.", + "in": "path", + "name": "downtime_id", + "required": true, + "schema": { + "example": "00e000000-0000-1234-0000-000000000000", + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "description": "Request for creating a downtime.", + "description": "Request for editing a downtime.", "properties": { "data": { - "description": "Object to create a downtime.", + "description": "Object to update a downtime.", "properties": { "attributes": { - "description": "Downtime details.", + "description": "Attributes of the downtime to update.", "properties": { "display_timezone": { "default": "UTC", @@ -418684,6 +426246,7 @@ "description": "Schedule for the downtime.", "oneOf": [ { + "additionalProperties": false, "description": "A recurring downtime schedule definition.", "properties": { "recurrences": { @@ -418724,9 +426287,6 @@ "type": "string" } }, - "required": [ - "recurrences" - ], "type": "object" }, { @@ -418758,12 +426318,13 @@ "type": "string" } }, - "required": [ - "scope", - "monitor_identifier" - ], "type": "object" }, + "id": { + "description": "ID of this downtime.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, "type": { "default": "downtime", "description": "Downtime resource type.", @@ -418778,6 +426339,7 @@ } }, "required": [ + "id", "type", "attributes" ], @@ -418791,7 +426353,7 @@ } } }, - "description": "Schedule a downtime request body.", + "description": "Update a downtime request body.", "required": true }, "responses": { @@ -419188,45 +426750,1187 @@ "type": "string" }, "title": { - "description": "Title of the user.", - "nullable": true, + "description": "Title of the user.", + "nullable": true, + "type": "string" + }, + "verified": { + "description": "Whether the user is verified.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the user.", + "type": "string" + }, + "relationships": { + "description": "Relationships of the user object returned by the API.", + "properties": { + "org": { + "description": "Relationship to an organization.", + "properties": { + "data": { + "description": "Relationship to organization object.", + "properties": { + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", + "type": "string" + }, + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "other_orgs": { + "description": "Relationship to organizations.", + "properties": { + "data": { + "description": "Relationships to organization objects.", + "example": [], + "items": { + "description": "Relationship to organization object.", + "properties": { + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", + "type": "string" + }, + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "other_users": { + "description": "Relationship to users.", + "properties": { + "data": { + "description": "Relationships to user objects.", + "example": [], + "items": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "roles": { + "description": "Relationship to roles.", + "properties": { + "data": { + "description": "An array containing type and the unique identifier of a role.", + "items": { + "description": "Relationship to role object.", + "properties": { + "id": { + "description": "The unique identifier of the role.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" + }, + "type": { + "default": "roles", + "description": "Roles type.", + "enum": [ + "roles" + ], + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "properties": false + } + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + { + "description": "Information about the monitor identified by the downtime.", + "properties": { + "attributes": { + "description": "Attributes of the monitor identified by the downtime.", + "properties": { + "name": { + "description": "The name of the monitor identified by the downtime.", + "example": "A monitor name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the monitor identified by the downtime.", + "example": 12345, + "format": "int64", + "type": "integer" + }, + "type": { + "default": "monitors", + "description": "Monitor resource type.", + "enum": [ + "monitors" + ], + "example": "monitors", + "type": "string", + "x-enum-varnames": [ + "MONITORS" + ] + } + }, + "type": "object" + } + ] + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Downtime not found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "monitors_downtime" + ] + } + ], + "summary": "Update a downtime", + "tags": [ + "Downtimes" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 6, + "x-permission": { + "operator": "OR", + "permissions": [ + "monitors_downtime" + ] + }, + "x-undo": { + "type": "idempotent" + } + } + }, + "/api/v2/error-tracking/issues/search": { + "post": { + "description": "Search issues endpoint allows you to programmatically search for issues within your organization. This endpoint returns a list of issues that match a given search query, following the event search syntax. The search results are limited to a maximum of 100 issues per request.", + "operationId": "SearchIssues", + "parameters": [ + { + "description": "Comma-separated list of relationship objects that should be included in the response.", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "description": "Relationship object that should be included in the search response.", + "enum": [ + "issue", + "issue.assignee", + "issue.case", + "issue.team_owners" + ], + "example": "issue.case", + "type": "string", + "x-enum-varnames": [ + "ISSUE", + "ISSUE_ASSIGNEE", + "ISSUE_CASE", + "ISSUE_TEAM_OWNERS" + ] + }, + "type": "array" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Search issues request payload.", + "properties": { + "data": { + "description": "Search issues request.", + "properties": { + "attributes": { + "description": "Object describing a search issue request.", + "properties": { + "from": { + "description": "Start date (inclusive) of the query in milliseconds since the Unix epoch.", + "example": 1671612804000, + "format": "int64", + "type": "integer" + }, + "order_by": { + "description": "The attribute to sort the search results by.", + "enum": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ], + "example": "IMPACTED_SESSIONS", + "type": "string", + "x-enum-varnames": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ] + }, + "persona": { + "description": "Persona for the search. Either track(s) or persona(s) must be specified.", + "enum": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ] + }, + "query": { + "description": "Search query following the event search syntax.", + "example": "service:orders-* AND @language:go", + "type": "string" + }, + "to": { + "description": "End date (exclusive) of the query in milliseconds since the Unix epoch.", + "example": 1671620004000, + "format": "int64", + "type": "integer" + }, + "track": { + "description": "Track of the events to query. Either track(s) or persona(s) must be specified.", + "enum": [ + "trace", + "logs", + "rum" + ], + "example": "trace", + "type": "string", + "x-enum-varnames": [ + "TRACE", + "LOGS", + "RUM" + ] + } + }, + "required": [ + "query", + "from", + "to" + ], + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "search_request" + ], + "example": "search_request", + "type": "string", + "x-enum-varnames": [ + "SEARCH_REQUEST" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Search issues request payload.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Search issues response payload.", + "properties": { + "data": { + "description": "Array of results matching the search query.", + "items": { + "description": "Result matching the search query.", + "properties": { + "attributes": { + "description": "Object containing the information of a search result.", + "properties": { + "impacted_sessions": { + "description": "Count of sessions impacted by the issue over the queried time window.", + "example": 12, + "format": "int64", + "type": "integer" + }, + "impacted_users": { + "description": "Count of users impacted by the issue over the queried time window.", + "example": 4, + "format": "int64", + "type": "integer" + }, + "total_count": { + "description": "Total count of errors that match the issue over the queried time window.", + "example": 82, + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "Search result identifier (matches the nested issue's identifier).", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "relationships": { + "description": "Relationships between the search result and other resources.", + "properties": { + "issue": { + "description": "Relationship between the search result and the corresponding issue.", + "properties": { + "data": { + "description": "The issue the search result corresponds to.", + "properties": { + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "error_tracking_search_result" + ], + "example": "error_tracking_search_result", + "type": "string", + "x-enum-varnames": [ + "ERROR_TRACKING_SEARCH_RESULT" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Array of resources related to the search results.", + "items": { + "description": "An array of related resources, returned when the `include` query parameter is used.", + "oneOf": [ + { + "description": "The issue matching the request.", + "properties": { + "attributes": { + "description": "Object containing the information of an issue.", + "properties": { + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", + "type": "string" + }, + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", + "type": "string" + }, + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", + "type": "string" + }, + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" + }, + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", + "type": "string" + }, + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" + }, + "is_crash": { + "description": "Error is a crash.", + "example": false, + "type": "boolean" + }, + "languages": { + "description": "Array of programming languages associated with the issue.", + "example": [ + "PYTHON", + "GO" + ], + "items": { + "description": "Programming language associated with the issue.", + "enum": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ], + "example": "PYTHON", + "type": "string", + "x-enum-varnames": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ] + }, + "type": "array" + }, + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" + }, + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ] + }, + "service": { + "description": "Service name.", + "example": "email-api-py", + "type": "string" + }, + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "type": "object" + }, + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "relationships": { + "description": "Relationship between the issue and an assignee, case and/or teams.", + "properties": { + "assignee": { + "description": "Relationship between the issue and assignee.", + "properties": { + "data": { + "description": "The user the issue is assigned to.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "case": { + "description": "Relationship between the issue and case.", + "properties": { + "data": { + "description": "The case the issue is attached to.", + "properties": { + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A case", + "properties": { + "attributes": { + "description": "Case resource attributes", + "properties": { + "archived_at": { + "description": "Timestamp of when the case was archived", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "attributes": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, + "description": "The definition of `CaseObjectAttributes` object.", + "type": "object" + }, + "closed_at": { + "description": "Timestamp of when the case was closed", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "created_at": { + "description": "Timestamp of when the case was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description", + "type": "string" + }, + "jira_issue": { + "description": "Jira issue attached to case", + "nullable": true, + "properties": { + "result": { + "description": "Jira issue information", + "properties": { + "issue_id": { + "description": "Jira issue ID", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL", + "type": "string" + }, + "project_key": { + "description": "Jira project key", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "default": "IN_PROGRESS", + "description": "Case status", + "enum": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ], + "example": "COMPLETED", + "readOnly": true, + "type": "string", + "x-enum-varnames": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + } + }, + "readOnly": true, + "type": "object" + }, + "key": { + "description": "Key", + "example": "CASEM-4523", + "type": "string" + }, + "modified_at": { + "description": "Timestamp of when the case was last modified", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] + }, + "service_now_ticket": { + "description": "ServiceNow ticket attached to case", + "nullable": true, + "properties": { + "result": { + "description": "ServiceNow ticket information", + "properties": { + "sys_target_link": { + "description": "Link to the Incident created on ServiceNow", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "default": "IN_PROGRESS", + "description": "Case status", + "enum": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ], + "example": "COMPLETED", + "readOnly": true, + "type": "string", + "x-enum-varnames": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + } + }, + "readOnly": true, + "type": "object" + }, + "status": { + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ], + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] + }, + "title": { + "description": "Title", + "example": "Memory leak investigation on API", "type": "string" }, - "verified": { - "description": "Whether the user is verified.", - "type": "boolean" + "type": { + "description": "Case type", + "enum": [ + "STANDARD" + ], + "example": "STANDARD", + "type": "string", + "x-enum-varnames": [ + "STANDARD" + ] } }, "type": "object" }, "id": { - "description": "ID of the user.", + "description": "Case's identifier", + "example": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", "type": "string" }, "relationships": { - "description": "Relationships of the user object returned by the API.", + "description": "Resources related to a case", "properties": { - "org": { - "description": "Relationship to an organization.", + "assignee": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationship to organization object.", + "description": "Relationship to user object.", + "nullable": true, "properties": { "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" }, "type": { - "default": "orgs", - "description": "Organizations resource type.", + "default": "user", + "description": "User resource type.", "enum": [ - "orgs" + "user" ], - "example": "orgs", + "example": "user", "type": "string", "x-enum-varnames": [ - "ORGS" + "USER" ] } }, @@ -419242,40 +427946,37 @@ ], "type": "object" }, - "other_orgs": { - "description": "Relationship to organizations.", + "created_by": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationships to organization objects.", - "example": [], - "items": { - "description": "Relationship to organization object.", - "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", - "type": "string" - }, - "type": { - "default": "orgs", - "description": "Organizations resource type.", - "enum": [ - "orgs" - ], - "example": "orgs", - "type": "string", - "x-enum-varnames": [ - "ORGS" - ] - } + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object" + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, "required": [ @@ -419283,43 +427984,37 @@ ], "type": "object" }, - "other_users": { - "description": "Relationship to users.", + "modified_by": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationships to user objects.", - "example": [], - "items": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, "required": [ @@ -419327,102 +428022,159 @@ ], "type": "object" }, - "roles": { - "description": "Relationship to roles.", + "project": { + "description": "Relationship to project", "properties": { "data": { - "description": "An array containing type and the unique identifier of a role.", - "items": { - "description": "Relationship to role object.", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" - }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" }, - "type": "object", - "x-merge-override": { - "required": false + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "data" + ], + "type": "object" } }, - "type": "object", - "x-merge-override": { - "properties": false - } + "type": "object" }, "type": { - "default": "users", - "description": "Users resource type.", + "default": "case", + "description": "Case resource type", "enum": [ - "users" + "case" ], - "example": "users", + "example": "case", "type": "string", "x-enum-varnames": [ - "USERS" + "CASE" ] } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" }, { - "description": "Information about the monitor identified by the downtime.", + "description": "The user to whom the issue is assigned.", "properties": { "attributes": { - "description": "Attributes of the monitor identified by the downtime.", + "description": "Object containing the information of a user.", "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, "name": { - "description": "The name of the monitor identified by the downtime.", - "example": "A monitor name", + "description": "Name of the user.", + "example": "User Name", "type": "string" } }, "type": "object" }, "id": { - "description": "ID of the monitor identified by the downtime.", - "example": 12345, - "format": "int64", - "type": "integer" + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" }, "type": { - "default": "monitors", - "description": "Monitor resource type.", + "description": "Type of the object", "enum": [ - "monitors" + "user" ], - "example": "monitors", + "example": "user", "type": "string", "x-enum-varnames": [ - "MONITORS" + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" ] } }, + "required": [ + "id", + "type", + "attributes" + ], "type": "object" } ] @@ -419464,35 +428216,7 @@ }, "description": "Bad Request" }, - "403": { - "content": { - "application/json": { - "schema": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", - "example": [ - "Bad Request" - ], - "items": { - "description": "A list of items.", - "example": "Bad Request", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden" - }, - "429": { + "401": { "content": { "application/json": { "schema": { @@ -419518,74 +428242,7 @@ } } }, - "description": "Too many requests" - } - }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "monitors_downtime" - ] - } - ], - "summary": "Schedule a downtime", - "tags": [ - "Downtimes" - ], - "x-codegen-request-body-name": "body", - "x-given": { - "downtime_v2": { - "parameters": [ - { - "name": "body", - "value": "{\n \"data\": {\n \"attributes\": {\n \"message\": \"test message\",\n \"monitor_identifier\": {\n \"monitor_tags\": [\"cat:hat\"]\n },\n \"scope\": \"test:{{ unique_lower_alnum }}\",\n \"schedule\": {\n \"start\": null\n }\n },\n \"type\": \"downtime\"\n }\n}" - } - ], - "step": "there is a valid \"downtime_v2\" in the system" - } - }, - "x-menu-order": 2, - "x-permission": { - "operator": "OR", - "permissions": [ - "monitors_downtime" - ] - }, - "x-undo": { - "operationId": "CancelDowntime", - "parameters": [ - { - "name": "downtime_id", - "source": "data.id" - } - ], - "type": "unsafe" - } - } - }, - "/api/v2/downtime/{downtime_id}": { - "delete": { - "description": "Cancel a downtime.\n\n**Note**: Downtimes canceled through the API are no longer active, but are retained for approximately two days before being permanently removed. The downtime may still appear in search results until it is permanently removed.", - "operationId": "CancelDowntime", - "parameters": [ - { - "description": "ID of the downtime to cancel.", - "in": "path", - "name": "downtime_id", - "required": true, - "schema": { - "example": "00000000-0000-1234-0000-000000000000", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "OK" + "description": "Unauthorized" }, "403": { "content": { @@ -419615,34 +428272,6 @@ }, "description": "Forbidden" }, - "404": { - "content": { - "application/json": { - "schema": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", - "example": [ - "Bad Request" - ], - "items": { - "description": "A list of items.", - "example": "Bad Request", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - } - } - }, - "description": "Downtime not found" - }, "429": { "content": { "application/json": { @@ -419679,47 +428308,70 @@ }, { "AuthZ": [ - "monitors_downtime" + "error_tracking_read" ] } ], - "summary": "Cancel a downtime", + "summary": "Search error tracking issues", "tags": [ - "Downtimes" + "Error Tracking" ], - "x-menu-order": 4, - "x-permission": { - "operator": "OR", - "permissions": [ - "monitors_downtime" - ] + "x-given": { + "issue": { + "parameters": [ + { + "name": "body", + "value": "{\n \"data\": {\n \"attributes\": {\n \"query\": \"service:synthetics-browser\",\n \"from\": {{ timestamp(\"now - 15d\") }}000,\n \"to\": {{ timestamp(\"now\") }}000,\n \"track\": \"rum\"\n },\n \"type\": \"search_request\"\n }\n}" + } + ], + "source": "data[0]", + "step": "there is a valid \"issue\" in the system" + } }, + "x-menu-order": 1, "x-undo": { - "type": "idempotent" + "type": "safe" } - }, + } + }, + "/api/v2/error-tracking/issues/{issue_id}": { "get": { - "description": "Get downtime detail by `downtime_id`.", - "operationId": "GetDowntime", + "description": "Retrieve the full details for a specific error tracking issue, including attributes and relationships.", + "operationId": "GetIssue", "parameters": [ { - "description": "ID of the downtime to fetch.", + "description": "The identifier of the issue.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", "in": "path", - "name": "downtime_id", + "name": "issue_id", "required": true, "schema": { - "example": "00000000-0000-1234-0000-000000000000", "type": "string" } }, { - "description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`.", + "description": "Comma-separated list of relationship objects that should be included in the response.", + "explode": false, "in": "query", "name": "include", "required": false, "schema": { - "example": "created_by,monitor", - "type": "string" + "items": { + "description": "Relationship object that should be included in the response.", + "enum": [ + "assignee", + "case", + "team_owners" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "ASSIGNEE", + "CASE", + "TEAM_OWNERS" + ] + }, + "type": "array" } } ], @@ -419728,434 +428380,520 @@ "content": { "application/json": { "schema": { - "description": "Downtiming gives you greater control over monitor notifications by\nallowing you to globally exclude scopes from alerting.\nDowntime settings, which can be scheduled with start and end times,\nprevent all alerting related to specified Datadog tags.", + "description": "Response containing error tracking issue data.", "properties": { "data": { - "description": "Downtime data.", + "description": "The issue matching the request.", "properties": { "attributes": { - "description": "Downtime details.", + "description": "Object containing the information of an issue.", "properties": { - "canceled": { - "description": "Time that the downtime was canceled.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", - "nullable": true, + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", "type": "string" }, - "created": { - "description": "Creation time of the downtime.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", "type": "string" }, - "display_timezone": { - "default": "UTC", - "description": "The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.", - "example": "America/New_York", - "nullable": true, + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", "type": "string" }, - "message": { - "description": "A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same `@username` notation as events.", - "example": "Message about the downtime", - "nullable": true, - "type": "string" + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" }, - "modified": { - "description": "Time that the downtime was last modified.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", "type": "string" }, - "monitor_identifier": { - "description": "Monitor identifier for the downtime.", - "oneOf": [ - { - "additionalProperties": {}, - "description": "Object of the monitor identifier.", - "properties": { - "monitor_id": { - "description": "ID of the monitor to prevent notifications.", - "example": 123, - "format": "int64", - "type": "integer" - } - }, - "required": [ - "monitor_id" - ], - "type": "object" - }, - { - "additionalProperties": {}, - "description": "Object of the monitor tags.", - "properties": { - "monitor_tags": { - "description": "A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`\nto `[*]` configures the downtime to mute all monitors for the given scope.", - "example": [ - "service:postgres", - "team:frontend" - ], - "items": { - "description": "A list of monitor tags.", - "example": "service:postgres", - "type": "string" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "monitor_tags" - ], - "type": "object" - } - ] + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" }, - "mute_first_recovery_notification": { - "description": "If the first recovery notification during a downtime should be muted.", + "is_crash": { + "description": "Error is a crash.", "example": false, "type": "boolean" }, - "notify_end_states": { - "description": "States that will trigger a monitor notification when the `notify_end_types` action occurs.", + "languages": { + "description": "Array of programming languages associated with the issue.", "example": [ - "alert", - "warn" + "PYTHON", + "GO" ], "items": { - "description": "State that will trigger a monitor notification when the `notify_end_types` action occurs.", + "description": "Programming language associated with the issue.", "enum": [ - "alert", - "no data", - "warn" + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" ], - "example": "alert", + "example": "PYTHON", "type": "string", "x-enum-varnames": [ - "ALERT", - "NO_DATA", - "WARN" + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" ] }, "type": "array" }, - "notify_end_types": { - "description": "Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", - "example": [ - "canceled", - "expired" - ], - "items": { - "description": "Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", - "enum": [ - "canceled", - "expired" - ], - "example": "canceled", - "type": "string", - "x-enum-varnames": [ - "CANCELED", - "EXPIRED" - ] - }, - "type": "array" + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" }, - "schedule": { - "description": "The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.", - "oneOf": [ - { - "description": "A recurring downtime schedule definition.", - "properties": { - "current_downtime": { - "description": "The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.", - "properties": { - "end": { - "description": "The end of the current downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "start": { - "description": "The start of the current downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "recurrences": { - "description": "A list of downtime recurrences.", - "items": { - "description": "An RRULE-based recurring downtime.", - "properties": { - "duration": { - "description": "The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.", - "example": "123d", - "type": "string" - }, - "rrule": { - "description": "The `RRULE` standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.\nMost common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.\n\n**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).\nMore examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).", - "example": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1", - "type": "string" - }, - "start": { - "description": "ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.", - "example": "2020-01-02T03:04", - "type": "string" - } - }, - "type": "object" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "timezone": { - "default": "UTC", - "description": "The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match `display_timezone`.", - "example": "America/New_York", - "type": "string" - } - }, - "required": [ - "recurrences" - ], - "type": "object" - }, - { - "description": "A one-time downtime definition.", - "properties": { - "end": { - "description": "ISO-8601 Datetime to end the downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "start": { - "description": "ISO-8601 Datetime to start the downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "type": "string" - } - }, - "required": [ - "start" - ], - "type": "object" - } + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" ] }, - "scope": { - "description": "The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).", - "example": "env:(staging OR prod) AND datacenter:us-east-1", + "service": { + "description": "Service name.", + "example": "email-api-py", "type": "string" }, - "status": { - "description": "The current status of the downtime.", + "state": { + "description": "State of the issue", "enum": [ - "active", - "canceled", - "ended", - "scheduled" + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" ], - "example": "active", + "example": "RESOLVED", "type": "string", "x-enum-varnames": [ - "ACTIVE", - "CANCELED", - "ENDED", - "SCHEDULED" + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" ] } }, "type": "object" }, "id": { - "description": "The downtime ID.", - "example": "00000000-0000-1234-0000-000000000000", + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", "type": "string" }, "relationships": { - "description": "All relationships associated with downtime.", + "description": "Relationship between the issue and an assignee, case and/or teams.", "properties": { - "created_by": { - "description": "The user who created the downtime.", + "assignee": { + "description": "Relationship between the issue and assignee.", "properties": { "data": { - "description": "Data for the user who created the downtime.", - "nullable": true, + "description": "The user the issue is assigned to.", "properties": { "id": { - "description": "User ID of the downtime creator.", - "example": "00000000-0000-1234-0000-000000000000", + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", "type": "string" }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "Type of the object", "enum": [ - "users" + "user" ], - "example": "users", + "example": "user", "type": "string", "x-enum-varnames": [ - "USERS" + "USER" ] } }, + "required": [ + "id", + "type" + ], "type": "object" } }, + "required": [ + "data" + ], "type": "object" }, - "monitor": { - "description": "The monitor identified by the downtime.", + "case": { + "description": "Relationship between the issue and case.", "properties": { "data": { - "description": "Data for the monitor.", - "nullable": true, + "description": "The case the issue is attached to.", "properties": { "id": { - "description": "Monitor ID of the downtime.", - "example": "12345", + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, "type": { - "default": "monitors", - "description": "Monitor resource type.", + "description": "Type of the object.", "enum": [ - "monitors" + "case" ], - "example": "monitors", + "example": "case", "type": "string", "x-enum-varnames": [ - "MONITORS" + "CASE" ] } }, + "required": [ + "id", + "type" + ], "type": "object" } }, + "required": [ + "data" + ], + "type": "object" + }, + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], "type": "object" } }, "type": "object" }, "type": { - "default": "downtime", - "description": "Downtime resource type.", + "description": "Type of the object.", "enum": [ - "downtime" + "issue" ], - "example": "downtime", + "example": "issue", "type": "string", "x-enum-varnames": [ - "DOWNTIME" + "ISSUE" ] } }, + "required": [ + "id", + "type", + "attributes" + ], "type": "object" }, "included": { - "description": "Array of objects related to the downtime that the user requested.", + "description": "Array of resources related to the issue.", "items": { - "description": "An object related to a downtime.", + "description": "An array of related resources, returned when the `include` query parameter is used.", "oneOf": [ { - "description": "User object returned by the API.", + "description": "The case attached to the issue.", "properties": { "attributes": { - "description": "Attributes of user object returned by the API.", + "description": "Object containing the information of a case.", "properties": { - "created_at": { - "description": "Creation time of the user.", + "archived_at": { + "description": "Timestamp of when the case was archived.", + "example": "2025-01-01T00:00:00Z", "format": "date-time", "type": "string" }, - "disabled": { - "description": "Whether the user is disabled.", - "type": "boolean" + "closed_at": { + "description": "Timestamp of when the case was closed.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" }, - "email": { - "description": "Email of the user.", + "created_at": { + "description": "Timestamp of when the case was created.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", "type": "string" }, - "handle": { - "description": "Handle of the user.", + "creation_source": { + "description": "Source of the case creation.", + "example": "ERROR_TRACKING", "type": "string" }, - "icon": { - "description": "URL of the user's icon.", + "description": { + "description": "Description of the case.", "type": "string" }, - "mfa_enabled": { - "description": "If user has MFA enabled.", - "readOnly": true, - "type": "boolean" + "due_date": { + "description": "Due date of the case.", + "example": "2025-01-01", + "type": "string" }, - "modified_at": { - "description": "Time that the user was last modified.", - "format": "date-time", + "insights": { + "description": "Insights of the case.", + "items": { + "description": "Insight of the case.", + "properties": { + "ref": { + "description": "Reference of the insight.", + "example": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "resource_id": { + "description": "Insight identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the insight.", + "example": "ERROR_TRACKING", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "jira_issue": { + "description": "Jira issue of the case.", + "properties": { + "result": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", + "properties": { + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", + "type": "string" + }, + "project_key": { + "description": "Jira project key.", + "example": "ET", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Creation status of the Jira issue.", + "example": "COMPLETED", + "type": "string" + } + }, + "type": "object" + }, + "key": { + "description": "Key of the case.", + "example": "ET-123", "type": "string" }, - "name": { - "description": "Name of the user.", - "nullable": true, + "modified_at": { + "description": "Timestamp of when the case was last modified.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", "type": "string" }, - "service_account": { - "description": "Whether the user is a service account.", - "type": "boolean" + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] }, "status": { - "description": "Status of the user.", - "type": "string" + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ], + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] }, "title": { - "description": "Title of the user.", - "nullable": true, + "description": "Title of the case.", + "example": "Error: HTTP error", "type": "string" }, - "verified": { - "description": "Whether the user is verified.", - "type": "boolean" + "type": { + "description": "Type of the case.", + "example": "ERROR_TRACKING_ISSUE", + "type": "string" } }, "type": "object" }, "id": { - "description": "ID of the user.", + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, "relationships": { - "description": "Relationships of the user object returned by the API.", + "description": "Resources related to a case.", "properties": { - "org": { - "description": "Relationship to an organization.", + "assignee": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationship to organization object.", + "description": "Relationship to user object.", + "nullable": true, "properties": { "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" }, "type": { - "default": "orgs", - "description": "Organizations resource type.", + "default": "user", + "description": "User resource type.", "enum": [ - "orgs" + "user" ], - "example": "orgs", + "example": "user", "type": "string", "x-enum-varnames": [ - "ORGS" + "USER" ] } }, @@ -420171,40 +428909,37 @@ ], "type": "object" }, - "other_orgs": { - "description": "Relationship to organizations.", + "created_by": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationships to organization objects.", - "example": [], - "items": { - "description": "Relationship to organization object.", - "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", - "type": "string" - }, - "type": { - "default": "orgs", - "description": "Organizations resource type.", - "enum": [ - "orgs" - ], - "example": "orgs", - "type": "string", - "x-enum-varnames": [ - "ORGS" - ] - } + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object" + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, "required": [ @@ -420212,43 +428947,37 @@ ], "type": "object" }, - "other_users": { - "description": "Relationship to users.", + "modified_by": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationships to user objects.", - "example": [], - "items": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, "required": [ @@ -420256,102 +428985,158 @@ ], "type": "object" }, - "roles": { - "description": "Relationship to roles.", + "project": { + "description": "Relationship to project", "properties": { "data": { - "description": "An array containing type and the unique identifier of a role.", - "items": { - "description": "Relationship to role object.", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" - }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" }, - "type": "object", - "x-merge-override": { - "required": false + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "data" + ], + "type": "object" } }, - "type": "object", - "x-merge-override": { - "properties": false - } + "type": "object" }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "Type of the object.", "enum": [ - "users" + "case" ], - "example": "users", + "example": "case", "type": "string", "x-enum-varnames": [ - "USERS" + "CASE" ] } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" }, { - "description": "Information about the monitor identified by the downtime.", + "description": "The user to whom the issue is assigned.", "properties": { "attributes": { - "description": "Attributes of the monitor identified by the downtime.", + "description": "Object containing the information of a user.", "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, "name": { - "description": "The name of the monitor identified by the downtime.", - "example": "A monitor name", + "description": "Name of the user.", + "example": "User Name", "type": "string" } }, "type": "object" }, "id": { - "description": "ID of the monitor identified by the downtime.", - "example": 12345, - "format": "int64", - "type": "integer" + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" }, "type": { - "default": "monitors", - "description": "Monitor resource type.", + "description": "Type of the object", "enum": [ - "monitors" + "user" ], - "example": "monitors", + "example": "user", "type": "string", "x-enum-varnames": [ - "MONITORS" + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" ] } }, + "required": [ + "id", + "type", + "attributes" + ], "type": "object" } ] @@ -420393,6 +429178,34 @@ }, "description": "Bad Request" }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, "403": { "content": { "application/json": { @@ -420485,36 +429298,32 @@ }, { "AuthZ": [ - "monitors_downtime" + "error_tracking_read" ] } ], - "summary": "Get a downtime", + "summary": "Get the details of an error tracking issue", "tags": [ - "Downtimes" + "Error Tracking" ], - "x-menu-order": 5, - "x-permission": { - "operator": "OR", - "permissions": [ - "monitors_downtime" - ] - }, + "x-menu-order": 2, "x-undo": { "type": "safe" } - }, - "patch": { - "description": "Update a downtime by `downtime_id`.", - "operationId": "UpdateDowntime", + } + }, + "/api/v2/error-tracking/issues/{issue_id}/assignee": { + "put": { + "description": "Update the assignee of an issue by `issue_id`.", + "operationId": "UpdateIssueAssignee", "parameters": [ { - "description": "ID of the downtime to update.", + "description": "The identifier of the issue.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", "in": "path", - "name": "downtime_id", + "name": "issue_id", "required": true, "schema": { - "example": "00e000000-0000-1234-0000-000000000000", "type": "string" } } @@ -420523,221 +429332,31 @@ "content": { "application/json": { "schema": { - "description": "Request for editing a downtime.", + "description": "Update issue assignee request payload.", "properties": { "data": { - "description": "Object to update a downtime.", + "description": "Update issue assignee request.", "properties": { - "attributes": { - "description": "Attributes of the downtime to update.", - "properties": { - "display_timezone": { - "default": "UTC", - "description": "The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.", - "example": "America/New_York", - "nullable": true, - "type": "string" - }, - "message": { - "description": "A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same `@username` notation as events.", - "example": "Message about the downtime", - "nullable": true, - "type": "string" - }, - "monitor_identifier": { - "description": "Monitor identifier for the downtime.", - "oneOf": [ - { - "additionalProperties": {}, - "description": "Object of the monitor identifier.", - "properties": { - "monitor_id": { - "description": "ID of the monitor to prevent notifications.", - "example": 123, - "format": "int64", - "type": "integer" - } - }, - "required": [ - "monitor_id" - ], - "type": "object" - }, - { - "additionalProperties": {}, - "description": "Object of the monitor tags.", - "properties": { - "monitor_tags": { - "description": "A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`\nto `[*]` configures the downtime to mute all monitors for the given scope.", - "example": [ - "service:postgres", - "team:frontend" - ], - "items": { - "description": "A list of monitor tags.", - "example": "service:postgres", - "type": "string" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "monitor_tags" - ], - "type": "object" - } - ] - }, - "mute_first_recovery_notification": { - "description": "If the first recovery notification during a downtime should be muted.", - "example": false, - "type": "boolean" - }, - "notify_end_states": { - "description": "States that will trigger a monitor notification when the `notify_end_types` action occurs.", - "example": [ - "alert", - "warn" - ], - "items": { - "description": "State that will trigger a monitor notification when the `notify_end_types` action occurs.", - "enum": [ - "alert", - "no data", - "warn" - ], - "example": "alert", - "type": "string", - "x-enum-varnames": [ - "ALERT", - "NO_DATA", - "WARN" - ] - }, - "type": "array" - }, - "notify_end_types": { - "description": "Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", - "example": [ - "canceled", - "expired" - ], - "items": { - "description": "Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", - "enum": [ - "canceled", - "expired" - ], - "example": "canceled", - "type": "string", - "x-enum-varnames": [ - "CANCELED", - "EXPIRED" - ] - }, - "type": "array" - }, - "schedule": { - "description": "Schedule for the downtime.", - "oneOf": [ - { - "additionalProperties": false, - "description": "A recurring downtime schedule definition.", - "properties": { - "recurrences": { - "description": "A list of downtime recurrences.", - "items": { - "additionalProperties": {}, - "description": "An object defining the recurrence of the downtime.", - "properties": { - "duration": { - "description": "The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.", - "example": "123d", - "type": "string" - }, - "rrule": { - "description": "The `RRULE` standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.\nMost common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.\n\n**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).\nMore examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).", - "example": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1", - "type": "string" - }, - "start": { - "description": "ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.", - "example": "2020-01-02T03:04", - "nullable": true, - "type": "string" - } - }, - "required": [ - "duration", - "rrule" - ], - "type": "object" - }, - "type": "array" - }, - "timezone": { - "default": "UTC", - "description": "The timezone in which to schedule the downtime.", - "example": "America/New_York", - "type": "string" - } - }, - "type": "object" - }, - { - "additionalProperties": false, - "description": "A one-time downtime definition.", - "properties": { - "end": { - "description": "ISO-8601 Datetime to end the downtime. Must include a UTC offset of zero. If not provided, the\ndowntime continues forever.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "start": { - "description": "ISO-8601 Datetime to start the downtime. Must include a UTC offset of zero. If not provided, the\ndowntime starts the moment it is created.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - } - }, - "type": "object" - } - ] - }, - "scope": { - "description": "The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).", - "example": "env:(staging OR prod) AND datacenter:us-east-1", - "type": "string" - } - }, - "type": "object" - }, "id": { - "description": "ID of this downtime.", - "example": "00000000-0000-1234-0000-000000000000", + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", "type": "string" }, "type": { - "default": "downtime", - "description": "Downtime resource type.", + "description": "Type of the object.", "enum": [ - "downtime" + "assignee" ], - "example": "downtime", + "example": "assignee", "type": "string", "x-enum-varnames": [ - "DOWNTIME" + "ASSIGNEE" ] } }, "required": [ "id", - "type", - "attributes" + "type" ], "type": "object" } @@ -420749,7 +429368,7 @@ } } }, - "description": "Update a downtime request body.", + "description": "Update issue assignee request payload.", "required": true }, "responses": { @@ -420757,434 +429376,520 @@ "content": { "application/json": { "schema": { - "description": "Downtiming gives you greater control over monitor notifications by\nallowing you to globally exclude scopes from alerting.\nDowntime settings, which can be scheduled with start and end times,\nprevent all alerting related to specified Datadog tags.", + "description": "Response containing error tracking issue data.", "properties": { "data": { - "description": "Downtime data.", + "description": "The issue matching the request.", "properties": { "attributes": { - "description": "Downtime details.", + "description": "Object containing the information of an issue.", "properties": { - "canceled": { - "description": "Time that the downtime was canceled.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", - "nullable": true, + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", "type": "string" }, - "created": { - "description": "Creation time of the downtime.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", "type": "string" }, - "display_timezone": { - "default": "UTC", - "description": "The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.", - "example": "America/New_York", - "nullable": true, + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", "type": "string" }, - "message": { - "description": "A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same `@username` notation as events.", - "example": "Message about the downtime", - "nullable": true, - "type": "string" + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" }, - "modified": { - "description": "Time that the downtime was last modified.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", "type": "string" }, - "monitor_identifier": { - "description": "Monitor identifier for the downtime.", - "oneOf": [ - { - "additionalProperties": {}, - "description": "Object of the monitor identifier.", - "properties": { - "monitor_id": { - "description": "ID of the monitor to prevent notifications.", - "example": 123, - "format": "int64", - "type": "integer" - } - }, - "required": [ - "monitor_id" - ], - "type": "object" - }, - { - "additionalProperties": {}, - "description": "Object of the monitor tags.", - "properties": { - "monitor_tags": { - "description": "A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`\nto `[*]` configures the downtime to mute all monitors for the given scope.", - "example": [ - "service:postgres", - "team:frontend" - ], - "items": { - "description": "A list of monitor tags.", - "example": "service:postgres", - "type": "string" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "monitor_tags" - ], - "type": "object" - } - ] + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" }, - "mute_first_recovery_notification": { - "description": "If the first recovery notification during a downtime should be muted.", + "is_crash": { + "description": "Error is a crash.", "example": false, "type": "boolean" }, - "notify_end_states": { - "description": "States that will trigger a monitor notification when the `notify_end_types` action occurs.", + "languages": { + "description": "Array of programming languages associated with the issue.", "example": [ - "alert", - "warn" + "PYTHON", + "GO" ], "items": { - "description": "State that will trigger a monitor notification when the `notify_end_types` action occurs.", + "description": "Programming language associated with the issue.", "enum": [ - "alert", - "no data", - "warn" + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" ], - "example": "alert", + "example": "PYTHON", "type": "string", "x-enum-varnames": [ - "ALERT", - "NO_DATA", - "WARN" + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" ] }, "type": "array" }, - "notify_end_types": { - "description": "Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", - "example": [ - "canceled", - "expired" - ], - "items": { - "description": "Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", - "enum": [ - "canceled", - "expired" - ], - "example": "canceled", - "type": "string", - "x-enum-varnames": [ - "CANCELED", - "EXPIRED" - ] - }, - "type": "array" + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" }, - "schedule": { - "description": "The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.", - "oneOf": [ - { - "description": "A recurring downtime schedule definition.", - "properties": { - "current_downtime": { - "description": "The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.", - "properties": { - "end": { - "description": "The end of the current downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "start": { - "description": "The start of the current downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "recurrences": { - "description": "A list of downtime recurrences.", - "items": { - "description": "An RRULE-based recurring downtime.", - "properties": { - "duration": { - "description": "The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.", - "example": "123d", - "type": "string" - }, - "rrule": { - "description": "The `RRULE` standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.\nMost common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.\n\n**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).\nMore examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).", - "example": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1", - "type": "string" - }, - "start": { - "description": "ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.", - "example": "2020-01-02T03:04", - "type": "string" - } - }, - "type": "object" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "timezone": { - "default": "UTC", - "description": "The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match `display_timezone`.", - "example": "America/New_York", - "type": "string" - } - }, - "required": [ - "recurrences" - ], - "type": "object" - }, - { - "description": "A one-time downtime definition.", - "properties": { - "end": { - "description": "ISO-8601 Datetime to end the downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "start": { - "description": "ISO-8601 Datetime to start the downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "type": "string" - } - }, - "required": [ - "start" - ], - "type": "object" - } + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" ] }, - "scope": { - "description": "The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).", - "example": "env:(staging OR prod) AND datacenter:us-east-1", + "service": { + "description": "Service name.", + "example": "email-api-py", "type": "string" }, - "status": { - "description": "The current status of the downtime.", + "state": { + "description": "State of the issue", "enum": [ - "active", - "canceled", - "ended", - "scheduled" + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" ], - "example": "active", + "example": "RESOLVED", "type": "string", "x-enum-varnames": [ - "ACTIVE", - "CANCELED", - "ENDED", - "SCHEDULED" + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" ] } }, "type": "object" }, "id": { - "description": "The downtime ID.", - "example": "00000000-0000-1234-0000-000000000000", + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", "type": "string" }, "relationships": { - "description": "All relationships associated with downtime.", + "description": "Relationship between the issue and an assignee, case and/or teams.", "properties": { - "created_by": { - "description": "The user who created the downtime.", + "assignee": { + "description": "Relationship between the issue and assignee.", "properties": { "data": { - "description": "Data for the user who created the downtime.", - "nullable": true, + "description": "The user the issue is assigned to.", "properties": { "id": { - "description": "User ID of the downtime creator.", - "example": "00000000-0000-1234-0000-000000000000", + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", "type": "string" }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "Type of the object", "enum": [ - "users" + "user" ], - "example": "users", + "example": "user", "type": "string", "x-enum-varnames": [ - "USERS" + "USER" ] } }, + "required": [ + "id", + "type" + ], "type": "object" } }, + "required": [ + "data" + ], "type": "object" }, - "monitor": { - "description": "The monitor identified by the downtime.", + "case": { + "description": "Relationship between the issue and case.", "properties": { "data": { - "description": "Data for the monitor.", - "nullable": true, + "description": "The case the issue is attached to.", "properties": { "id": { - "description": "Monitor ID of the downtime.", - "example": "12345", + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, "type": { - "default": "monitors", - "description": "Monitor resource type.", + "description": "Type of the object.", "enum": [ - "monitors" + "case" ], - "example": "monitors", + "example": "case", "type": "string", "x-enum-varnames": [ - "MONITORS" + "CASE" ] } }, + "required": [ + "id", + "type" + ], "type": "object" } }, + "required": [ + "data" + ], + "type": "object" + }, + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], "type": "object" } }, "type": "object" }, "type": { - "default": "downtime", - "description": "Downtime resource type.", + "description": "Type of the object.", "enum": [ - "downtime" + "issue" ], - "example": "downtime", + "example": "issue", "type": "string", "x-enum-varnames": [ - "DOWNTIME" + "ISSUE" ] } }, + "required": [ + "id", + "type", + "attributes" + ], "type": "object" }, "included": { - "description": "Array of objects related to the downtime that the user requested.", + "description": "Array of resources related to the issue.", "items": { - "description": "An object related to a downtime.", + "description": "An array of related resources, returned when the `include` query parameter is used.", "oneOf": [ { - "description": "User object returned by the API.", + "description": "The case attached to the issue.", "properties": { "attributes": { - "description": "Attributes of user object returned by the API.", + "description": "Object containing the information of a case.", "properties": { - "created_at": { - "description": "Creation time of the user.", + "archived_at": { + "description": "Timestamp of when the case was archived.", + "example": "2025-01-01T00:00:00Z", "format": "date-time", "type": "string" }, - "disabled": { - "description": "Whether the user is disabled.", - "type": "boolean" + "closed_at": { + "description": "Timestamp of when the case was closed.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" }, - "email": { - "description": "Email of the user.", + "created_at": { + "description": "Timestamp of when the case was created.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", "type": "string" }, - "handle": { - "description": "Handle of the user.", + "creation_source": { + "description": "Source of the case creation.", + "example": "ERROR_TRACKING", "type": "string" }, - "icon": { - "description": "URL of the user's icon.", + "description": { + "description": "Description of the case.", "type": "string" }, - "mfa_enabled": { - "description": "If user has MFA enabled.", - "readOnly": true, - "type": "boolean" + "due_date": { + "description": "Due date of the case.", + "example": "2025-01-01", + "type": "string" }, - "modified_at": { - "description": "Time that the user was last modified.", - "format": "date-time", + "insights": { + "description": "Insights of the case.", + "items": { + "description": "Insight of the case.", + "properties": { + "ref": { + "description": "Reference of the insight.", + "example": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "resource_id": { + "description": "Insight identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the insight.", + "example": "ERROR_TRACKING", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "jira_issue": { + "description": "Jira issue of the case.", + "properties": { + "result": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", + "properties": { + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", + "type": "string" + }, + "project_key": { + "description": "Jira project key.", + "example": "ET", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Creation status of the Jira issue.", + "example": "COMPLETED", + "type": "string" + } + }, + "type": "object" + }, + "key": { + "description": "Key of the case.", + "example": "ET-123", "type": "string" }, - "name": { - "description": "Name of the user.", - "nullable": true, + "modified_at": { + "description": "Timestamp of when the case was last modified.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", "type": "string" }, - "service_account": { - "description": "Whether the user is a service account.", - "type": "boolean" + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] }, "status": { - "description": "Status of the user.", - "type": "string" + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ], + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] }, "title": { - "description": "Title of the user.", - "nullable": true, + "description": "Title of the case.", + "example": "Error: HTTP error", "type": "string" }, - "verified": { - "description": "Whether the user is verified.", - "type": "boolean" + "type": { + "description": "Type of the case.", + "example": "ERROR_TRACKING_ISSUE", + "type": "string" } }, "type": "object" }, "id": { - "description": "ID of the user.", + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, "relationships": { - "description": "Relationships of the user object returned by the API.", + "description": "Resources related to a case.", "properties": { - "org": { - "description": "Relationship to an organization.", + "assignee": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationship to organization object.", + "description": "Relationship to user object.", + "nullable": true, "properties": { "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" }, "type": { - "default": "orgs", - "description": "Organizations resource type.", + "default": "user", + "description": "User resource type.", "enum": [ - "orgs" + "user" ], - "example": "orgs", + "example": "user", "type": "string", "x-enum-varnames": [ - "ORGS" + "USER" ] } }, @@ -421200,40 +429905,37 @@ ], "type": "object" }, - "other_orgs": { - "description": "Relationship to organizations.", + "created_by": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationships to organization objects.", - "example": [], - "items": { - "description": "Relationship to organization object.", - "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", - "type": "string" - }, - "type": { - "default": "orgs", - "description": "Organizations resource type.", - "enum": [ - "orgs" - ], - "example": "orgs", - "type": "string", - "x-enum-varnames": [ - "ORGS" - ] - } + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object" + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, "required": [ @@ -421241,43 +429943,37 @@ ], "type": "object" }, - "other_users": { - "description": "Relationship to users.", + "modified_by": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationships to user objects.", - "example": [], - "items": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, "required": [ @@ -421285,102 +429981,158 @@ ], "type": "object" }, - "roles": { - "description": "Relationship to roles.", + "project": { + "description": "Relationship to project", "properties": { "data": { - "description": "An array containing type and the unique identifier of a role.", - "items": { - "description": "Relationship to role object.", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" - }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" }, - "type": "object", - "x-merge-override": { - "required": false + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "data" + ], + "type": "object" } }, - "type": "object", - "x-merge-override": { - "properties": false - } + "type": "object" }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "Type of the object.", "enum": [ - "users" + "case" ], - "example": "users", + "example": "case", "type": "string", "x-enum-varnames": [ - "USERS" + "CASE" ] } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" }, { - "description": "Information about the monitor identified by the downtime.", + "description": "The user to whom the issue is assigned.", "properties": { "attributes": { - "description": "Attributes of the monitor identified by the downtime.", + "description": "Object containing the information of a user.", "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, "name": { - "description": "The name of the monitor identified by the downtime.", - "example": "A monitor name", + "description": "Name of the user.", + "example": "User Name", "type": "string" } }, "type": "object" }, "id": { - "description": "ID of the monitor identified by the downtime.", - "example": 12345, - "format": "int64", - "type": "integer" + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" }, "type": { - "default": "monitors", - "description": "Monitor resource type.", + "description": "Type of the object", "enum": [ - "monitors" + "user" ], - "example": "monitors", + "example": "user", "type": "string", "x-enum-varnames": [ - "MONITORS" + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" ] } }, + "required": [ + "id", + "type", + "attributes" + ], "type": "object" } ] @@ -421422,6 +430174,34 @@ }, "description": "Bad Request" }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, "403": { "content": { "application/json": { @@ -421476,7 +430256,7 @@ } } }, - "description": "Downtime not found" + "description": "Not Found" }, "429": { "content": { @@ -421514,22 +430294,1044 @@ }, { "AuthZ": [ - "monitors_downtime" + "error_tracking_read", + "error_tracking_write", + "cases_read", + "cases_write" ] } ], - "summary": "Update a downtime", + "summary": "Update the assignee of an issue", "tags": [ - "Downtimes" + "Error Tracking" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 6, - "x-permission": { - "operator": "OR", - "permissions": [ - "monitors_downtime" - ] + "x-menu-order": 4, + "x-undo": { + "type": "idempotent" + } + } + }, + "/api/v2/error-tracking/issues/{issue_id}/state": { + "put": { + "description": "Update the state of an issue by `issue_id`. Use this endpoint to move an issue between states such as `OPEN`, `RESOLVED`, or `IGNORED`.", + "operationId": "UpdateIssueState", + "parameters": [ + { + "description": "The identifier of the issue.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "in": "path", + "name": "issue_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Update issue state request payload.", + "properties": { + "data": { + "description": "Update issue state request.", + "properties": { + "attributes": { + "description": "Object describing an issue state update request.", + "properties": { + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "required": [ + "state" + ], + "type": "object" + }, + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "error_tracking_issue" + ], + "example": "error_tracking_issue", + "type": "string", + "x-enum-varnames": [ + "ERROR_TRACKING_ISSUE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Update issue state request payload.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response containing error tracking issue data.", + "properties": { + "data": { + "description": "The issue matching the request.", + "properties": { + "attributes": { + "description": "Object containing the information of an issue.", + "properties": { + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", + "type": "string" + }, + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", + "type": "string" + }, + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", + "type": "string" + }, + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" + }, + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", + "type": "string" + }, + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" + }, + "is_crash": { + "description": "Error is a crash.", + "example": false, + "type": "boolean" + }, + "languages": { + "description": "Array of programming languages associated with the issue.", + "example": [ + "PYTHON", + "GO" + ], + "items": { + "description": "Programming language associated with the issue.", + "enum": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ], + "example": "PYTHON", + "type": "string", + "x-enum-varnames": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ] + }, + "type": "array" + }, + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" + }, + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ] + }, + "service": { + "description": "Service name.", + "example": "email-api-py", + "type": "string" + }, + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "type": "object" + }, + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "relationships": { + "description": "Relationship between the issue and an assignee, case and/or teams.", + "properties": { + "assignee": { + "description": "Relationship between the issue and assignee.", + "properties": { + "data": { + "description": "The user the issue is assigned to.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "case": { + "description": "Relationship between the issue and case.", + "properties": { + "data": { + "description": "The case the issue is attached to.", + "properties": { + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "included": { + "description": "Array of resources related to the issue.", + "items": { + "description": "An array of related resources, returned when the `include` query parameter is used.", + "oneOf": [ + { + "description": "The case attached to the issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a case.", + "properties": { + "archived_at": { + "description": "Timestamp of when the case was archived.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "closed_at": { + "description": "Timestamp of when the case was closed.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "created_at": { + "description": "Timestamp of when the case was created.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "creation_source": { + "description": "Source of the case creation.", + "example": "ERROR_TRACKING", + "type": "string" + }, + "description": { + "description": "Description of the case.", + "type": "string" + }, + "due_date": { + "description": "Due date of the case.", + "example": "2025-01-01", + "type": "string" + }, + "insights": { + "description": "Insights of the case.", + "items": { + "description": "Insight of the case.", + "properties": { + "ref": { + "description": "Reference of the insight.", + "example": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "resource_id": { + "description": "Insight identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the insight.", + "example": "ERROR_TRACKING", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "jira_issue": { + "description": "Jira issue of the case.", + "properties": { + "result": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", + "properties": { + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", + "type": "string" + }, + "project_key": { + "description": "Jira project key.", + "example": "ET", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Creation status of the Jira issue.", + "example": "COMPLETED", + "type": "string" + } + }, + "type": "object" + }, + "key": { + "description": "Key of the case.", + "example": "ET-123", + "type": "string" + }, + "modified_at": { + "description": "Timestamp of when the case was last modified.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] + }, + "status": { + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ], + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] + }, + "title": { + "description": "Title of the case.", + "example": "Error: HTTP error", + "type": "string" + }, + "type": { + "description": "Type of the case.", + "example": "ERROR_TRACKING_ISSUE", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "relationships": { + "description": "Resources related to a case.", + "properties": { + "assignee": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "created_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modified_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "project": { + "description": "Relationship to project", + "properties": { + "data": { + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" + }, + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "The user to whom the issue is assigned.", + "properties": { + "attributes": { + "description": "Object containing the information of a user.", + "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "User Name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + ] + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "error_tracking_read", + "error_tracking_write" + ] + } + ], + "summary": "Update the state of an issue", + "tags": [ + "Error Tracking" + ], + "x-menu-order": 3, "x-undo": { "type": "idempotent" } @@ -637318,6 +647120,10 @@ "description": "**Note**: Downtime V2 is currently in private beta. To request access, contact [Datadog support](https://docs.datadoghq.com/help/).\n\n[Downtiming](https://docs.datadoghq.com/monitors/notify/downtimes) gives\nyou greater control over monitor notifications by allowing you to globally exclude\nscopes from alerting. Downtime settings, which can be scheduled with start and\nend times, prevent all alerting related to specified Datadog tags.", "name": "Downtimes" }, + { + "description": "View and manage issues within Error Tracking. See the [Error Tracking page](https://docs.datadoghq.com/error_tracking/) for more information.", + "name": "Error Tracking" + }, { "description": "The Event Management API allows you to programmatically post events to the Events Explorer and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/) for more information.\n\n**Update to Datadog monitor events `aggregation_key` starting March 1, 2025:** The Datadog monitor events `aggregation_key` is unique to each Monitor ID. Starting March 1st, this key will also include Monitor Group, making it unique per *Monitor ID and Monitor Group*. If you're using monitor events `aggregation_key` in dashboard queries or the Event API, you must migrate to use `@monitor.id`. Reach out to [support](https://www.datadoghq.com/support/) if you have any question.", "name": "Events" diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 8555a8719e822..9dbd7f8a54882 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -713,6 +713,28 @@ "request_description": "Update a downtime request body.", "request_schema_description": "Request for editing a downtime." }, + "SearchIssues": { + "description": "Search issues endpoint allows you to programmatically search for issues within your organization. This endpoint returns a list of issues that match a given search query, following the event search syntax. The search results are limited to a maximum of 100 issues per request.", + "summary": "Search error tracking issues", + "request_description": "Search issues request payload.", + "request_schema_description": "Search issues request payload." + }, + "GetIssue": { + "description": "Retrieve the full details for a specific error tracking issue, including attributes and relationships.", + "summary": "Get the details of an error tracking issue" + }, + "UpdateIssueAssignee": { + "description": "Update the assignee of an issue by `issue_id`.", + "summary": "Update the assignee of an issue", + "request_description": "Update issue assignee request payload.", + "request_schema_description": "Update issue assignee request payload." + }, + "UpdateIssueState": { + "description": "Update the state of an issue by `issue_id`. Use this endpoint to move an issue between states such as `OPEN`, `RESOLVED`, or `IGNORED`.", + "summary": "Update the state of an issue", + "request_description": "Update issue state request payload.", + "request_schema_description": "Update issue state request payload." + }, "ListEvents": { "description": "List endpoint returns events that match an events search query.\n[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).\n\nUse this endpoint to see your latest events.", "summary": "Get a list of events" diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index adad7a8cf28d5..8d9a15a6eec21 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -107,6 +107,10 @@ "name": "Downtimes", "description": "**Note**: Downtime V2 is currently in private beta. To request access, contact [Datadog support](https://docs.datadoghq.com/help/).\n\n[Downtiming](https://docs.datadoghq.com/monitors/notify/downtimes) gives\nyou greater control over monitor notifications by allowing you to globally exclude\nscopes from alerting. Downtime settings, which can be scheduled with start and\nend times, prevent all alerting related to specified Datadog tags." }, + "error-tracking": { + "name": "Error Tracking", + "description": "View and manage issues within Error Tracking. See the [Error Tracking page](https://docs.datadoghq.com/error_tracking/) for more information." + }, "events": { "name": "Events", "description": "The Event Management API allows you to programmatically post events to the Events Explorer and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/) for more information.\n\n**Update to Datadog monitor events `aggregation_key` starting March 1, 2025:** The Datadog monitor events `aggregation_key` is unique to each Monitor ID. Starting March 1st, this key will also include Monitor Group, making it unique per *Monitor ID and Monitor Group*. If you're using monitor events `aggregation_key` in dashboard queries or the Event API, you must migrate to use `@monitor.id`. Reach out to [support](https://www.datadoghq.com/support/) if you have any question." diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index 6d2c4c1a3c3be..594e7fe01ef65 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -623,6 +623,31 @@ "type": "string" } }, + "GetIssueIncludeQueryParameter": { + "description": "Comma-separated list of relationship objects that should be included in the response.", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "description": "Relationship object that should be included in the response.", + "enum": [ + "assignee", + "case", + "team_owners" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "ASSIGNEE", + "CASE", + "TEAM_OWNERS" + ] + }, + "type": "array" + } + }, "HistoricalJobID": { "description": "The ID of the job.", "in": "path", @@ -897,6 +922,16 @@ "type": "string" } }, + "IssueIDPathParameter": { + "description": "The identifier of the issue.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "in": "path", + "name": "issue_id", + "required": true, + "schema": { + "type": "string" + } + }, "KindID": { "description": "Entity kind.", "in": "path", @@ -1232,6 +1267,33 @@ ] } }, + "SearchIssuesIncludeQueryParameter": { + "description": "Comma-separated list of relationship objects that should be included in the response.", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "description": "Relationship object that should be included in the search response.", + "enum": [ + "issue", + "issue.assignee", + "issue.case", + "issue.team_owners" + ], + "example": "issue.case", + "type": "string", + "x-enum-varnames": [ + "ISSUE", + "ISSUE_ASSIGNEE", + "ISSUE_CASE", + "ISSUE_TEAM_OWNERS" + ] + }, + "type": "array" + } + }, "SecurityFilterID": { "description": "The ID of the security filter.", "in": "path", @@ -113951,6 +114013,21 @@ }, "type": "object" }, + "GetIssueIncludeQueryParameterItem": { + "description": "Relationship object that should be included in the response.", + "enum": [ + "assignee", + "case", + "team_owners" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "ASSIGNEE", + "CASE", + "TEAM_OWNERS" + ] + }, "GetResourceEvaluationFiltersResponse": { "description": "The definition of `GetResourceEvaluationFiltersResponse` object.", "properties": { @@ -147014,885 +147091,923 @@ "OFF" ] }, - "JSONAPIErrorItem": { - "description": "API error response body", + "Issue": { + "description": "The issue matching the request.", "properties": { - "detail": { - "description": "A human-readable explanation specific to this occurrence of the error.", - "example": "Missing required attribute in body", - "type": "string" - }, - "meta": { - "additionalProperties": {}, - "description": "Non-standard meta-information about the error", - "type": "object" - }, - "source": { - "description": "References to the source of the error.", + "attributes": { + "description": "Object containing the information of an issue.", "properties": { - "header": { - "description": "A string indicating the name of a single request header which caused the error.", - "example": "Authorization", + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", "type": "string" }, - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "limit", + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", "type": "string" }, - "pointer": { - "description": "A JSON pointer to the value in the request document that caused the error.", - "example": "/data/attributes/title", + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", + "type": "string" + }, + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" + }, + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", + "type": "string" + }, + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" + }, + "is_crash": { + "description": "Error is a crash.", + "example": false, + "type": "boolean" + }, + "languages": { + "description": "Array of programming languages associated with the issue.", + "example": [ + "PYTHON", + "GO" + ], + "items": { + "description": "Programming language associated with the issue.", + "enum": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ], + "example": "PYTHON", + "type": "string", + "x-enum-varnames": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ] + }, + "type": "array" + }, + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" + }, + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ] + }, + "service": { + "description": "Service name.", + "example": "email-api-py", "type": "string" + }, + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] } }, "type": "object" }, - "status": { - "description": "Status code of the response.", - "example": "400", - "type": "string" - }, - "title": { - "description": "Short human-readable summary of the error.", - "example": "Bad Request", - "type": "string" - } - }, - "type": "object" - }, - "JSONAPIErrorItemSource": { - "description": "References to the source of the error.", - "properties": { - "header": { - "description": "A string indicating the name of a single request header which caused the error.", - "example": "Authorization", - "type": "string" - }, - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "limit", + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", "type": "string" }, - "pointer": { - "description": "A JSON pointer to the value in the request document that caused the error.", - "example": "/data/attributes/title", - "type": "string" - } - }, - "type": "object" - }, - "JSONAPIErrorResponse": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", - "items": { - "description": "API error response body", - "properties": { - "detail": { - "description": "A human-readable explanation specific to this occurrence of the error.", - "example": "Missing required attribute in body", - "type": "string" - }, - "meta": { - "additionalProperties": {}, - "description": "Non-standard meta-information about the error", - "type": "object" - }, - "source": { - "description": "References to the source of the error.", - "properties": { - "header": { - "description": "A string indicating the name of a single request header which caused the error.", - "example": "Authorization", - "type": "string" - }, - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "limit", - "type": "string" + "relationships": { + "description": "Relationship between the issue and an assignee, case and/or teams.", + "properties": { + "assignee": { + "description": "Relationship between the issue and assignee.", + "properties": { + "data": { + "description": "The user the issue is assigned to.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } }, - "pointer": { - "description": "A JSON pointer to the value in the request document that caused the error.", - "example": "/data/attributes/title", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "Status code of the response.", - "example": "400", - "type": "string" + "required": [ + "id", + "type" + ], + "type": "object" + } }, - "title": { - "description": "Short human-readable summary of the error.", - "example": "Bad Request", - "type": "string" - } + "required": [ + "data" + ], + "type": "object" }, - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - }, - "JiraIntegrationMetadata": { - "description": "Incident integration metadata for the Jira integration.", - "properties": { - "issues": { - "description": "Array of Jira issues in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Jira integration metadata issue array.", - "properties": { - "account": { - "description": "URL of issue's Jira account.", - "example": "https://example.atlassian.net", - "type": "string" - }, - "issue_key": { - "description": "Jira issue's issue key.", - "example": "PROJ-123", - "type": "string" - }, - "issuetype_id": { - "description": "Jira issue's issue type.", - "example": "1000", - "type": "string" - }, - "project_key": { - "description": "Jira issue's project keys.", - "example": "PROJ", - "type": "string" + "case": { + "description": "Relationship between the issue and case.", + "properties": { + "data": { + "description": "The case the issue is attached to.", + "properties": { + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } }, - "redirect_url": { - "description": "URL redirecting to the Jira issue.", - "example": "https://example.atlassian.net/browse/PROJ-123", - "type": "string" - } - }, - "required": [ - "project_key", - "account" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "issues" - ], - "type": "object" - }, - "JiraIntegrationMetadataIssuesItem": { - "description": "Item in the Jira integration metadata issue array.", - "properties": { - "account": { - "description": "URL of issue's Jira account.", - "example": "https://example.atlassian.net", - "type": "string" - }, - "issue_key": { - "description": "Jira issue's issue key.", - "example": "PROJ-123", - "type": "string" - }, - "issuetype_id": { - "description": "Jira issue's issue type.", - "example": "1000", - "type": "string" - }, - "project_key": { - "description": "Jira issue's project keys.", - "example": "PROJ", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Jira issue.", - "example": "https://example.atlassian.net/browse/PROJ-123", - "type": "string" - } - }, - "required": [ - "project_key", - "account" - ], - "type": "object" - }, - "JiraIssue": { - "description": "Jira issue attached to case", - "nullable": true, - "properties": { - "result": { - "description": "Jira issue information", - "properties": { - "issue_id": { - "description": "Jira issue ID", - "type": "string" - }, - "issue_key": { - "description": "Jira issue key", - "type": "string" - }, - "issue_url": { - "description": "Jira issue URL", - "type": "string" + "required": [ + "data" + ], + "type": "object" }, - "project_key": { - "description": "Jira project key", - "type": "string" + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" } }, "type": "object" }, - "status": { - "default": "IN_PROGRESS", - "description": "Case status", + "type": { + "description": "Type of the object.", "enum": [ - "IN_PROGRESS", - "COMPLETED", - "FAILED" + "issue" ], - "example": "COMPLETED", - "readOnly": true, + "example": "issue", "type": "string", "x-enum-varnames": [ - "IN_PROGRESS", - "COMPLETED", - "FAILED" + "ISSUE" ] } }, - "readOnly": true, - "type": "object" - }, - "JiraIssueResult": { - "description": "Jira issue information", - "properties": { - "issue_id": { - "description": "Jira issue ID", - "type": "string" - }, - "issue_key": { - "description": "Jira issue key", - "type": "string" - }, - "issue_url": { - "description": "Jira issue URL", - "type": "string" - }, - "project_key": { - "description": "Jira project key", - "type": "string" - } - }, + "required": [ + "id", + "type", + "attributes" + ], "type": "object" }, - "JobCreateResponse": { - "description": "Run a historical job response.", + "IssueAssigneeRelationship": { + "description": "Relationship between the issue and assignee.", "properties": { "data": { - "description": "The definition of `JobCreateResponseData` object.", + "description": "The user the issue is assigned to.", "properties": { "id": { - "description": "ID of the created job.", + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", "type": "string" }, "type": { - "description": "Type of payload.", + "description": "Type of the object", "enum": [ - "historicalDetectionsJob" + "user" ], + "example": "user", "type": "string", "x-enum-varnames": [ - "HISTORICALDETECTIONSJOB" + "USER" ] } }, + "required": [ + "id", + "type" + ], "type": "object" } }, + "required": [ + "data" + ], "type": "object" }, - "JobCreateResponseData": { - "description": "The definition of `JobCreateResponseData` object.", + "IssueAttributes": { + "description": "Object containing the information of an issue.", "properties": { - "id": { - "description": "ID of the created job.", + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", "type": "string" }, - "type": { - "description": "Type of payload.", + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", + "type": "string" + }, + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", + "type": "string" + }, + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" + }, + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", + "type": "string" + }, + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" + }, + "is_crash": { + "description": "Error is a crash.", + "example": false, + "type": "boolean" + }, + "languages": { + "description": "Array of programming languages associated with the issue.", + "example": [ + "PYTHON", + "GO" + ], + "items": { + "description": "Programming language associated with the issue.", + "enum": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ], + "example": "PYTHON", + "type": "string", + "x-enum-varnames": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ] + }, + "type": "array" + }, + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" + }, + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", "enum": [ - "historicalDetectionsJob" + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" ], + "example": "BACKEND", "type": "string", "x-enum-varnames": [ - "HISTORICALDETECTIONSJOB" + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ] + }, + "service": { + "description": "Service name.", + "example": "email-api-py", + "type": "string" + }, + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" ] } }, "type": "object" }, - "JobDefinition": { - "description": "Definition of a historical job.", + "IssueCase": { + "description": "The case attached to the issue.", "properties": { - "calculatedFields": { - "description": "Calculated fields.", - "items": { - "description": "Calculated field.", - "properties": { - "expression": { - "description": "Expression.", - "example": "@request_end_timestamp - @request_start_timestamp", - "type": "string" + "attributes": { + "description": "Object containing the information of a case.", + "properties": { + "archived_at": { + "description": "Timestamp of when the case was archived.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "closed_at": { + "description": "Timestamp of when the case was closed.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "created_at": { + "description": "Timestamp of when the case was created.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "creation_source": { + "description": "Source of the case creation.", + "example": "ERROR_TRACKING", + "type": "string" + }, + "description": { + "description": "Description of the case.", + "type": "string" + }, + "due_date": { + "description": "Due date of the case.", + "example": "2025-01-01", + "type": "string" + }, + "insights": { + "description": "Insights of the case.", + "items": { + "description": "Insight of the case.", + "properties": { + "ref": { + "description": "Reference of the insight.", + "example": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "resource_id": { + "description": "Insight identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the insight.", + "example": "ERROR_TRACKING", + "type": "string" + } + }, + "type": "object" }, - "name": { - "description": "Field name.", - "example": "response_time", - "type": "string" - } + "type": "array" }, - "required": [ - "name", - "expression" - ], - "type": "object" - }, - "type": "array" - }, - "cases": { - "description": "Cases used for generating job results.", - "items": { - "description": "Case when signal is generated.", - "properties": { - "actions": { - "description": "Action to perform for each rule case.", - "items": { - "description": "Action to perform when a signal is triggered. Only available for Application Security rule type.", + "jira_issue": { + "description": "Jira issue of the case.", + "properties": { + "result": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", "properties": { - "options": { - "additionalProperties": {}, - "description": "Options for the rule action", - "properties": { - "duration": { - "description": "Duration of the action in seconds. 0 indicates no expiration.", - "example": 0, - "format": "int64", - "minimum": 0, - "type": "integer" - }, - "flaggedIPType": { - "description": "Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses.", - "enum": [ - "SUSPICIOUS", - "FLAGGED" - ], - "example": "FLAGGED", - "type": "string", - "x-enum-varnames": [ - "SUSPICIOUS", - "FLAGGED" - ] - }, - "userBehaviorName": { - "description": "Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.", - "type": "string" - } - }, - "type": "object" + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", + "type": "string" }, - "type": { - "description": "The action type.", - "enum": [ - "block_ip", - "block_user", - "user_behavior", - "flag_ip" - ], - "type": "string", - "x-enum-varnames": [ - "BLOCK_IP", - "BLOCK_USER", - "USER_BEHAVIOR", - "FLAG_IP" - ] + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", + "type": "string" + }, + "project_key": { + "description": "Jira project key.", + "example": "ET", + "type": "string" } }, "type": "object" }, - "type": "array" - }, - "condition": { - "description": "A case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.", - "type": "string" - }, - "name": { - "description": "Name of the case.", - "type": "string" - }, - "notifications": { - "description": "Notification targets.", - "items": { - "description": "Notification.", + "status": { + "description": "Creation status of the Jira issue.", + "example": "COMPLETED", "type": "string" - }, - "type": "array" + } }, - "status": { - "description": "Severity of the Security Signal.", - "enum": [ - "info", - "low", - "medium", - "high", - "critical" - ], - "example": "critical", - "type": "string", - "x-enum-varnames": [ - "INFO", - "LOW", - "MEDIUM", - "HIGH", - "CRITICAL" - ] - } + "type": "object" }, - "required": [ - "status" - ], - "type": "object" - }, - "type": "array" - }, - "from": { - "description": "Starting time of data analyzed by the job.", - "example": 1729843470000, - "format": "int64", - "type": "integer" - }, - "groupSignalsBy": { - "description": "Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.", - "example": [ - "service" - ], - "items": { - "description": "Field to group by.", - "type": "string" - }, - "type": "array" - }, - "index": { - "description": "Index used to load the data.", - "example": "cloud_siem", - "type": "string" - }, - "message": { - "description": "Message for generated results.", - "example": "A large number of failed login attempts.", - "type": "string" - }, - "name": { - "description": "Job name.", - "example": "Excessive number of failed attempts.", - "type": "string" - }, - "options": { - "description": "Job options.", - "properties": { - "detectionMethod": { - "description": "The detection method.", + "key": { + "description": "Key of the case.", + "example": "ET-123", + "type": "string" + }, + "modified_at": { + "description": "Timestamp of when the case was last modified.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", "enum": [ - "threshold", - "new_value", - "anomaly_detection", - "impossible_travel", - "hardcoded", - "third_party", - "anomaly_threshold" + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" ], + "example": "NOT_DEFINED", "type": "string", "x-enum-varnames": [ - "THRESHOLD", - "NEW_VALUE", - "ANOMALY_DETECTION", - "IMPOSSIBLE_TRAVEL", - "HARDCODED", - "THIRD_PARTY", - "ANOMALY_THRESHOLD" + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" ] }, - "evaluationWindow": { - "description": "A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used.", + "status": { + "description": "Case status", "enum": [ - 0, - 60, - 300, - 600, - 900, - 1800, - 3600, - 7200, - 10800, - 21600, - 43200, - 86400 + "OPEN", + "IN_PROGRESS", + "CLOSED" ], - "format": "int32", - "type": "integer", + "example": "OPEN", + "type": "string", "x-enum-varnames": [ - "ZERO_MINUTES", - "ONE_MINUTE", - "FIVE_MINUTES", - "TEN_MINUTES", - "FIFTEEN_MINUTES", - "THIRTY_MINUTES", - "ONE_HOUR", - "TWO_HOURS", - "THREE_HOURS", - "SIX_HOURS", - "TWELVE_HOURS", - "ONE_DAY" + "OPEN", + "IN_PROGRESS", + "CLOSED" ] }, - "impossibleTravelOptions": { - "description": "Options on impossible travel detection method.", + "title": { + "description": "Title of the case.", + "example": "Error: HTTP error", + "type": "string" + }, + "type": { + "description": "Type of the case.", + "example": "ERROR_TRACKING_ISSUE", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "relationships": { + "description": "Resources related to a case.", + "properties": { + "assignee": { + "description": "Relationship to user.", + "nullable": true, "properties": { - "baselineUserLocations": { - "description": "If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.", - "example": true, - "type": "boolean" + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" } }, - "type": "object" - }, - "keepAlive": { - "description": "Once a signal is generated, the signal will remain \"open\" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used.", - "enum": [ - 0, - 60, - 300, - 600, - 900, - 1800, - 3600, - 7200, - 10800, - 21600, - 43200, - 86400 - ], - "format": "int32", - "type": "integer", - "x-enum-varnames": [ - "ZERO_MINUTES", - "ONE_MINUTE", - "FIVE_MINUTES", - "TEN_MINUTES", - "FIFTEEN_MINUTES", - "THIRTY_MINUTES", - "ONE_HOUR", - "TWO_HOURS", - "THREE_HOURS", - "SIX_HOURS", - "TWELVE_HOURS", - "ONE_DAY" - ] - }, - "maxSignalDuration": { - "description": "A signal will \"close\" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp.", - "enum": [ - 0, - 60, - 300, - 600, - 900, - 1800, - 3600, - 7200, - 10800, - 21600, - 43200, - 86400 + "required": [ + "data" ], - "format": "int32", - "type": "integer", - "x-enum-varnames": [ - "ZERO_MINUTES", - "ONE_MINUTE", - "FIVE_MINUTES", - "TEN_MINUTES", - "FIFTEEN_MINUTES", - "THIRTY_MINUTES", - "ONE_HOUR", - "TWO_HOURS", - "THREE_HOURS", - "SIX_HOURS", - "TWELVE_HOURS", - "ONE_DAY" - ] + "type": "object" }, - "newValueOptions": { - "description": "Options on new value detection method.", + "created_by": { + "description": "Relationship to user.", + "nullable": true, "properties": { - "forgetAfter": { - "description": "The duration in days after which a learned value is forgotten.", - "enum": [ - 1, - 2, - 7, - 14, - 21, - 28 - ], - "format": "int32", - "type": "integer", - "x-enum-varnames": [ - "ONE_DAY", - "TWO_DAYS", - "ONE_WEEK", - "TWO_WEEKS", - "THREE_WEEKS", - "FOUR_WEEKS" - ] - }, - "learningDuration": { - "default": 0, - "description": "The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned.", - "enum": [ - 0, - 1, - 7 - ], - "format": "int32", - "type": "integer", - "x-enum-varnames": [ - "ZERO_DAYS", - "ONE_DAY", - "SEVEN_DAYS" - ] - }, - "learningMethod": { - "default": "duration", - "description": "The learning method used to determine when signals should be generated for values that weren't learned.", - "enum": [ - "duration", - "threshold" - ], - "type": "string", - "x-enum-varnames": [ - "DURATION", - "THRESHOLD" - ] - }, - "learningThreshold": { - "default": 0, - "description": "A number of occurrences after which signals will be generated for values that weren't learned.", - "enum": [ - 0, - 1 + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" ], - "format": "int32", - "type": "integer", - "x-enum-varnames": [ - "ZERO_OCCURRENCES", - "ONE_OCCURRENCE" - ] + "type": "object" } }, + "required": [ + "data" + ], "type": "object" }, - "thirdPartyRuleOptions": { - "description": "Options on third party detection method.", + "modified_by": { + "description": "Relationship to user.", + "nullable": true, "properties": { - "defaultNotifications": { - "description": "Notification targets for the logs that do not correspond to any of the cases.", - "items": { - "description": "Notification.", - "type": "string" + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } }, - "type": "array" - }, - "defaultStatus": { - "description": "Severity of the Security Signal.", - "enum": [ - "info", - "low", - "medium", - "high", - "critical" + "required": [ + "id", + "type" ], - "example": "critical", - "type": "string", - "x-enum-varnames": [ - "INFO", - "LOW", - "MEDIUM", - "HIGH", - "CRITICAL" - ] - }, - "rootQueries": { - "description": "Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.", - "items": { - "description": "A query to be combined with the third party case query.", - "properties": { - "groupByFields": { - "description": "Fields to group by.", - "items": { - "description": "Field.", - "type": "string" - }, - "type": "array" - }, - "query": { - "description": "Query to run on logs.", - "example": "source:cloudtrail", - "type": "string" - } + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "project": { + "description": "Relationship to project", + "properties": { + "data": { + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" }, - "type": "object" + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] + } }, - "type": "array" - }, - "signalTitleTemplate": { - "description": "A template for the signal title; if omitted, the title is generated based on the case name.", - "type": "string" + "required": [ + "id", + "type" + ], + "type": "object" } }, + "required": [ + "data" + ], "type": "object" } }, "type": "object" }, - "queries": { - "description": "Queries for selecting logs analyzed by the job.", - "items": { - "description": "Query for selecting logs analyzed by the historical job.", - "properties": { - "aggregation": { - "description": "The aggregation type.", - "enum": [ - "count", - "cardinality", - "sum", - "max", - "new_value", - "geo_data", - "event_count", - "none" - ], - "type": "string", - "x-enum-varnames": [ - "COUNT", - "CARDINALITY", - "SUM", - "MAX", - "NEW_VALUE", - "GEO_DATA", - "EVENT_COUNT", - "NONE" - ] - }, - "dataSource": { - "default": "logs", - "description": "Source of events, either logs, audit trail, or Datadog events.", - "enum": [ - "logs", - "audit", - "app_sec_spans", - "spans", - "security_runtime", - "network", - "events" - ], - "example": "logs", - "type": "string", - "x-enum-varnames": [ - "LOGS", - "AUDIT", - "APP_SEC_SPANS", - "SPANS", - "SECURITY_RUNTIME", - "NETWORK", - "EVENTS" - ] - }, - "distinctFields": { - "description": "Field for which the cardinality is measured. Sent as an array.", - "items": { - "description": "Field.", - "type": "string" - }, - "type": "array" - }, - "groupByFields": { - "description": "Fields to group by.", - "items": { - "description": "Field.", - "type": "string" - }, - "type": "array" - }, - "hasOptionalGroupByFields": { - "description": "When false, events without a group-by value are ignored by the query. When true, events with missing group-by fields are processed with `N/A`, replacing the missing values.", - "example": false, - "readOnly": true, - "type": "boolean" - }, - "metrics": { - "description": "Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.", - "items": { - "description": "Field.", - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name of the query.", - "type": "string" - }, - "query": { - "description": "Query to run on logs.", - "example": "a > 3", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "IssueCaseAttributes": { + "description": "Object containing the information of a case.", + "properties": { + "archived_at": { + "description": "Timestamp of when the case was archived.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" }, - "referenceTables": { - "description": "Reference tables used in the queries.", + "closed_at": { + "description": "Timestamp of when the case was closed.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "created_at": { + "description": "Timestamp of when the case was created.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "creation_source": { + "description": "Source of the case creation.", + "example": "ERROR_TRACKING", + "type": "string" + }, + "description": { + "description": "Description of the case.", + "type": "string" + }, + "due_date": { + "description": "Due date of the case.", + "example": "2025-01-01", + "type": "string" + }, + "insights": { + "description": "Insights of the case.", "items": { - "description": "Reference tables used in the queries.", + "description": "Insight of the case.", "properties": { - "checkPresence": { - "description": "Whether to include or exclude the matched values.", - "type": "boolean" - }, - "columnName": { - "description": "The name of the column in the reference table.", - "type": "string" - }, - "logFieldPath": { - "description": "The field in the log to match against the reference table.", + "ref": { + "description": "Reference of the insight.", + "example": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, - "ruleQueryName": { - "description": "The name of the query to apply the reference table to.", + "resource_id": { + "description": "Insight identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, - "tableName": { - "description": "The name of the reference table.", + "type": { + "description": "Type of the insight.", + "example": "ERROR_TRACKING", "type": "string" } }, @@ -147900,682 +148015,6152 @@ }, "type": "array" }, - "tags": { - "description": "Tags for generated signals.", - "items": { - "type": "string" - }, - "type": "array" - }, - "thirdPartyCases": { - "description": "Cases for generating results from third-party detection method. Only available for third-party detection method.", - "example": [], - "items": { - "description": "Case when a signal is generated by a third party rule.", - "properties": { - "name": { - "description": "Name of the case.", - "type": "string" - }, - "notifications": { - "description": "Notification targets for each case.", - "items": { - "description": "Notification.", + "jira_issue": { + "description": "Jira issue of the case.", + "properties": { + "result": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", + "properties": { + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", "type": "string" }, - "type": "array" - }, - "query": { - "description": "A query to map a third party event to this case.", - "type": "string" + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", + "type": "string" + }, + "project_key": { + "description": "Jira project key.", + "example": "ET", + "type": "string" + } }, - "status": { - "description": "Severity of the Security Signal.", - "enum": [ - "info", - "low", - "medium", - "high", - "critical" - ], - "example": "critical", - "type": "string", - "x-enum-varnames": [ - "INFO", - "LOW", - "MEDIUM", - "HIGH", - "CRITICAL" - ] - } + "type": "object" }, - "required": [ - "status" - ], - "type": "object" + "status": { + "description": "Creation status of the Jira issue.", + "example": "COMPLETED", + "type": "string" + } }, - "type": "array" - }, - "to": { - "description": "Ending time of data analyzed by the job.", - "example": 1729847070000, - "format": "int64", - "type": "integer" + "type": "object" }, - "type": { - "description": "Job type.", + "key": { + "description": "Key of the case.", + "example": "ET-123", "type": "string" - } - }, - "required": [ - "from", - "to", - "index", - "name", - "cases", - "queries", - "message" - ], - "type": "object" - }, - "JobDefinitionFromRule": { - "description": "Definition of a historical job based on a security monitoring rule.", - "properties": { - "from": { - "description": "Starting time of data analyzed by the job.", - "example": 1729843470000, - "format": "int64", - "type": "integer" }, - "id": { - "description": "ID of the detection rule used to create the job.", - "example": "abc-def-ghi", + "modified_at": { + "description": "Timestamp of when the case was last modified.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", "type": "string" }, - "index": { - "description": "Index used to load the data.", - "example": "cloud_siem", - "type": "string" + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] }, - "notifications": { - "description": "Notifications sent when the job is completed.", - "example": [ - "@sns-cloudtrail-results" + "status": { + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" ], - "items": { - "type": "string" - }, - "type": "array" + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] }, - "to": { - "description": "Ending time of data analyzed by the job.", - "example": 1729847070000, - "format": "int64", - "type": "integer" + "title": { + "description": "Title of the case.", + "example": "Error: HTTP error", + "type": "string" + }, + "type": { + "description": "Type of the case.", + "example": "ERROR_TRACKING_ISSUE", + "type": "string" } }, - "required": [ - "id", - "from", - "to", - "index" - ], "type": "object" }, - "KindAttributes": { - "description": "Kind attributes.", + "IssueCaseInsight": { + "description": "Insight of the case.", "properties": { - "description": { - "description": "Short description of the kind.", + "ref": { + "description": "Reference of the insight.", + "example": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, - "displayName": { - "description": "User friendly name of the kind.", + "resource_id": { + "description": "Insight identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, - "name": { - "description": "The kind name.", - "example": "my-job", - "minLength": 1, + "type": { + "description": "Type of the insight.", + "example": "ERROR_TRACKING", "type": "string" } }, "type": "object" }, - "KindData": { - "description": "Schema that defines the structure of a Kind object in the Software Catalog.", + "IssueCaseJiraIssue": { + "description": "Jira issue of the case.", "properties": { - "attributes": { - "description": "Kind attributes.", + "result": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", "properties": { - "description": { - "description": "Short description of the kind.", + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", "type": "string" }, - "displayName": { - "description": "User friendly name of the kind.", + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", "type": "string" }, - "name": { - "description": "The kind name.", - "example": "my-job", - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.", - "example": "4b163705-23c0-4573-b2fb-f6cea2163fcb", - "minLength": 1, - "type": "string" - }, - "meta": { - "description": "Kind metadata.", - "properties": { - "createdAt": { - "description": "The creation time.", + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", "type": "string" }, - "modifiedAt": { - "description": "The modification time.", + "project_key": { + "description": "Jira project key.", + "example": "ET", "type": "string" } }, "type": "object" }, - "type": { - "description": "Kind.", - "type": "string" - } - }, - "type": "object" - }, - "KindMetadata": { - "description": "Kind metadata.", - "properties": { - "createdAt": { - "description": "The creation time.", - "type": "string" - }, - "modifiedAt": { - "description": "The modification time.", + "status": { + "description": "Creation status of the Jira issue.", + "example": "COMPLETED", "type": "string" } }, "type": "object" }, - "KindObj": { - "description": "Schema for kind.", + "IssueCaseJiraIssueResult": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", "properties": { - "description": { - "description": "Short description of the kind.", + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", "type": "string" }, - "displayName": { - "description": "The display name of the kind. Automatically generated if not provided.", + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", "type": "string" }, - "kind": { - "description": "The name of the kind to create or update. This must be in kebab-case format.", - "example": "my-job", + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", "type": "string" - } - }, - "required": [ - "kind" - ], - "type": "object" - }, - "KindRaw": { - "description": "Kind definition in raw JSON or YAML representation.", - "example": "kind: service\ndisplayName: Service\ndescription: A service entity in the catalog.\n", - "type": "string" - }, - "KindResponseData": { - "description": "List of kind responses.", - "items": { - "description": "Schema that defines the structure of a Kind object in the Software Catalog.", - "properties": { - "attributes": { - "description": "Kind attributes.", - "properties": { - "description": { - "description": "Short description of the kind.", - "type": "string" - }, - "displayName": { - "description": "User friendly name of the kind.", - "type": "string" - }, - "name": { - "description": "The kind name.", - "example": "my-job", - "minLength": 1, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.", - "example": "4b163705-23c0-4573-b2fb-f6cea2163fcb", - "minLength": 1, - "type": "string" - }, - "meta": { - "description": "Kind metadata.", - "properties": { - "createdAt": { - "description": "The creation time.", - "type": "string" - }, - "modifiedAt": { - "description": "The modification time.", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "Kind.", - "type": "string" - } }, - "type": "object" - }, - "type": "array" - }, - "KindResponseMeta": { - "description": "Kind response metadata.", - "properties": { - "count": { - "description": "Total kinds count.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "LaunchDarklyAPIKey": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", - "properties": { - "api_token": { - "description": "The `LaunchDarklyAPIKey` `api_token`.", - "example": "", + "project_key": { + "description": "Jira project key.", + "example": "ET", "type": "string" - }, - "type": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", - "enum": [ - "LaunchDarklyAPIKey" - ], - "example": "LaunchDarklyAPIKey", - "type": "string", - "x-enum-varnames": [ - "LAUNCHDARKLYAPIKEY" - ] } }, - "required": [ - "type", - "api_token" - ], "type": "object" }, - "LaunchDarklyAPIKeyType": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", - "enum": [ - "LaunchDarklyAPIKey" - ], - "example": "LaunchDarklyAPIKey", - "type": "string", - "x-enum-varnames": [ - "LAUNCHDARKLYAPIKEY" - ] - }, - "LaunchDarklyAPIKeyUpdate": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + "IssueCaseReference": { + "description": "The case the issue is attached to.", "properties": { - "api_token": { - "description": "The `LaunchDarklyAPIKeyUpdate` `api_token`.", + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, "type": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + "description": "Type of the object.", "enum": [ - "LaunchDarklyAPIKey" + "case" ], - "example": "LaunchDarklyAPIKey", + "example": "case", "type": "string", "x-enum-varnames": [ - "LAUNCHDARKLYAPIKEY" + "CASE" ] } }, "required": [ + "id", "type" ], "type": "object" }, - "LaunchDarklyCredentials": { - "description": "The definition of the `LaunchDarklyCredentials` object.", - "oneOf": [ - { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + "IssueCaseRelationship": { + "description": "Relationship between the issue and case.", + "properties": { + "data": { + "description": "The case the issue is attached to.", "properties": { - "api_token": { - "description": "The `LaunchDarklyAPIKey` `api_token`.", - "example": "", + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, "type": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + "description": "Type of the object.", "enum": [ - "LaunchDarklyAPIKey" + "case" ], - "example": "LaunchDarklyAPIKey", + "example": "case", "type": "string", "x-enum-varnames": [ - "LAUNCHDARKLYAPIKEY" + "CASE" ] } }, "required": [ - "type", - "api_token" + "id", + "type" ], "type": "object" } - ] + }, + "required": [ + "data" + ], + "type": "object" }, - "LaunchDarklyCredentialsUpdate": { - "description": "The definition of the `LaunchDarklyCredentialsUpdate` object.", - "oneOf": [ - { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + "IssueCaseRelationships": { + "description": "Resources related to a case.", + "properties": { + "assignee": { + "description": "Relationship to user.", + "nullable": true, "properties": { - "api_token": { - "description": "The `LaunchDarklyAPIKeyUpdate` `api_token`.", - "type": "string" - }, - "type": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", - "enum": [ - "LaunchDarklyAPIKey" + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" ], - "example": "LaunchDarklyAPIKey", - "type": "string", - "x-enum-varnames": [ - "LAUNCHDARKLYAPIKEY" - ] + "type": "object" } }, "required": [ - "type" + "data" ], "type": "object" - } - ] - }, - "LaunchDarklyIntegration": { - "description": "The definition of the `LaunchDarklyIntegration` object.", - "properties": { - "credentials": { - "description": "The definition of the `LaunchDarklyCredentials` object.", - "oneOf": [ - { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + }, + "created_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, "properties": { - "api_token": { - "description": "The `LaunchDarklyAPIKey` `api_token`.", - "example": "", + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" }, "type": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + "default": "user", + "description": "User resource type.", "enum": [ - "LaunchDarklyAPIKey" + "user" ], - "example": "LaunchDarklyAPIKey", + "example": "user", "type": "string", "x-enum-varnames": [ - "LAUNCHDARKLYAPIKEY" + "USER" ] } }, "required": [ - "type", - "api_token" + "id", + "type" ], "type": "object" } - ] - }, - "type": { - "description": "The definition of the `LaunchDarklyIntegrationType` object.", - "enum": [ - "LaunchDarkly" + }, + "required": [ + "data" ], - "example": "LaunchDarkly", - "type": "string", - "x-enum-varnames": [ - "LAUNCHDARKLY" - ] - } - }, - "required": [ - "type", - "credentials" - ], - "type": "object" - }, - "LaunchDarklyIntegrationType": { - "description": "The definition of the `LaunchDarklyIntegrationType` object.", - "enum": [ - "LaunchDarkly" - ], - "example": "LaunchDarkly", - "type": "string", - "x-enum-varnames": [ - "LAUNCHDARKLY" - ] - }, - "LaunchDarklyIntegrationUpdate": { - "description": "The definition of the `LaunchDarklyIntegrationUpdate` object.", - "properties": { - "credentials": { - "description": "The definition of the `LaunchDarklyCredentialsUpdate` object.", - "oneOf": [ - { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + "type": "object" + }, + "modified_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, "properties": { - "api_token": { - "description": "The `LaunchDarklyAPIKeyUpdate` `api_token`.", + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" }, "type": { - "description": "The definition of the `LaunchDarklyAPIKey` object.", + "default": "user", + "description": "User resource type.", "enum": [ - "LaunchDarklyAPIKey" + "user" ], - "example": "LaunchDarklyAPIKey", + "example": "user", "type": "string", "x-enum-varnames": [ - "LAUNCHDARKLYAPIKEY" + "USER" ] } }, "required": [ + "id", "type" ], "type": "object" } - ] - }, - "type": { - "description": "The definition of the `LaunchDarklyIntegrationType` object.", - "enum": [ - "LaunchDarkly" + }, + "required": [ + "data" ], - "example": "LaunchDarkly", - "type": "string", - "x-enum-varnames": [ - "LAUNCHDARKLY" - ] - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "Layer": { - "description": "Encapsulates a layer resource, holding attributes like rotation details, plus relationships to the members covering that layer.", - "properties": { - "attributes": { - "description": "Describes key properties of a Layer, including rotation details, name, start/end times, and any restrictions.", + "type": "object" + }, + "project": { + "description": "Relationship to project", "properties": { - "effective_date": { - "description": "When the layer becomes active (ISO 8601).", - "format": "date-time", - "type": "string" - }, - "end_date": { - "description": "When the layer ceases to be active (ISO 8601).", - "format": "date-time", - "type": "string" - }, - "interval": { - "description": "Defines how often the rotation repeats, using a combination of days and optional seconds. Should be at least 1 hour.", + "data": { + "description": "Relationship to project object", "properties": { - "days": { - "description": "The number of days in each rotation cycle.", - "example": 1, - "format": "int32", - "maximum": 400, - "type": "integer" + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" }, - "seconds": { - "description": "Any additional seconds for the rotation cycle (up to 30 days).", - "example": 300, - "format": "int64", - "maximum": 2592000, - "type": "integer" + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] } }, + "required": [ + "id", + "type" + ], "type": "object" - }, - "name": { - "description": "The name of this layer.", - "example": "Weekend Layer", - "type": "string" - }, - "restrictions": { - "description": "An optional list of time restrictions for when this layer is in effect.", - "items": { - "description": "Defines a single time restriction rule with start and end times and the applicable weekdays.", - "properties": { - "end_day": { - "description": "A day of the week.", - "enum": [ - "monday", - "tuesday", - "wednesday", - "thursday", - "friday", - "saturday", - "sunday" - ], - "type": "string", - "x-enum-varnames": [ - "MONDAY", - "TUESDAY", - "WEDNESDAY", - "THURSDAY", - "FRIDAY", - "SATURDAY", - "SUNDAY" - ] - }, - "end_time": { - "description": "Specifies the ending time for this restriction.", - "type": "string" - }, - "start_day": { - "description": "A day of the week.", - "enum": [ - "monday", - "tuesday", - "wednesday", - "thursday", - "friday", - "saturday", - "sunday" - ], - "type": "string", - "x-enum-varnames": [ - "MONDAY", - "TUESDAY", - "WEDNESDAY", - "THURSDAY", - "FRIDAY", - "SATURDAY", - "SUNDAY" - ] - }, - "start_time": { - "description": "Specifies the starting time for this restriction.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "rotation_start": { - "description": "The date/time when the rotation starts (ISO 8601).", - "format": "date-time", - "type": "string" } }, + "required": [ + "data" + ], "type": "object" - }, - "id": { - "description": "A unique identifier for this layer.", - "type": "string" - }, - "relationships": { - "description": "Holds references to objects related to the Layer entity, such as its members.", + } + }, + "type": "object" + }, + "IssueCaseResourceType": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + }, + "IssueIncluded": { + "description": "An array of related resources, returned when the `include` query parameter is used.", + "oneOf": [ + { + "description": "The case attached to the issue.", "properties": { - "members": { - "description": "Holds an array of references to the members of a Layer, each containing member IDs.", + "attributes": { + "description": "Object containing the information of a case.", "properties": { - "data": { - "description": "The list of members who belong to this layer.", + "archived_at": { + "description": "Timestamp of when the case was archived.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "closed_at": { + "description": "Timestamp of when the case was closed.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "created_at": { + "description": "Timestamp of when the case was created.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "creation_source": { + "description": "Source of the case creation.", + "example": "ERROR_TRACKING", + "type": "string" + }, + "description": { + "description": "Description of the case.", + "type": "string" + }, + "due_date": { + "description": "Due date of the case.", + "example": "2025-01-01", + "type": "string" + }, + "insights": { + "description": "Insights of the case.", "items": { - "description": "Represents a single member object in a layer's `members` array, referencing\na unique Datadog user ID.", + "description": "Insight of the case.", "properties": { - "id": { - "description": "The unique user ID of the layer member.", - "example": "00000000-0000-0000-0000-000000000002", + "ref": { + "description": "Reference of the insight.", + "example": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "resource_id": { + "description": "Insight identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, "type": { - "default": "members", - "description": "Members resource type.", - "enum": [ - "members" - ], - "example": "members", - "type": "string", - "x-enum-varnames": [ - "MEMBERS" - ] + "description": "Type of the insight.", + "example": "ERROR_TRACKING", + "type": "string" } }, - "required": [ + "type": "object" + }, + "type": "array" + }, + "jira_issue": { + "description": "Jira issue of the case.", + "properties": { + "result": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", + "properties": { + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", + "type": "string" + }, + "project_key": { + "description": "Jira project key.", + "example": "ET", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Creation status of the Jira issue.", + "example": "COMPLETED", + "type": "string" + } + }, + "type": "object" + }, + "key": { + "description": "Key of the case.", + "example": "ET-123", + "type": "string" + }, + "modified_at": { + "description": "Timestamp of when the case was last modified.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] + }, + "status": { + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ], + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] + }, + "title": { + "description": "Title of the case.", + "example": "Error: HTTP error", + "type": "string" + }, + "type": { + "description": "Type of the case.", + "example": "ERROR_TRACKING_ISSUE", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "relationships": { + "description": "Resources related to a case.", + "properties": { + "assignee": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "created_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modified_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "project": { + "description": "Relationship to project", + "properties": { + "data": { + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" + }, + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "The user to whom the issue is assigned.", + "properties": { + "attributes": { + "description": "Object containing the information of a user.", + "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "User Name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + ] + }, + "IssueLanguage": { + "description": "Programming language associated with the issue.", + "enum": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ], + "example": "PYTHON", + "type": "string", + "x-enum-varnames": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ] + }, + "IssuePlatform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ] + }, + "IssueReference": { + "description": "The issue the search result corresponds to.", + "properties": { + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "IssueRelationships": { + "description": "Relationship between the issue and an assignee, case and/or teams.", + "properties": { + "assignee": { + "description": "Relationship between the issue and assignee.", + "properties": { + "data": { + "description": "The user the issue is assigned to.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "case": { + "description": "Relationship between the issue and case.", + "properties": { + "data": { + "description": "The case the issue is attached to.", + "properties": { + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "IssueResponse": { + "description": "Response containing error tracking issue data.", + "properties": { + "data": { + "description": "The issue matching the request.", + "properties": { + "attributes": { + "description": "Object containing the information of an issue.", + "properties": { + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", + "type": "string" + }, + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", + "type": "string" + }, + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", + "type": "string" + }, + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" + }, + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", + "type": "string" + }, + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" + }, + "is_crash": { + "description": "Error is a crash.", + "example": false, + "type": "boolean" + }, + "languages": { + "description": "Array of programming languages associated with the issue.", + "example": [ + "PYTHON", + "GO" + ], + "items": { + "description": "Programming language associated with the issue.", + "enum": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ], + "example": "PYTHON", + "type": "string", + "x-enum-varnames": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ] + }, + "type": "array" + }, + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" + }, + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ] + }, + "service": { + "description": "Service name.", + "example": "email-api-py", + "type": "string" + }, + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "type": "object" + }, + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "relationships": { + "description": "Relationship between the issue and an assignee, case and/or teams.", + "properties": { + "assignee": { + "description": "Relationship between the issue and assignee.", + "properties": { + "data": { + "description": "The user the issue is assigned to.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "case": { + "description": "Relationship between the issue and case.", + "properties": { + "data": { + "description": "The case the issue is attached to.", + "properties": { + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "included": { + "description": "Array of resources related to the issue.", + "items": { + "description": "An array of related resources, returned when the `include` query parameter is used.", + "oneOf": [ + { + "description": "The case attached to the issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a case.", + "properties": { + "archived_at": { + "description": "Timestamp of when the case was archived.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "closed_at": { + "description": "Timestamp of when the case was closed.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "created_at": { + "description": "Timestamp of when the case was created.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "creation_source": { + "description": "Source of the case creation.", + "example": "ERROR_TRACKING", + "type": "string" + }, + "description": { + "description": "Description of the case.", + "type": "string" + }, + "due_date": { + "description": "Due date of the case.", + "example": "2025-01-01", + "type": "string" + }, + "insights": { + "description": "Insights of the case.", + "items": { + "description": "Insight of the case.", + "properties": { + "ref": { + "description": "Reference of the insight.", + "example": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "resource_id": { + "description": "Insight identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the insight.", + "example": "ERROR_TRACKING", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "jira_issue": { + "description": "Jira issue of the case.", + "properties": { + "result": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", + "properties": { + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", + "type": "string" + }, + "project_key": { + "description": "Jira project key.", + "example": "ET", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Creation status of the Jira issue.", + "example": "COMPLETED", + "type": "string" + } + }, + "type": "object" + }, + "key": { + "description": "Key of the case.", + "example": "ET-123", + "type": "string" + }, + "modified_at": { + "description": "Timestamp of when the case was last modified.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] + }, + "status": { + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ], + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] + }, + "title": { + "description": "Title of the case.", + "example": "Error: HTTP error", + "type": "string" + }, + "type": { + "description": "Type of the case.", + "example": "ERROR_TRACKING_ISSUE", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "relationships": { + "description": "Resources related to a case.", + "properties": { + "assignee": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "created_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modified_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "project": { + "description": "Relationship to project", + "properties": { + "data": { + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" + }, + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "The user to whom the issue is assigned.", + "properties": { + "attributes": { + "description": "Object containing the information of a user.", + "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "User Name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + ] + }, + "type": "array" + } + }, + "type": "object" + }, + "IssueState": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + }, + "IssueTeam": { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "IssueTeamAttributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "IssueTeamOwnersRelationship": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IssueTeamReference": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "IssueTeamType": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + }, + "IssueType": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + }, + "IssueUpdateAssigneeRequest": { + "description": "Update issue assignee request payload.", + "properties": { + "data": { + "description": "Update issue assignee request.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "assignee" + ], + "example": "assignee", + "type": "string", + "x-enum-varnames": [ + "ASSIGNEE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IssueUpdateAssigneeRequestData": { + "description": "Update issue assignee request.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "assignee" + ], + "example": "assignee", + "type": "string", + "x-enum-varnames": [ + "ASSIGNEE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "IssueUpdateAssigneeRequestDataType": { + "description": "Type of the object.", + "enum": [ + "assignee" + ], + "example": "assignee", + "type": "string", + "x-enum-varnames": [ + "ASSIGNEE" + ] + }, + "IssueUpdateStateRequest": { + "description": "Update issue state request payload.", + "properties": { + "data": { + "description": "Update issue state request.", + "properties": { + "attributes": { + "description": "Object describing an issue state update request.", + "properties": { + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "required": [ + "state" + ], + "type": "object" + }, + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "error_tracking_issue" + ], + "example": "error_tracking_issue", + "type": "string", + "x-enum-varnames": [ + "ERROR_TRACKING_ISSUE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IssueUpdateStateRequestData": { + "description": "Update issue state request.", + "properties": { + "attributes": { + "description": "Object describing an issue state update request.", + "properties": { + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "required": [ + "state" + ], + "type": "object" + }, + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "error_tracking_issue" + ], + "example": "error_tracking_issue", + "type": "string", + "x-enum-varnames": [ + "ERROR_TRACKING_ISSUE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "IssueUpdateStateRequestDataAttributes": { + "description": "Object describing an issue state update request.", + "properties": { + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "required": [ + "state" + ], + "type": "object" + }, + "IssueUpdateStateRequestDataType": { + "description": "Type of the object.", + "enum": [ + "error_tracking_issue" + ], + "example": "error_tracking_issue", + "type": "string", + "x-enum-varnames": [ + "ERROR_TRACKING_ISSUE" + ] + }, + "IssueUser": { + "description": "The user to whom the issue is assigned.", + "properties": { + "attributes": { + "description": "Object containing the information of a user.", + "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "User Name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "IssueUserAttributes": { + "description": "Object containing the information of a user.", + "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "User Name", + "type": "string" + } + }, + "type": "object" + }, + "IssueUserReference": { + "description": "The user the issue is assigned to.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "IssueUserType": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + }, + "IssuesSearchRequest": { + "description": "Search issues request payload.", + "properties": { + "data": { + "description": "Search issues request.", + "properties": { + "attributes": { + "description": "Object describing a search issue request.", + "properties": { + "from": { + "description": "Start date (inclusive) of the query in milliseconds since the Unix epoch.", + "example": 1671612804000, + "format": "int64", + "type": "integer" + }, + "order_by": { + "description": "The attribute to sort the search results by.", + "enum": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ], + "example": "IMPACTED_SESSIONS", + "type": "string", + "x-enum-varnames": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ] + }, + "persona": { + "description": "Persona for the search. Either track(s) or persona(s) must be specified.", + "enum": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ] + }, + "query": { + "description": "Search query following the event search syntax.", + "example": "service:orders-* AND @language:go", + "type": "string" + }, + "to": { + "description": "End date (exclusive) of the query in milliseconds since the Unix epoch.", + "example": 1671620004000, + "format": "int64", + "type": "integer" + }, + "track": { + "description": "Track of the events to query. Either track(s) or persona(s) must be specified.", + "enum": [ + "trace", + "logs", + "rum" + ], + "example": "trace", + "type": "string", + "x-enum-varnames": [ + "TRACE", + "LOGS", + "RUM" + ] + } + }, + "required": [ + "query", + "from", + "to" + ], + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "search_request" + ], + "example": "search_request", + "type": "string", + "x-enum-varnames": [ + "SEARCH_REQUEST" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IssuesSearchRequestData": { + "description": "Search issues request.", + "properties": { + "attributes": { + "description": "Object describing a search issue request.", + "properties": { + "from": { + "description": "Start date (inclusive) of the query in milliseconds since the Unix epoch.", + "example": 1671612804000, + "format": "int64", + "type": "integer" + }, + "order_by": { + "description": "The attribute to sort the search results by.", + "enum": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ], + "example": "IMPACTED_SESSIONS", + "type": "string", + "x-enum-varnames": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ] + }, + "persona": { + "description": "Persona for the search. Either track(s) or persona(s) must be specified.", + "enum": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ] + }, + "query": { + "description": "Search query following the event search syntax.", + "example": "service:orders-* AND @language:go", + "type": "string" + }, + "to": { + "description": "End date (exclusive) of the query in milliseconds since the Unix epoch.", + "example": 1671620004000, + "format": "int64", + "type": "integer" + }, + "track": { + "description": "Track of the events to query. Either track(s) or persona(s) must be specified.", + "enum": [ + "trace", + "logs", + "rum" + ], + "example": "trace", + "type": "string", + "x-enum-varnames": [ + "TRACE", + "LOGS", + "RUM" + ] + } + }, + "required": [ + "query", + "from", + "to" + ], + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "search_request" + ], + "example": "search_request", + "type": "string", + "x-enum-varnames": [ + "SEARCH_REQUEST" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + }, + "IssuesSearchRequestDataAttributes": { + "description": "Object describing a search issue request.", + "properties": { + "from": { + "description": "Start date (inclusive) of the query in milliseconds since the Unix epoch.", + "example": 1671612804000, + "format": "int64", + "type": "integer" + }, + "order_by": { + "description": "The attribute to sort the search results by.", + "enum": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ], + "example": "IMPACTED_SESSIONS", + "type": "string", + "x-enum-varnames": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ] + }, + "persona": { + "description": "Persona for the search. Either track(s) or persona(s) must be specified.", + "enum": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ] + }, + "query": { + "description": "Search query following the event search syntax.", + "example": "service:orders-* AND @language:go", + "type": "string" + }, + "to": { + "description": "End date (exclusive) of the query in milliseconds since the Unix epoch.", + "example": 1671620004000, + "format": "int64", + "type": "integer" + }, + "track": { + "description": "Track of the events to query. Either track(s) or persona(s) must be specified.", + "enum": [ + "trace", + "logs", + "rum" + ], + "example": "trace", + "type": "string", + "x-enum-varnames": [ + "TRACE", + "LOGS", + "RUM" + ] + } + }, + "required": [ + "query", + "from", + "to" + ], + "type": "object" + }, + "IssuesSearchRequestDataAttributesOrderBy": { + "description": "The attribute to sort the search results by.", + "enum": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ], + "example": "IMPACTED_SESSIONS", + "type": "string", + "x-enum-varnames": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ] + }, + "IssuesSearchRequestDataAttributesPersona": { + "description": "Persona for the search. Either track(s) or persona(s) must be specified.", + "enum": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ] + }, + "IssuesSearchRequestDataAttributesTrack": { + "description": "Track of the events to query. Either track(s) or persona(s) must be specified.", + "enum": [ + "trace", + "logs", + "rum" + ], + "example": "trace", + "type": "string", + "x-enum-varnames": [ + "TRACE", + "LOGS", + "RUM" + ] + }, + "IssuesSearchRequestDataType": { + "description": "Type of the object.", + "enum": [ + "search_request" + ], + "example": "search_request", + "type": "string", + "x-enum-varnames": [ + "SEARCH_REQUEST" + ] + }, + "IssuesSearchResponse": { + "description": "Search issues response payload.", + "properties": { + "data": { + "description": "Array of results matching the search query.", + "items": { + "description": "Result matching the search query.", + "properties": { + "attributes": { + "description": "Object containing the information of a search result.", + "properties": { + "impacted_sessions": { + "description": "Count of sessions impacted by the issue over the queried time window.", + "example": 12, + "format": "int64", + "type": "integer" + }, + "impacted_users": { + "description": "Count of users impacted by the issue over the queried time window.", + "example": 4, + "format": "int64", + "type": "integer" + }, + "total_count": { + "description": "Total count of errors that match the issue over the queried time window.", + "example": 82, + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "Search result identifier (matches the nested issue's identifier).", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "relationships": { + "description": "Relationships between the search result and other resources.", + "properties": { + "issue": { + "description": "Relationship between the search result and the corresponding issue.", + "properties": { + "data": { + "description": "The issue the search result corresponds to.", + "properties": { + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "error_tracking_search_result" + ], + "example": "error_tracking_search_result", + "type": "string", + "x-enum-varnames": [ + "ERROR_TRACKING_SEARCH_RESULT" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Array of resources related to the search results.", + "items": { + "description": "An array of related resources, returned when the `include` query parameter is used.", + "oneOf": [ + { + "description": "The issue matching the request.", + "properties": { + "attributes": { + "description": "Object containing the information of an issue.", + "properties": { + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", + "type": "string" + }, + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", + "type": "string" + }, + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", + "type": "string" + }, + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" + }, + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", + "type": "string" + }, + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" + }, + "is_crash": { + "description": "Error is a crash.", + "example": false, + "type": "boolean" + }, + "languages": { + "description": "Array of programming languages associated with the issue.", + "example": [ + "PYTHON", + "GO" + ], + "items": { + "description": "Programming language associated with the issue.", + "enum": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ], + "example": "PYTHON", + "type": "string", + "x-enum-varnames": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ] + }, + "type": "array" + }, + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" + }, + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ] + }, + "service": { + "description": "Service name.", + "example": "email-api-py", + "type": "string" + }, + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "type": "object" + }, + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "relationships": { + "description": "Relationship between the issue and an assignee, case and/or teams.", + "properties": { + "assignee": { + "description": "Relationship between the issue and assignee.", + "properties": { + "data": { + "description": "The user the issue is assigned to.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "case": { + "description": "Relationship between the issue and case.", + "properties": { + "data": { + "description": "The case the issue is attached to.", + "properties": { + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A case", + "properties": { + "attributes": { + "description": "Case resource attributes", + "properties": { + "archived_at": { + "description": "Timestamp of when the case was archived", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "attributes": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, + "description": "The definition of `CaseObjectAttributes` object.", + "type": "object" + }, + "closed_at": { + "description": "Timestamp of when the case was closed", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "created_at": { + "description": "Timestamp of when the case was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description", + "type": "string" + }, + "jira_issue": { + "description": "Jira issue attached to case", + "nullable": true, + "properties": { + "result": { + "description": "Jira issue information", + "properties": { + "issue_id": { + "description": "Jira issue ID", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL", + "type": "string" + }, + "project_key": { + "description": "Jira project key", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "default": "IN_PROGRESS", + "description": "Case status", + "enum": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ], + "example": "COMPLETED", + "readOnly": true, + "type": "string", + "x-enum-varnames": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + } + }, + "readOnly": true, + "type": "object" + }, + "key": { + "description": "Key", + "example": "CASEM-4523", + "type": "string" + }, + "modified_at": { + "description": "Timestamp of when the case was last modified", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] + }, + "service_now_ticket": { + "description": "ServiceNow ticket attached to case", + "nullable": true, + "properties": { + "result": { + "description": "ServiceNow ticket information", + "properties": { + "sys_target_link": { + "description": "Link to the Incident created on ServiceNow", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "default": "IN_PROGRESS", + "description": "Case status", + "enum": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ], + "example": "COMPLETED", + "readOnly": true, + "type": "string", + "x-enum-varnames": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + } + }, + "readOnly": true, + "type": "object" + }, + "status": { + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ], + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] + }, + "title": { + "description": "Title", + "example": "Memory leak investigation on API", + "type": "string" + }, + "type": { + "description": "Case type", + "enum": [ + "STANDARD" + ], + "example": "STANDARD", + "type": "string", + "x-enum-varnames": [ + "STANDARD" + ] + } + }, + "type": "object" + }, + "id": { + "description": "Case's identifier", + "example": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "relationships": { + "description": "Resources related to a case", + "properties": { + "assignee": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "created_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modified_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "project": { + "description": "Relationship to project", + "properties": { + "data": { + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" + }, + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "case", + "description": "Case resource type", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "The user to whom the issue is assigned.", + "properties": { + "attributes": { + "description": "Object containing the information of a user.", + "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "User Name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + ] + }, + "type": "array" + } + }, + "type": "object" + }, + "IssuesSearchResult": { + "description": "Result matching the search query.", + "properties": { + "attributes": { + "description": "Object containing the information of a search result.", + "properties": { + "impacted_sessions": { + "description": "Count of sessions impacted by the issue over the queried time window.", + "example": 12, + "format": "int64", + "type": "integer" + }, + "impacted_users": { + "description": "Count of users impacted by the issue over the queried time window.", + "example": 4, + "format": "int64", + "type": "integer" + }, + "total_count": { + "description": "Total count of errors that match the issue over the queried time window.", + "example": 82, + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "Search result identifier (matches the nested issue's identifier).", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "relationships": { + "description": "Relationships between the search result and other resources.", + "properties": { + "issue": { + "description": "Relationship between the search result and the corresponding issue.", + "properties": { + "data": { + "description": "The issue the search result corresponds to.", + "properties": { + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "error_tracking_search_result" + ], + "example": "error_tracking_search_result", + "type": "string", + "x-enum-varnames": [ + "ERROR_TRACKING_SEARCH_RESULT" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "IssuesSearchResultAttributes": { + "description": "Object containing the information of a search result.", + "properties": { + "impacted_sessions": { + "description": "Count of sessions impacted by the issue over the queried time window.", + "example": 12, + "format": "int64", + "type": "integer" + }, + "impacted_users": { + "description": "Count of users impacted by the issue over the queried time window.", + "example": 4, + "format": "int64", + "type": "integer" + }, + "total_count": { + "description": "Total count of errors that match the issue over the queried time window.", + "example": 82, + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "IssuesSearchResultIncluded": { + "description": "An array of related resources, returned when the `include` query parameter is used.", + "oneOf": [ + { + "description": "The issue matching the request.", + "properties": { + "attributes": { + "description": "Object containing the information of an issue.", + "properties": { + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", + "type": "string" + }, + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", + "type": "string" + }, + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", + "type": "string" + }, + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" + }, + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", + "type": "string" + }, + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" + }, + "is_crash": { + "description": "Error is a crash.", + "example": false, + "type": "boolean" + }, + "languages": { + "description": "Array of programming languages associated with the issue.", + "example": [ + "PYTHON", + "GO" + ], + "items": { + "description": "Programming language associated with the issue.", + "enum": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ], + "example": "PYTHON", + "type": "string", + "x-enum-varnames": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ] + }, + "type": "array" + }, + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" + }, + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ] + }, + "service": { + "description": "Service name.", + "example": "email-api-py", + "type": "string" + }, + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "type": "object" + }, + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "relationships": { + "description": "Relationship between the issue and an assignee, case and/or teams.", + "properties": { + "assignee": { + "description": "Relationship between the issue and assignee.", + "properties": { + "data": { + "description": "The user the issue is assigned to.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "case": { + "description": "Relationship between the issue and case.", + "properties": { + "data": { + "description": "The case the issue is attached to.", + "properties": { + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A case", + "properties": { + "attributes": { + "description": "Case resource attributes", + "properties": { + "archived_at": { + "description": "Timestamp of when the case was archived", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "attributes": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, + "description": "The definition of `CaseObjectAttributes` object.", + "type": "object" + }, + "closed_at": { + "description": "Timestamp of when the case was closed", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "created_at": { + "description": "Timestamp of when the case was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description", + "type": "string" + }, + "jira_issue": { + "description": "Jira issue attached to case", + "nullable": true, + "properties": { + "result": { + "description": "Jira issue information", + "properties": { + "issue_id": { + "description": "Jira issue ID", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL", + "type": "string" + }, + "project_key": { + "description": "Jira project key", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "default": "IN_PROGRESS", + "description": "Case status", + "enum": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ], + "example": "COMPLETED", + "readOnly": true, + "type": "string", + "x-enum-varnames": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + } + }, + "readOnly": true, + "type": "object" + }, + "key": { + "description": "Key", + "example": "CASEM-4523", + "type": "string" + }, + "modified_at": { + "description": "Timestamp of when the case was last modified", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] + }, + "service_now_ticket": { + "description": "ServiceNow ticket attached to case", + "nullable": true, + "properties": { + "result": { + "description": "ServiceNow ticket information", + "properties": { + "sys_target_link": { + "description": "Link to the Incident created on ServiceNow", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "default": "IN_PROGRESS", + "description": "Case status", + "enum": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ], + "example": "COMPLETED", + "readOnly": true, + "type": "string", + "x-enum-varnames": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + } + }, + "readOnly": true, + "type": "object" + }, + "status": { + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ], + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] + }, + "title": { + "description": "Title", + "example": "Memory leak investigation on API", + "type": "string" + }, + "type": { + "description": "Case type", + "enum": [ + "STANDARD" + ], + "example": "STANDARD", + "type": "string", + "x-enum-varnames": [ + "STANDARD" + ] + } + }, + "type": "object" + }, + "id": { + "description": "Case's identifier", + "example": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "relationships": { + "description": "Resources related to a case", + "properties": { + "assignee": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "created_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modified_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "project": { + "description": "Relationship to project", + "properties": { + "data": { + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" + }, + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "case", + "description": "Case resource type", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "The user to whom the issue is assigned.", + "properties": { + "attributes": { + "description": "Object containing the information of a user.", + "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "User Name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + ] + }, + "IssuesSearchResultIssueRelationship": { + "description": "Relationship between the search result and the corresponding issue.", + "properties": { + "data": { + "description": "The issue the search result corresponds to.", + "properties": { + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "IssuesSearchResultRelationships": { + "description": "Relationships between the search result and other resources.", + "properties": { + "issue": { + "description": "Relationship between the search result and the corresponding issue.", + "properties": { + "data": { + "description": "The issue the search result corresponds to.", + "properties": { + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "IssuesSearchResultType": { + "description": "Type of the object.", + "enum": [ + "error_tracking_search_result" + ], + "example": "error_tracking_search_result", + "type": "string", + "x-enum-varnames": [ + "ERROR_TRACKING_SEARCH_RESULT" + ] + }, + "JSONAPIErrorItem": { + "description": "API error response body", + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the error.", + "example": "Missing required attribute in body", + "type": "string" + }, + "meta": { + "additionalProperties": {}, + "description": "Non-standard meta-information about the error", + "type": "object" + }, + "source": { + "description": "References to the source of the error.", + "properties": { + "header": { + "description": "A string indicating the name of a single request header which caused the error.", + "example": "Authorization", + "type": "string" + }, + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "limit", + "type": "string" + }, + "pointer": { + "description": "A JSON pointer to the value in the request document that caused the error.", + "example": "/data/attributes/title", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Status code of the response.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short human-readable summary of the error.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "JSONAPIErrorItemSource": { + "description": "References to the source of the error.", + "properties": { + "header": { + "description": "A string indicating the name of a single request header which caused the error.", + "example": "Authorization", + "type": "string" + }, + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "limit", + "type": "string" + }, + "pointer": { + "description": "A JSON pointer to the value in the request document that caused the error.", + "example": "/data/attributes/title", + "type": "string" + } + }, + "type": "object" + }, + "JSONAPIErrorResponse": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "items": { + "description": "API error response body", + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the error.", + "example": "Missing required attribute in body", + "type": "string" + }, + "meta": { + "additionalProperties": {}, + "description": "Non-standard meta-information about the error", + "type": "object" + }, + "source": { + "description": "References to the source of the error.", + "properties": { + "header": { + "description": "A string indicating the name of a single request header which caused the error.", + "example": "Authorization", + "type": "string" + }, + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "limit", + "type": "string" + }, + "pointer": { + "description": "A JSON pointer to the value in the request document that caused the error.", + "example": "/data/attributes/title", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Status code of the response.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short human-readable summary of the error.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + }, + "JiraIntegrationMetadata": { + "description": "Incident integration metadata for the Jira integration.", + "properties": { + "issues": { + "description": "Array of Jira issues in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Jira integration metadata issue array.", + "properties": { + "account": { + "description": "URL of issue's Jira account.", + "example": "https://example.atlassian.net", + "type": "string" + }, + "issue_key": { + "description": "Jira issue's issue key.", + "example": "PROJ-123", + "type": "string" + }, + "issuetype_id": { + "description": "Jira issue's issue type.", + "example": "1000", + "type": "string" + }, + "project_key": { + "description": "Jira issue's project keys.", + "example": "PROJ", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Jira issue.", + "example": "https://example.atlassian.net/browse/PROJ-123", + "type": "string" + } + }, + "required": [ + "project_key", + "account" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "issues" + ], + "type": "object" + }, + "JiraIntegrationMetadataIssuesItem": { + "description": "Item in the Jira integration metadata issue array.", + "properties": { + "account": { + "description": "URL of issue's Jira account.", + "example": "https://example.atlassian.net", + "type": "string" + }, + "issue_key": { + "description": "Jira issue's issue key.", + "example": "PROJ-123", + "type": "string" + }, + "issuetype_id": { + "description": "Jira issue's issue type.", + "example": "1000", + "type": "string" + }, + "project_key": { + "description": "Jira issue's project keys.", + "example": "PROJ", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Jira issue.", + "example": "https://example.atlassian.net/browse/PROJ-123", + "type": "string" + } + }, + "required": [ + "project_key", + "account" + ], + "type": "object" + }, + "JiraIssue": { + "description": "Jira issue attached to case", + "nullable": true, + "properties": { + "result": { + "description": "Jira issue information", + "properties": { + "issue_id": { + "description": "Jira issue ID", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL", + "type": "string" + }, + "project_key": { + "description": "Jira project key", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "default": "IN_PROGRESS", + "description": "Case status", + "enum": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ], + "example": "COMPLETED", + "readOnly": true, + "type": "string", + "x-enum-varnames": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + } + }, + "readOnly": true, + "type": "object" + }, + "JiraIssueResult": { + "description": "Jira issue information", + "properties": { + "issue_id": { + "description": "Jira issue ID", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL", + "type": "string" + }, + "project_key": { + "description": "Jira project key", + "type": "string" + } + }, + "type": "object" + }, + "JobCreateResponse": { + "description": "Run a historical job response.", + "properties": { + "data": { + "description": "The definition of `JobCreateResponseData` object.", + "properties": { + "id": { + "description": "ID of the created job.", + "type": "string" + }, + "type": { + "description": "Type of payload.", + "enum": [ + "historicalDetectionsJob" + ], + "type": "string", + "x-enum-varnames": [ + "HISTORICALDETECTIONSJOB" + ] + } + }, + "type": "object" + } + }, + "type": "object" + }, + "JobCreateResponseData": { + "description": "The definition of `JobCreateResponseData` object.", + "properties": { + "id": { + "description": "ID of the created job.", + "type": "string" + }, + "type": { + "description": "Type of payload.", + "enum": [ + "historicalDetectionsJob" + ], + "type": "string", + "x-enum-varnames": [ + "HISTORICALDETECTIONSJOB" + ] + } + }, + "type": "object" + }, + "JobDefinition": { + "description": "Definition of a historical job.", + "properties": { + "calculatedFields": { + "description": "Calculated fields.", + "items": { + "description": "Calculated field.", + "properties": { + "expression": { + "description": "Expression.", + "example": "@request_end_timestamp - @request_start_timestamp", + "type": "string" + }, + "name": { + "description": "Field name.", + "example": "response_time", + "type": "string" + } + }, + "required": [ + "name", + "expression" + ], + "type": "object" + }, + "type": "array" + }, + "cases": { + "description": "Cases used for generating job results.", + "items": { + "description": "Case when signal is generated.", + "properties": { + "actions": { + "description": "Action to perform for each rule case.", + "items": { + "description": "Action to perform when a signal is triggered. Only available for Application Security rule type.", + "properties": { + "options": { + "additionalProperties": {}, + "description": "Options for the rule action", + "properties": { + "duration": { + "description": "Duration of the action in seconds. 0 indicates no expiration.", + "example": 0, + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "flaggedIPType": { + "description": "Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses.", + "enum": [ + "SUSPICIOUS", + "FLAGGED" + ], + "example": "FLAGGED", + "type": "string", + "x-enum-varnames": [ + "SUSPICIOUS", + "FLAGGED" + ] + }, + "userBehaviorName": { + "description": "Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "description": "The action type.", + "enum": [ + "block_ip", + "block_user", + "user_behavior", + "flag_ip" + ], + "type": "string", + "x-enum-varnames": [ + "BLOCK_IP", + "BLOCK_USER", + "USER_BEHAVIOR", + "FLAG_IP" + ] + } + }, + "type": "object" + }, + "type": "array" + }, + "condition": { + "description": "A case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated\nbased on the event counts in the previously defined queries.", + "type": "string" + }, + "name": { + "description": "Name of the case.", + "type": "string" + }, + "notifications": { + "description": "Notification targets.", + "items": { + "description": "Notification.", + "type": "string" + }, + "type": "array" + }, + "status": { + "description": "Severity of the Security Signal.", + "enum": [ + "info", + "low", + "medium", + "high", + "critical" + ], + "example": "critical", + "type": "string", + "x-enum-varnames": [ + "INFO", + "LOW", + "MEDIUM", + "HIGH", + "CRITICAL" + ] + } + }, + "required": [ + "status" + ], + "type": "object" + }, + "type": "array" + }, + "from": { + "description": "Starting time of data analyzed by the job.", + "example": 1729843470000, + "format": "int64", + "type": "integer" + }, + "groupSignalsBy": { + "description": "Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.", + "example": [ + "service" + ], + "items": { + "description": "Field to group by.", + "type": "string" + }, + "type": "array" + }, + "index": { + "description": "Index used to load the data.", + "example": "cloud_siem", + "type": "string" + }, + "message": { + "description": "Message for generated results.", + "example": "A large number of failed login attempts.", + "type": "string" + }, + "name": { + "description": "Job name.", + "example": "Excessive number of failed attempts.", + "type": "string" + }, + "options": { + "description": "Job options.", + "properties": { + "detectionMethod": { + "description": "The detection method.", + "enum": [ + "threshold", + "new_value", + "anomaly_detection", + "impossible_travel", + "hardcoded", + "third_party", + "anomaly_threshold" + ], + "type": "string", + "x-enum-varnames": [ + "THRESHOLD", + "NEW_VALUE", + "ANOMALY_DETECTION", + "IMPOSSIBLE_TRAVEL", + "HARDCODED", + "THIRD_PARTY", + "ANOMALY_THRESHOLD" + ] + }, + "evaluationWindow": { + "description": "A time window is specified to match when at least one of the cases matches true. This is a sliding window\nand evaluates in real time. For third party detection method, this field is not used.", + "enum": [ + 0, + 60, + 300, + 600, + 900, + 1800, + 3600, + 7200, + 10800, + 21600, + 43200, + 86400 + ], + "format": "int32", + "type": "integer", + "x-enum-varnames": [ + "ZERO_MINUTES", + "ONE_MINUTE", + "FIVE_MINUTES", + "TEN_MINUTES", + "FIFTEEN_MINUTES", + "THIRTY_MINUTES", + "ONE_HOUR", + "TWO_HOURS", + "THREE_HOURS", + "SIX_HOURS", + "TWELVE_HOURS", + "ONE_DAY" + ] + }, + "impossibleTravelOptions": { + "description": "Options on impossible travel detection method.", + "properties": { + "baselineUserLocations": { + "description": "If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "keepAlive": { + "description": "Once a signal is generated, the signal will remain \"open\" if a case is matched at least once within\nthis keep alive window. For third party detection method, this field is not used.", + "enum": [ + 0, + 60, + 300, + 600, + 900, + 1800, + 3600, + 7200, + 10800, + 21600, + 43200, + 86400 + ], + "format": "int32", + "type": "integer", + "x-enum-varnames": [ + "ZERO_MINUTES", + "ONE_MINUTE", + "FIVE_MINUTES", + "TEN_MINUTES", + "FIFTEEN_MINUTES", + "THIRTY_MINUTES", + "ONE_HOUR", + "TWO_HOURS", + "THREE_HOURS", + "SIX_HOURS", + "TWELVE_HOURS", + "ONE_DAY" + ] + }, + "maxSignalDuration": { + "description": "A signal will \"close\" regardless of the query being matched once the time exceeds the maximum duration.\nThis time is calculated from the first seen timestamp.", + "enum": [ + 0, + 60, + 300, + 600, + 900, + 1800, + 3600, + 7200, + 10800, + 21600, + 43200, + 86400 + ], + "format": "int32", + "type": "integer", + "x-enum-varnames": [ + "ZERO_MINUTES", + "ONE_MINUTE", + "FIVE_MINUTES", + "TEN_MINUTES", + "FIFTEEN_MINUTES", + "THIRTY_MINUTES", + "ONE_HOUR", + "TWO_HOURS", + "THREE_HOURS", + "SIX_HOURS", + "TWELVE_HOURS", + "ONE_DAY" + ] + }, + "newValueOptions": { + "description": "Options on new value detection method.", + "properties": { + "forgetAfter": { + "description": "The duration in days after which a learned value is forgotten.", + "enum": [ + 1, + 2, + 7, + 14, + 21, + 28 + ], + "format": "int32", + "type": "integer", + "x-enum-varnames": [ + "ONE_DAY", + "TWO_DAYS", + "ONE_WEEK", + "TWO_WEEKS", + "THREE_WEEKS", + "FOUR_WEEKS" + ] + }, + "learningDuration": { + "default": 0, + "description": "The duration in days during which values are learned, and after which signals will be generated for values that\nweren't learned. If set to 0, a signal will be generated for all new values after the first value is learned.", + "enum": [ + 0, + 1, + 7 + ], + "format": "int32", + "type": "integer", + "x-enum-varnames": [ + "ZERO_DAYS", + "ONE_DAY", + "SEVEN_DAYS" + ] + }, + "learningMethod": { + "default": "duration", + "description": "The learning method used to determine when signals should be generated for values that weren't learned.", + "enum": [ + "duration", + "threshold" + ], + "type": "string", + "x-enum-varnames": [ + "DURATION", + "THRESHOLD" + ] + }, + "learningThreshold": { + "default": 0, + "description": "A number of occurrences after which signals will be generated for values that weren't learned.", + "enum": [ + 0, + 1 + ], + "format": "int32", + "type": "integer", + "x-enum-varnames": [ + "ZERO_OCCURRENCES", + "ONE_OCCURRENCE" + ] + } + }, + "type": "object" + }, + "thirdPartyRuleOptions": { + "description": "Options on third party detection method.", + "properties": { + "defaultNotifications": { + "description": "Notification targets for the logs that do not correspond to any of the cases.", + "items": { + "description": "Notification.", + "type": "string" + }, + "type": "array" + }, + "defaultStatus": { + "description": "Severity of the Security Signal.", + "enum": [ + "info", + "low", + "medium", + "high", + "critical" + ], + "example": "critical", + "type": "string", + "x-enum-varnames": [ + "INFO", + "LOW", + "MEDIUM", + "HIGH", + "CRITICAL" + ] + }, + "rootQueries": { + "description": "Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.", + "items": { + "description": "A query to be combined with the third party case query.", + "properties": { + "groupByFields": { + "description": "Fields to group by.", + "items": { + "description": "Field.", + "type": "string" + }, + "type": "array" + }, + "query": { + "description": "Query to run on logs.", + "example": "source:cloudtrail", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "signalTitleTemplate": { + "description": "A template for the signal title; if omitted, the title is generated based on the case name.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "queries": { + "description": "Queries for selecting logs analyzed by the job.", + "items": { + "description": "Query for selecting logs analyzed by the historical job.", + "properties": { + "aggregation": { + "description": "The aggregation type.", + "enum": [ + "count", + "cardinality", + "sum", + "max", + "new_value", + "geo_data", + "event_count", + "none" + ], + "type": "string", + "x-enum-varnames": [ + "COUNT", + "CARDINALITY", + "SUM", + "MAX", + "NEW_VALUE", + "GEO_DATA", + "EVENT_COUNT", + "NONE" + ] + }, + "dataSource": { + "default": "logs", + "description": "Source of events, either logs, audit trail, or Datadog events.", + "enum": [ + "logs", + "audit", + "app_sec_spans", + "spans", + "security_runtime", + "network", + "events" + ], + "example": "logs", + "type": "string", + "x-enum-varnames": [ + "LOGS", + "AUDIT", + "APP_SEC_SPANS", + "SPANS", + "SECURITY_RUNTIME", + "NETWORK", + "EVENTS" + ] + }, + "distinctFields": { + "description": "Field for which the cardinality is measured. Sent as an array.", + "items": { + "description": "Field.", + "type": "string" + }, + "type": "array" + }, + "groupByFields": { + "description": "Fields to group by.", + "items": { + "description": "Field.", + "type": "string" + }, + "type": "array" + }, + "hasOptionalGroupByFields": { + "description": "When false, events without a group-by value are ignored by the query. When true, events with missing group-by fields are processed with `N/A`, replacing the missing values.", + "example": false, + "readOnly": true, + "type": "boolean" + }, + "metrics": { + "description": "Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.", + "items": { + "description": "Field.", + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name of the query.", + "type": "string" + }, + "query": { + "description": "Query to run on logs.", + "example": "a > 3", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "referenceTables": { + "description": "Reference tables used in the queries.", + "items": { + "description": "Reference tables used in the queries.", + "properties": { + "checkPresence": { + "description": "Whether to include or exclude the matched values.", + "type": "boolean" + }, + "columnName": { + "description": "The name of the column in the reference table.", + "type": "string" + }, + "logFieldPath": { + "description": "The field in the log to match against the reference table.", + "type": "string" + }, + "ruleQueryName": { + "description": "The name of the query to apply the reference table to.", + "type": "string" + }, + "tableName": { + "description": "The name of the reference table.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "tags": { + "description": "Tags for generated signals.", + "items": { + "type": "string" + }, + "type": "array" + }, + "thirdPartyCases": { + "description": "Cases for generating results from third-party detection method. Only available for third-party detection method.", + "example": [], + "items": { + "description": "Case when a signal is generated by a third party rule.", + "properties": { + "name": { + "description": "Name of the case.", + "type": "string" + }, + "notifications": { + "description": "Notification targets for each case.", + "items": { + "description": "Notification.", + "type": "string" + }, + "type": "array" + }, + "query": { + "description": "A query to map a third party event to this case.", + "type": "string" + }, + "status": { + "description": "Severity of the Security Signal.", + "enum": [ + "info", + "low", + "medium", + "high", + "critical" + ], + "example": "critical", + "type": "string", + "x-enum-varnames": [ + "INFO", + "LOW", + "MEDIUM", + "HIGH", + "CRITICAL" + ] + } + }, + "required": [ + "status" + ], + "type": "object" + }, + "type": "array" + }, + "to": { + "description": "Ending time of data analyzed by the job.", + "example": 1729847070000, + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Job type.", + "type": "string" + } + }, + "required": [ + "from", + "to", + "index", + "name", + "cases", + "queries", + "message" + ], + "type": "object" + }, + "JobDefinitionFromRule": { + "description": "Definition of a historical job based on a security monitoring rule.", + "properties": { + "from": { + "description": "Starting time of data analyzed by the job.", + "example": 1729843470000, + "format": "int64", + "type": "integer" + }, + "id": { + "description": "ID of the detection rule used to create the job.", + "example": "abc-def-ghi", + "type": "string" + }, + "index": { + "description": "Index used to load the data.", + "example": "cloud_siem", + "type": "string" + }, + "notifications": { + "description": "Notifications sent when the job is completed.", + "example": [ + "@sns-cloudtrail-results" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "to": { + "description": "Ending time of data analyzed by the job.", + "example": 1729847070000, + "format": "int64", + "type": "integer" + } + }, + "required": [ + "id", + "from", + "to", + "index" + ], + "type": "object" + }, + "KindAttributes": { + "description": "Kind attributes.", + "properties": { + "description": { + "description": "Short description of the kind.", + "type": "string" + }, + "displayName": { + "description": "User friendly name of the kind.", + "type": "string" + }, + "name": { + "description": "The kind name.", + "example": "my-job", + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "KindData": { + "description": "Schema that defines the structure of a Kind object in the Software Catalog.", + "properties": { + "attributes": { + "description": "Kind attributes.", + "properties": { + "description": { + "description": "Short description of the kind.", + "type": "string" + }, + "displayName": { + "description": "User friendly name of the kind.", + "type": "string" + }, + "name": { + "description": "The kind name.", + "example": "my-job", + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.", + "example": "4b163705-23c0-4573-b2fb-f6cea2163fcb", + "minLength": 1, + "type": "string" + }, + "meta": { + "description": "Kind metadata.", + "properties": { + "createdAt": { + "description": "The creation time.", + "type": "string" + }, + "modifiedAt": { + "description": "The modification time.", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "description": "Kind.", + "type": "string" + } + }, + "type": "object" + }, + "KindMetadata": { + "description": "Kind metadata.", + "properties": { + "createdAt": { + "description": "The creation time.", + "type": "string" + }, + "modifiedAt": { + "description": "The modification time.", + "type": "string" + } + }, + "type": "object" + }, + "KindObj": { + "description": "Schema for kind.", + "properties": { + "description": { + "description": "Short description of the kind.", + "type": "string" + }, + "displayName": { + "description": "The display name of the kind. Automatically generated if not provided.", + "type": "string" + }, + "kind": { + "description": "The name of the kind to create or update. This must be in kebab-case format.", + "example": "my-job", + "type": "string" + } + }, + "required": [ + "kind" + ], + "type": "object" + }, + "KindRaw": { + "description": "Kind definition in raw JSON or YAML representation.", + "example": "kind: service\ndisplayName: Service\ndescription: A service entity in the catalog.\n", + "type": "string" + }, + "KindResponseData": { + "description": "List of kind responses.", + "items": { + "description": "Schema that defines the structure of a Kind object in the Software Catalog.", + "properties": { + "attributes": { + "description": "Kind attributes.", + "properties": { + "description": { + "description": "Short description of the kind.", + "type": "string" + }, + "displayName": { + "description": "User friendly name of the kind.", + "type": "string" + }, + "name": { + "description": "The kind name.", + "example": "my-job", + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.", + "example": "4b163705-23c0-4573-b2fb-f6cea2163fcb", + "minLength": 1, + "type": "string" + }, + "meta": { + "description": "Kind metadata.", + "properties": { + "createdAt": { + "description": "The creation time.", + "type": "string" + }, + "modifiedAt": { + "description": "The modification time.", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "description": "Kind.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "KindResponseMeta": { + "description": "Kind response metadata.", + "properties": { + "count": { + "description": "Total kinds count.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "LaunchDarklyAPIKey": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "properties": { + "api_token": { + "description": "The `LaunchDarklyAPIKey` `api_token`.", + "example": "", + "type": "string" + }, + "type": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "enum": [ + "LaunchDarklyAPIKey" + ], + "example": "LaunchDarklyAPIKey", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLYAPIKEY" + ] + } + }, + "required": [ + "type", + "api_token" + ], + "type": "object" + }, + "LaunchDarklyAPIKeyType": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "enum": [ + "LaunchDarklyAPIKey" + ], + "example": "LaunchDarklyAPIKey", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLYAPIKEY" + ] + }, + "LaunchDarklyAPIKeyUpdate": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "properties": { + "api_token": { + "description": "The `LaunchDarklyAPIKeyUpdate` `api_token`.", + "type": "string" + }, + "type": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "enum": [ + "LaunchDarklyAPIKey" + ], + "example": "LaunchDarklyAPIKey", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLYAPIKEY" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "LaunchDarklyCredentials": { + "description": "The definition of the `LaunchDarklyCredentials` object.", + "oneOf": [ + { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "properties": { + "api_token": { + "description": "The `LaunchDarklyAPIKey` `api_token`.", + "example": "", + "type": "string" + }, + "type": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "enum": [ + "LaunchDarklyAPIKey" + ], + "example": "LaunchDarklyAPIKey", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLYAPIKEY" + ] + } + }, + "required": [ + "type", + "api_token" + ], + "type": "object" + } + ] + }, + "LaunchDarklyCredentialsUpdate": { + "description": "The definition of the `LaunchDarklyCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "properties": { + "api_token": { + "description": "The `LaunchDarklyAPIKeyUpdate` `api_token`.", + "type": "string" + }, + "type": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "enum": [ + "LaunchDarklyAPIKey" + ], + "example": "LaunchDarklyAPIKey", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLYAPIKEY" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "LaunchDarklyIntegration": { + "description": "The definition of the `LaunchDarklyIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of the `LaunchDarklyCredentials` object.", + "oneOf": [ + { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "properties": { + "api_token": { + "description": "The `LaunchDarklyAPIKey` `api_token`.", + "example": "", + "type": "string" + }, + "type": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "enum": [ + "LaunchDarklyAPIKey" + ], + "example": "LaunchDarklyAPIKey", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLYAPIKEY" + ] + } + }, + "required": [ + "type", + "api_token" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of the `LaunchDarklyIntegrationType` object.", + "enum": [ + "LaunchDarkly" + ], + "example": "LaunchDarkly", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLY" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + "LaunchDarklyIntegrationType": { + "description": "The definition of the `LaunchDarklyIntegrationType` object.", + "enum": [ + "LaunchDarkly" + ], + "example": "LaunchDarkly", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLY" + ] + }, + "LaunchDarklyIntegrationUpdate": { + "description": "The definition of the `LaunchDarklyIntegrationUpdate` object.", + "properties": { + "credentials": { + "description": "The definition of the `LaunchDarklyCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "properties": { + "api_token": { + "description": "The `LaunchDarklyAPIKeyUpdate` `api_token`.", + "type": "string" + }, + "type": { + "description": "The definition of the `LaunchDarklyAPIKey` object.", + "enum": [ + "LaunchDarklyAPIKey" + ], + "example": "LaunchDarklyAPIKey", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLYAPIKEY" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of the `LaunchDarklyIntegrationType` object.", + "enum": [ + "LaunchDarkly" + ], + "example": "LaunchDarkly", + "type": "string", + "x-enum-varnames": [ + "LAUNCHDARKLY" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "Layer": { + "description": "Encapsulates a layer resource, holding attributes like rotation details, plus relationships to the members covering that layer.", + "properties": { + "attributes": { + "description": "Describes key properties of a Layer, including rotation details, name, start/end times, and any restrictions.", + "properties": { + "effective_date": { + "description": "When the layer becomes active (ISO 8601).", + "format": "date-time", + "type": "string" + }, + "end_date": { + "description": "When the layer ceases to be active (ISO 8601).", + "format": "date-time", + "type": "string" + }, + "interval": { + "description": "Defines how often the rotation repeats, using a combination of days and optional seconds. Should be at least 1 hour.", + "properties": { + "days": { + "description": "The number of days in each rotation cycle.", + "example": 1, + "format": "int32", + "maximum": 400, + "type": "integer" + }, + "seconds": { + "description": "Any additional seconds for the rotation cycle (up to 30 days).", + "example": 300, + "format": "int64", + "maximum": 2592000, + "type": "integer" + } + }, + "type": "object" + }, + "name": { + "description": "The name of this layer.", + "example": "Weekend Layer", + "type": "string" + }, + "restrictions": { + "description": "An optional list of time restrictions for when this layer is in effect.", + "items": { + "description": "Defines a single time restriction rule with start and end times and the applicable weekdays.", + "properties": { + "end_day": { + "description": "A day of the week.", + "enum": [ + "monday", + "tuesday", + "wednesday", + "thursday", + "friday", + "saturday", + "sunday" + ], + "type": "string", + "x-enum-varnames": [ + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ] + }, + "end_time": { + "description": "Specifies the ending time for this restriction.", + "type": "string" + }, + "start_day": { + "description": "A day of the week.", + "enum": [ + "monday", + "tuesday", + "wednesday", + "thursday", + "friday", + "saturday", + "sunday" + ], + "type": "string", + "x-enum-varnames": [ + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ] + }, + "start_time": { + "description": "Specifies the starting time for this restriction.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "rotation_start": { + "description": "The date/time when the rotation starts (ISO 8601).", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "A unique identifier for this layer.", + "type": "string" + }, + "relationships": { + "description": "Holds references to objects related to the Layer entity, such as its members.", + "properties": { + "members": { + "description": "Holds an array of references to the members of a Layer, each containing member IDs.", + "properties": { + "data": { + "description": "The list of members who belong to this layer.", + "items": { + "description": "Represents a single member object in a layer's `members` array, referencing\na unique Datadog user ID.", + "properties": { + "id": { + "description": "The unique user ID of the layer member.", + "example": "00000000-0000-0000-0000-000000000002", + "type": "string" + }, + "type": { + "default": "members", + "description": "Members resource type.", + "enum": [ + "members" + ], + "example": "members", + "type": "string", + "x-enum-varnames": [ + "MEMBERS" + ] + } + }, + "required": [ "type", "id" ], @@ -262676,6 +268261,23 @@ "SCORECARD" ] }, + "SearchIssuesIncludeQueryParameterItem": { + "description": "Relationship object that should be included in the search response.", + "enum": [ + "issue", + "issue.assignee", + "issue.case", + "issue.team_owners" + ], + "example": "issue.case", + "type": "string", + "x-enum-varnames": [ + "ISSUE", + "ISSUE_ASSIGNEE", + "ISSUE_CASE", + "ISSUE_TEAM_OWNERS" + ] + }, "SecurityFilter": { "description": "The security filter's properties.", "properties": { @@ -349795,6 +355397,8 @@ "data_scanner_read": "View Data Scanner configurations.", "data_scanner_write": "Edit Data Scanner configurations.", "embeddable_graphs_share": "Generate public links to share embeddable graphs externally.", + "error_tracking_read": "Read Error Tracking data.", + "error_tracking_write": "Edit Error Tracking issues.", "events_read": "Read Events data.", "hosts_read": "List hosts and their attributes.", "incident_notification_settings_write": "Configure Incidents Notification settings.", @@ -415569,14 +421173,800 @@ "required": [ "type" ], - "type": "object" + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "org_management" + ] + }, + { + "AuthZ": [ + "monitors_write" + ] + } + ], + "summary": "Get Domain Allowlist", + "tags": [ + "Domain Allowlist" + ], + "x-menu-order": 1, + "x-permission": { + "operator": "OR", + "permissions": [ + "org_management", + "monitors_write", + "generate_dashboard_reports", + "generate_log_reports", + "manage_log_reports" + ] + }, + "x-undo": { + "type": "safe" + } + }, + "patch": { + "description": "Update the domain allowlist for an organization.", + "operationId": "PatchDomainAllowlist", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request containing the desired email domain allowlist configuration.", + "properties": { + "data": { + "description": "The email domain allowlist for an org.", + "properties": { + "attributes": { + "description": "The details of the email domain allowlist.", + "properties": { + "domains": { + "description": "The list of domains in the email domain allowlist.", + "items": { + "type": "string" + }, + "type": "array" + }, + "enabled": { + "description": "Whether the email domain allowlist is enabled for the org.", + "type": "boolean" + } + }, + "type": "object", + "x-ignore-duplicate-object": true + }, + "id": { + "description": "The unique identifier of the org.", + "nullable": true, + "type": "string" + }, + "type": { + "default": "domain_allowlist", + "description": "Email domain allowlist allowlist type.", + "enum": [ + "domain_allowlist" + ], + "example": "domain_allowlist", + "type": "string", + "x-enum-varnames": [ + "DOMAIN_ALLOWLIST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response containing information about the email domain allowlist.", + "properties": { + "data": { + "description": "The email domain allowlist response for an org.", + "properties": { + "attributes": { + "description": "The details of the email domain allowlist.", + "properties": { + "domains": { + "description": "The list of domains in the email domain allowlist.", + "items": { + "type": "string" + }, + "type": "array" + }, + "enabled": { + "description": "Whether the email domain allowlist is enabled for the org.", + "type": "boolean" + } + }, + "type": "object", + "x-ignore-duplicate-object": true + }, + "id": { + "description": "The unique identifier of the org.", + "nullable": true, + "type": "string" + }, + "type": { + "default": "domain_allowlist", + "description": "Email domain allowlist allowlist type.", + "enum": [ + "domain_allowlist" + ], + "example": "domain_allowlist", + "type": "string", + "x-enum-varnames": [ + "DOMAIN_ALLOWLIST" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "org_management" + ] + }, + { + "AuthZ": [ + "monitors_write" + ] + } + ], + "summary": "Sets Domain Allowlist", + "tags": [ + "Domain Allowlist" + ], + "x-menu-order": 2, + "x-permission": { + "operator": "OR", + "permissions": [ + "org_management", + "monitors_write", + "generate_dashboard_reports", + "generate_log_reports", + "manage_log_reports" + ] + }, + "x-undo": { + "type": "idempotent" + } + } + }, + "/api/v2/dora/deployment": { + "post": { + "description": "Use this API endpoint to provide data about deployments for DORA metrics.\n\nThis is necessary for:\n- Deployment Frequency\n- Change Lead Time\n- Change Failure Rate", + "operationId": "CreateDORADeployment", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request to create a DORA deployment event.", + "properties": { + "data": { + "description": "The JSON:API data.", + "properties": { + "attributes": { + "description": "Attributes to create a DORA deployment event.", + "properties": { + "custom_tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern. Up to 100 may be added per event.", + "example": [ + "language:java", + "department:engineering" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "env": { + "description": "Environment name to where the service was deployed.", + "example": "staging", + "type": "string" + }, + "finished_at": { + "description": "Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds, and it should not be older than 1 hour.", + "example": 1693491984000000000, + "format": "int64", + "type": "integer" + }, + "git": { + "description": "Git info for DORA Metrics events.", + "properties": { + "commit_sha": { + "description": "Git Commit SHA.", + "example": "66adc9350f2cc9b250b69abddab733dd55e1a588", + "pattern": "^[a-fA-F0-9]{40,}$", + "type": "string" + }, + "repository_url": { + "description": "Git Repository URL", + "example": "https://github.com/organization/example-repository", + "type": "string" + } + }, + "required": [ + "repository_url", + "commit_sha" + ], + "type": "object" + }, + "id": { + "description": "Deployment ID.", + "type": "string" + }, + "service": { + "description": "Service name.", + "example": "shopist", + "type": "string" + }, + "started_at": { + "description": "Unix timestamp when the deployment started. It must be in nanoseconds, milliseconds, or seconds.", + "example": 1693491974000000000, + "format": "int64", + "type": "integer" + }, + "team": { + "description": "Name of the team owning the deployed service. If not provided, this is automatically populated with the team associated with the service in the Service Catalog.", + "example": "backend", + "type": "string" + }, + "version": { + "description": "Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/).", + "example": "v1.12.07", + "type": "string" + } + }, + "required": [ + "service", + "started_at", + "finished_at" + ], + "type": "object" + } + }, + "required": [ + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response after receiving a DORA deployment event.", + "properties": { + "data": { + "description": "The JSON:API data.", + "properties": { + "id": { + "description": "The ID of the received DORA deployment event.", + "example": "4242fcdd31586083", + "type": "string" + }, + "type": { + "default": "dora_deployment", + "description": "JSON:API type for DORA deployment events.", + "enum": [ + "dora_deployment" + ], + "example": "dora_deployment", + "type": "string", + "x-enum-varnames": [ + "DORA_DEPLOYMENT" + ] + } + }, + "required": [ + "id" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "OK" + }, + "202": { + "content": { + "application/json": { + "schema": { + "description": "Response after receiving a DORA deployment event.", + "properties": { + "data": { + "description": "The JSON:API data.", + "properties": { + "id": { + "description": "The ID of the received DORA deployment event.", + "example": "4242fcdd31586083", + "type": "string" + }, + "type": { + "default": "dora_deployment", + "description": "JSON:API type for DORA deployment events.", + "enum": [ + "dora_deployment" + ], + "example": "dora_deployment", + "type": "string", + "x-enum-varnames": [ + "DORA_DEPLOYMENT" + ] + } + }, + "required": [ + "id" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "OK - but delayed due to incident" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "items": { + "description": "API error response body", + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the error.", + "example": "Missing required attribute in body", + "type": "string" + }, + "meta": { + "additionalProperties": {}, + "description": "Non-standard meta-information about the error", + "type": "object" + }, + "source": { + "description": "References to the source of the error.", + "properties": { + "header": { + "description": "A string indicating the name of a single request header which caused the error.", + "example": "Authorization", + "type": "string" + }, + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "limit", + "type": "string" + }, + "pointer": { + "description": "A JSON pointer to the value in the request document that caused the error.", + "example": "/data/attributes/title", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Status code of the response.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short human-readable summary of the error.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Authorized" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [] + } + ], + "summary": "Send a deployment event for DORA Metrics", + "tags": [ + "DORA Metrics" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 1, + "x-undo": { + "type": "idempotent" + } + } + }, + "/api/v2/dora/deployments": { + "post": { + "description": "Use this API endpoint to get a list of deployment events.", + "operationId": "ListDORADeployments", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request to get a list of deployments.", + "properties": { + "data": { + "description": "The JSON:API data.", + "properties": { + "attributes": { + "description": "Attributes to get a list of deployments.", + "properties": { + "from": { + "description": "Minimum timestamp for requested events.", + "format": "date-time", + "type": "string" + }, + "limit": { + "default": 10, + "description": "Maximum number of events in the response.", + "format": "int32", + "maximum": 1000, + "type": "integer" + }, + "query": { + "description": "Search query with event platform syntax.", + "type": "string" + }, + "sort": { + "description": "Sort order (prefixed with `-` for descending).", + "type": "string" + }, + "to": { + "description": "Maximum timestamp for requested events.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "description": "The definition of `DORAListDeploymentsRequestDataType` object.", + "enum": [ + "dora_deployments_list_request" + ], + "type": "string", + "x-enum-varnames": [ + "DORA_DEPLOYMENTS_LIST_REQUEST" + ] + } + }, + "required": [ + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response for the DORA list endpoints.", + "properties": { + "data": { + "description": "The list of DORA events.", + "items": { + "description": "A DORA event.", + "properties": { + "attributes": { + "description": "The attributes of the event.", + "type": "object" + }, + "id": { + "description": "The ID of the event.", + "type": "string" + }, + "type": { + "description": "The type of the event.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "items": { + "description": "API error response body", + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the error.", + "example": "Missing required attribute in body", + "type": "string" + }, + "meta": { + "additionalProperties": {}, + "description": "Non-standard meta-information about the error", + "type": "object" + }, + "source": { + "description": "References to the source of the error.", + "properties": { + "header": { + "description": "A string indicating the name of a single request header which caused the error.", + "example": "Authorization", + "type": "string" + }, + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "limit", + "type": "string" + }, + "pointer": { + "description": "A JSON pointer to the value in the request document that caused the error.", + "example": "/data/attributes/title", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Status code of the response.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short human-readable summary of the error.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" } }, + "required": [ + "errors" + ], "type": "object" } } }, - "description": "OK" + "description": "Not Authorized" }, "429": { "content": { @@ -415611,149 +422001,63 @@ { "apiKeyAuth": [], "appKeyAuth": [] - }, - { - "AuthZ": [ - "org_management" - ] - }, - { - "AuthZ": [ - "monitors_write" - ] } ], - "summary": "Get Domain Allowlist", + "summary": "Get a list of deployment events", "tags": [ - "Domain Allowlist" + "DORA Metrics" ], - "x-menu-order": 1, + "x-codegen-request-body-name": "body", + "x-menu-order": 3, "x-permission": { "operator": "OR", "permissions": [ - "org_management", - "monitors_write", - "generate_dashboard_reports", - "generate_log_reports", - "manage_log_reports" + "dora_metrics_read" ] }, "x-undo": { "type": "safe" } - }, - "patch": { - "description": "Update the domain allowlist for an organization.", - "operationId": "PatchDomainAllowlist", - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Request containing the desired email domain allowlist configuration.", - "properties": { - "data": { - "description": "The email domain allowlist for an org.", - "properties": { - "attributes": { - "description": "The details of the email domain allowlist.", - "properties": { - "domains": { - "description": "The list of domains in the email domain allowlist.", - "items": { - "type": "string" - }, - "type": "array" - }, - "enabled": { - "description": "Whether the email domain allowlist is enabled for the org.", - "type": "boolean" - } - }, - "type": "object", - "x-ignore-duplicate-object": true - }, - "id": { - "description": "The unique identifier of the org.", - "nullable": true, - "type": "string" - }, - "type": { - "default": "domain_allowlist", - "description": "Email domain allowlist allowlist type.", - "enum": [ - "domain_allowlist" - ], - "example": "domain_allowlist", - "type": "string", - "x-enum-varnames": [ - "DOMAIN_ALLOWLIST" - ] - } - }, - "required": [ - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } + } + }, + "/api/v2/dora/deployments/{deployment_id}": { + "get": { + "description": "Use this API endpoint to get a deployment event.", + "operationId": "GetDORADeployment", + "parameters": [ + { + "description": "The ID of the deployment event.", + "in": "path", + "name": "deployment_id", + "required": true, + "schema": { + "type": "string" } - }, - "required": true - }, + } + ], "responses": { "200": { "content": { "application/json": { "schema": { - "description": "Response containing information about the email domain allowlist.", + "description": "Response for the DORA fetch endpoints.", "properties": { "data": { - "description": "The email domain allowlist response for an org.", + "description": "A DORA event.", "properties": { "attributes": { - "description": "The details of the email domain allowlist.", - "properties": { - "domains": { - "description": "The list of domains in the email domain allowlist.", - "items": { - "type": "string" - }, - "type": "array" - }, - "enabled": { - "description": "Whether the email domain allowlist is enabled for the org.", - "type": "boolean" - } - }, - "type": "object", - "x-ignore-duplicate-object": true + "description": "The attributes of the event.", + "type": "object" }, "id": { - "description": "The unique identifier of the org.", - "nullable": true, + "description": "The ID of the event.", "type": "string" }, "type": { - "default": "domain_allowlist", - "description": "Email domain allowlist allowlist type.", - "enum": [ - "domain_allowlist" - ], - "example": "domain_allowlist", - "type": "string", - "x-enum-varnames": [ - "DOMAIN_ALLOWLIST" - ] + "description": "The type of the event.", + "type": "string" } }, - "required": [ - "type" - ], "type": "object" } }, @@ -415763,6 +422067,101 @@ }, "description": "OK" }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "items": { + "description": "API error response body", + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the error.", + "example": "Missing required attribute in body", + "type": "string" + }, + "meta": { + "additionalProperties": {}, + "description": "Non-standard meta-information about the error", + "type": "object" + }, + "source": { + "description": "References to the source of the error.", + "properties": { + "header": { + "description": "A string indicating the name of a single request header which caused the error.", + "example": "Authorization", + "type": "string" + }, + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "limit", + "type": "string" + }, + "pointer": { + "description": "A JSON pointer to the value in the request document that caused the error.", + "example": "/data/attributes/title", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Status code of the response.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short human-readable summary of the error.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Authorized" + }, "429": { "content": { "application/json": { @@ -415794,55 +422193,44 @@ }, "security": [ { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "org_management" - ] + "apiKeyAuth": [] }, { - "AuthZ": [ - "monitors_write" - ] + "appKeyAuth": [] } ], - "summary": "Sets Domain Allowlist", + "summary": "Get a deployment event", "tags": [ - "Domain Allowlist" + "DORA Metrics" ], - "x-menu-order": 2, + "x-codegen-request-body-name": "body", + "x-menu-order": 5, "x-permission": { "operator": "OR", "permissions": [ - "org_management", - "monitors_write", - "generate_dashboard_reports", - "generate_log_reports", - "manage_log_reports" + "dora_metrics_read" ] }, "x-undo": { - "type": "idempotent" + "type": "safe" } } }, - "/api/v2/dora/deployment": { + "/api/v2/dora/failure": { "post": { - "description": "Use this API endpoint to provide data about deployments for DORA metrics.\n\nThis is necessary for:\n- Deployment Frequency\n- Change Lead Time\n- Change Failure Rate", - "operationId": "CreateDORADeployment", + "description": "Use this API endpoint to provide failure data for DORA metrics.\n\nThis is necessary for:\n- Change Failure Rate\n- Time to Restore", + "operationId": "CreateDORAFailure", "requestBody": { "content": { "application/json": { "schema": { - "description": "Request to create a DORA deployment event.", + "description": "Request to create a DORA failure event.", "properties": { "data": { "description": "The JSON:API data.", "properties": { "attributes": { - "description": "Attributes to create a DORA deployment event.", + "description": "Attributes to create a DORA failure event.", "properties": { "custom_tags": { "description": "A list of user-defined tags. The tags must follow the `key:value` pattern. Up to 100 may be added per event.", @@ -415858,12 +422246,12 @@ "type": "array" }, "env": { - "description": "Environment name to where the service was deployed.", + "description": "Environment name that was impacted by the failure.", "example": "staging", "type": "string" }, "finished_at": { - "description": "Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds, and it should not be older than 1 hour.", + "description": "Unix timestamp when the failure finished. It must be in nanoseconds, milliseconds, or seconds, and it should not be older than 1 hour.", "example": 1693491984000000000, "format": "int64", "type": "integer" @@ -415890,22 +422278,37 @@ "type": "object" }, "id": { - "description": "Deployment ID.", + "description": "Failure ID. Must have at least 16 characters. Required to update a previously sent failure.", "type": "string" }, - "service": { - "description": "Service name.", - "example": "shopist", + "name": { + "description": "Failure name.", + "example": "Webserver is down failing all requests.", + "type": "string" + }, + "services": { + "description": "Service names impacted by the failure. If possible, use names registered in the Service Catalog. Required when the team field is not provided.", + "example": [ + "shopist" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "severity": { + "description": "Failure severity.", + "example": "High", "type": "string" }, "started_at": { - "description": "Unix timestamp when the deployment started. It must be in nanoseconds, milliseconds, or seconds.", + "description": "Unix timestamp when the failure started. It must be in nanoseconds, milliseconds, or seconds.", "example": 1693491974000000000, "format": "int64", "type": "integer" }, "team": { - "description": "Name of the team owning the deployed service. If not provided, this is automatically populated with the team associated with the service in the Service Catalog.", + "description": "Name of the team owning the services impacted. If possible, use team handles registered in Datadog. Required when the services field is not provided.", "example": "backend", "type": "string" }, @@ -415916,9 +422319,7 @@ } }, "required": [ - "service", - "started_at", - "finished_at" + "started_at" ], "type": "object" } @@ -415943,26 +422344,26 @@ "content": { "application/json": { "schema": { - "description": "Response after receiving a DORA deployment event.", + "description": "Response after receiving a DORA failure event.", "properties": { "data": { - "description": "The JSON:API data.", + "description": "Response after receiving a DORA failure event.", "properties": { "id": { - "description": "The ID of the received DORA deployment event.", + "description": "The ID of the received DORA failure event.", "example": "4242fcdd31586083", "type": "string" }, "type": { - "default": "dora_deployment", - "description": "JSON:API type for DORA deployment events.", + "default": "dora_failure", + "description": "JSON:API type for DORA failure events.", "enum": [ - "dora_deployment" + "dora_failure" ], - "example": "dora_deployment", + "example": "dora_failure", "type": "string", "x-enum-varnames": [ - "DORA_DEPLOYMENT" + "DORA_FAILURE" ] } }, @@ -415985,26 +422386,26 @@ "content": { "application/json": { "schema": { - "description": "Response after receiving a DORA deployment event.", + "description": "Response after receiving a DORA failure event.", "properties": { "data": { - "description": "The JSON:API data.", + "description": "Response after receiving a DORA failure event.", "properties": { "id": { - "description": "The ID of the received DORA deployment event.", + "description": "The ID of the received DORA failure event.", "example": "4242fcdd31586083", "type": "string" }, "type": { - "default": "dora_deployment", - "description": "JSON:API type for DORA deployment events.", + "default": "dora_failure", + "description": "JSON:API type for DORA failure events.", "enum": [ - "dora_deployment" + "dora_failure" ], - "example": "dora_deployment", + "example": "dora_failure", "type": "string", "x-enum-varnames": [ - "DORA_DEPLOYMENT" + "DORA_FAILURE" ] } }, @@ -416152,32 +422553,32 @@ "apiKeyAuth": [] } ], - "summary": "Send a deployment event for DORA Metrics", + "summary": "Send a failure event for DORA Metrics", "tags": [ "DORA Metrics" ], "x-codegen-request-body-name": "body", - "x-menu-order": 1, + "x-menu-order": 2, "x-undo": { "type": "idempotent" } } }, - "/api/v2/dora/deployments": { + "/api/v2/dora/failures": { "post": { - "description": "Use this API endpoint to get a list of deployment events.", - "operationId": "ListDORADeployments", + "description": "Use this API endpoint to get a list of failure events.", + "operationId": "ListDORAFailures", "requestBody": { "content": { "application/json": { "schema": { - "description": "Request to get a list of deployments.", + "description": "Request to get a list of failures.", "properties": { "data": { "description": "The JSON:API data.", "properties": { "attributes": { - "description": "Attributes to get a list of deployments.", + "description": "Attributes to get a list of failures.", "properties": { "from": { "description": "Minimum timestamp for requested events.", @@ -416208,13 +422609,13 @@ "type": "object" }, "type": { - "description": "The definition of `DORAListDeploymentsRequestDataType` object.", + "description": "The definition of `DORAListFailuresRequestDataType` object.", "enum": [ - "dora_deployments_list_request" + "dora_failures_list_request" ], "type": "string", "x-enum-varnames": [ - "DORA_DEPLOYMENTS_LIST_REQUEST" + "DORA_FAILURES_LIST_REQUEST" ] } }, @@ -416399,12 +422800,12 @@ "appKeyAuth": [] } ], - "summary": "Get a list of deployment events", + "summary": "Get a list of failure events", "tags": [ "DORA Metrics" ], "x-codegen-request-body-name": "body", - "x-menu-order": 3, + "x-menu-order": 4, "x-permission": { "operator": "OR", "permissions": [ @@ -416416,15 +422817,15 @@ } } }, - "/api/v2/dora/deployments/{deployment_id}": { + "/api/v2/dora/failures/{failure_id}": { "get": { - "description": "Use this API endpoint to get a deployment event.", - "operationId": "GetDORADeployment", + "description": "Use this API endpoint to get a failure event.", + "operationId": "GetDORAFailure", "parameters": [ { - "description": "The ID of the deployment event.", + "description": "The ID of the failure event.", "in": "path", - "name": "deployment_id", + "name": "failure_id", "required": true, "schema": { "type": "string" @@ -416595,12 +422996,12 @@ "appKeyAuth": [] } ], - "summary": "Get a deployment event", + "summary": "Get a failure event", "tags": [ "DORA Metrics" ], "x-codegen-request-body-name": "body", - "x-menu-order": 5, + "x-menu-order": 6, "x-permission": { "operator": "OR", "permissions": [ @@ -416612,10 +423013,11 @@ } } }, - "/api/v2/dora/failure": { + "/api/v2/dora/incident": { "post": { - "description": "Use this API endpoint to provide failure data for DORA metrics.\n\nThis is necessary for:\n- Change Failure Rate\n- Time to Restore", - "operationId": "CreateDORAFailure", + "deprecated": true, + "description": "**Note**: This endpoint is deprecated. Please use `/api/v2/dora/failure` instead.\n\nUse this API endpoint to provide failure data for DORA metrics.\n\nThis is necessary for:\n- Change Failure Rate\n- Time to Restore", + "operationId": "CreateDORAIncident", "requestBody": { "content": { "application/json": { @@ -416949,7 +423351,7 @@ "apiKeyAuth": [] } ], - "summary": "Send a failure event for DORA Metrics", + "summary": "Send an incident event for DORA Metrics", "tags": [ "DORA Metrics" ], @@ -416960,178 +423362,717 @@ } } }, - "/api/v2/dora/failures": { - "post": { - "description": "Use this API endpoint to get a list of failure events.", - "operationId": "ListDORAFailures", - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Request to get a list of failures.", - "properties": { - "data": { - "description": "The JSON:API data.", - "properties": { - "attributes": { - "description": "Attributes to get a list of failures.", - "properties": { - "from": { - "description": "Minimum timestamp for requested events.", - "format": "date-time", - "type": "string" - }, - "limit": { - "default": 10, - "description": "Maximum number of events in the response.", - "format": "int32", - "maximum": 1000, - "type": "integer" - }, - "query": { - "description": "Search query with event platform syntax.", - "type": "string" - }, - "sort": { - "description": "Sort order (prefixed with `-` for descending).", - "type": "string" - }, - "to": { - "description": "Maximum timestamp for requested events.", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "type": { - "description": "The definition of `DORAListFailuresRequestDataType` object.", - "enum": [ - "dora_failures_list_request" - ], - "type": "string", - "x-enum-varnames": [ - "DORA_FAILURES_LIST_REQUEST" - ] - } - }, - "required": [ - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } + "/api/v2/downtime": { + "get": { + "description": "Get all scheduled downtimes.", + "operationId": "ListDowntimes", + "parameters": [ + { + "description": "Only return downtimes that are active when the request is made.", + "in": "query", + "name": "current_only", + "required": false, + "schema": { + "type": "boolean" } }, - "required": true - }, + { + "description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "example": "created_by,monitor", + "type": "string" + } + }, + { + "description": "Specific offset to use as the beginning of the returned page.", + "in": "query", + "name": "page[offset]", + "required": false, + "schema": { + "default": 0, + "example": 0, + "format": "int64", + "type": "integer" + } + }, + { + "description": "Maximum number of downtimes in the response.", + "example": 100, + "in": "query", + "name": "page[limit]", + "required": false, + "schema": { + "default": 30, + "format": "int64", + "type": "integer" + } + } + ], "responses": { "200": { "content": { "application/json": { "schema": { - "description": "Response for the DORA list endpoints.", + "description": "Response for retrieving all downtimes.", "properties": { "data": { - "description": "The list of DORA events.", + "description": "An array of downtimes.", "items": { - "description": "A DORA event.", + "description": "Downtime data.", "properties": { "attributes": { - "description": "The attributes of the event.", + "description": "Downtime details.", + "properties": { + "canceled": { + "description": "Time that the downtime was canceled.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "created": { + "description": "Creation time of the downtime.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "type": "string" + }, + "display_timezone": { + "default": "UTC", + "description": "The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.", + "example": "America/New_York", + "nullable": true, + "type": "string" + }, + "message": { + "description": "A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same `@username` notation as events.", + "example": "Message about the downtime", + "nullable": true, + "type": "string" + }, + "modified": { + "description": "Time that the downtime was last modified.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "type": "string" + }, + "monitor_identifier": { + "description": "Monitor identifier for the downtime.", + "oneOf": [ + { + "additionalProperties": {}, + "description": "Object of the monitor identifier.", + "properties": { + "monitor_id": { + "description": "ID of the monitor to prevent notifications.", + "example": 123, + "format": "int64", + "type": "integer" + } + }, + "required": [ + "monitor_id" + ], + "type": "object" + }, + { + "additionalProperties": {}, + "description": "Object of the monitor tags.", + "properties": { + "monitor_tags": { + "description": "A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`\nto `[*]` configures the downtime to mute all monitors for the given scope.", + "example": [ + "service:postgres", + "team:frontend" + ], + "items": { + "description": "A list of monitor tags.", + "example": "service:postgres", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "monitor_tags" + ], + "type": "object" + } + ] + }, + "mute_first_recovery_notification": { + "description": "If the first recovery notification during a downtime should be muted.", + "example": false, + "type": "boolean" + }, + "notify_end_states": { + "description": "States that will trigger a monitor notification when the `notify_end_types` action occurs.", + "example": [ + "alert", + "warn" + ], + "items": { + "description": "State that will trigger a monitor notification when the `notify_end_types` action occurs.", + "enum": [ + "alert", + "no data", + "warn" + ], + "example": "alert", + "type": "string", + "x-enum-varnames": [ + "ALERT", + "NO_DATA", + "WARN" + ] + }, + "type": "array" + }, + "notify_end_types": { + "description": "Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", + "example": [ + "canceled", + "expired" + ], + "items": { + "description": "Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", + "enum": [ + "canceled", + "expired" + ], + "example": "canceled", + "type": "string", + "x-enum-varnames": [ + "CANCELED", + "EXPIRED" + ] + }, + "type": "array" + }, + "schedule": { + "description": "The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.", + "oneOf": [ + { + "description": "A recurring downtime schedule definition.", + "properties": { + "current_downtime": { + "description": "The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.", + "properties": { + "end": { + "description": "The end of the current downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "start": { + "description": "The start of the current downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "recurrences": { + "description": "A list of downtime recurrences.", + "items": { + "description": "An RRULE-based recurring downtime.", + "properties": { + "duration": { + "description": "The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.", + "example": "123d", + "type": "string" + }, + "rrule": { + "description": "The `RRULE` standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.\nMost common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.\n\n**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).\nMore examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).", + "example": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1", + "type": "string" + }, + "start": { + "description": "ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.", + "example": "2020-01-02T03:04", + "type": "string" + } + }, + "type": "object" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "timezone": { + "default": "UTC", + "description": "The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match `display_timezone`.", + "example": "America/New_York", + "type": "string" + } + }, + "required": [ + "recurrences" + ], + "type": "object" + }, + { + "description": "A one-time downtime definition.", + "properties": { + "end": { + "description": "ISO-8601 Datetime to end the downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "start": { + "description": "ISO-8601 Datetime to start the downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "start" + ], + "type": "object" + } + ] + }, + "scope": { + "description": "The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).", + "example": "env:(staging OR prod) AND datacenter:us-east-1", + "type": "string" + }, + "status": { + "description": "The current status of the downtime.", + "enum": [ + "active", + "canceled", + "ended", + "scheduled" + ], + "example": "active", + "type": "string", + "x-enum-varnames": [ + "ACTIVE", + "CANCELED", + "ENDED", + "SCHEDULED" + ] + } + }, "type": "object" }, "id": { - "description": "The ID of the event.", + "description": "The downtime ID.", + "example": "00000000-0000-1234-0000-000000000000", "type": "string" }, + "relationships": { + "description": "All relationships associated with downtime.", + "properties": { + "created_by": { + "description": "The user who created the downtime.", + "properties": { + "data": { + "description": "Data for the user who created the downtime.", + "nullable": true, + "properties": { + "id": { + "description": "User ID of the downtime creator.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + } + }, + "type": "object" + }, + "monitor": { + "description": "The monitor identified by the downtime.", + "properties": { + "data": { + "description": "Data for the monitor.", + "nullable": true, + "properties": { + "id": { + "description": "Monitor ID of the downtime.", + "example": "12345", + "type": "string" + }, + "type": { + "default": "monitors", + "description": "Monitor resource type.", + "enum": [ + "monitors" + ], + "example": "monitors", + "type": "string", + "x-enum-varnames": [ + "MONITORS" + ] + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, "type": { - "description": "The type of the event.", - "type": "string" + "default": "downtime", + "description": "Downtime resource type.", + "enum": [ + "downtime" + ], + "example": "downtime", + "type": "string", + "x-enum-varnames": [ + "DOWNTIME" + ] } }, "type": "object" }, "type": "array" - } - }, - "type": "object" - } - } - }, - "description": "OK" - }, - "400": { - "content": { - "application/json": { - "schema": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", + }, + "included": { + "description": "Array of objects related to the downtimes.", "items": { - "description": "API error response body", - "properties": { - "detail": { - "description": "A human-readable explanation specific to this occurrence of the error.", - "example": "Missing required attribute in body", - "type": "string" - }, - "meta": { - "additionalProperties": {}, - "description": "Non-standard meta-information about the error", - "type": "object" - }, - "source": { - "description": "References to the source of the error.", + "description": "An object related to a downtime.", + "oneOf": [ + { + "description": "User object returned by the API.", "properties": { - "header": { - "description": "A string indicating the name of a single request header which caused the error.", - "example": "Authorization", - "type": "string" + "attributes": { + "description": "Attributes of user object returned by the API.", + "properties": { + "created_at": { + "description": "Creation time of the user.", + "format": "date-time", + "type": "string" + }, + "disabled": { + "description": "Whether the user is disabled.", + "type": "boolean" + }, + "email": { + "description": "Email of the user.", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "type": "string" + }, + "icon": { + "description": "URL of the user's icon.", + "type": "string" + }, + "mfa_enabled": { + "description": "If user has MFA enabled.", + "readOnly": true, + "type": "boolean" + }, + "modified_at": { + "description": "Time that the user was last modified.", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "nullable": true, + "type": "string" + }, + "service_account": { + "description": "Whether the user is a service account.", + "type": "boolean" + }, + "status": { + "description": "Status of the user.", + "type": "string" + }, + "title": { + "description": "Title of the user.", + "nullable": true, + "type": "string" + }, + "verified": { + "description": "Whether the user is verified.", + "type": "boolean" + } + }, + "type": "object" }, - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "limit", + "id": { + "description": "ID of the user.", "type": "string" }, - "pointer": { - "description": "A JSON pointer to the value in the request document that caused the error.", - "example": "/data/attributes/title", - "type": "string" + "relationships": { + "description": "Relationships of the user object returned by the API.", + "properties": { + "org": { + "description": "Relationship to an organization.", + "properties": { + "data": { + "description": "Relationship to organization object.", + "properties": { + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", + "type": "string" + }, + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "other_orgs": { + "description": "Relationship to organizations.", + "properties": { + "data": { + "description": "Relationships to organization objects.", + "example": [], + "items": { + "description": "Relationship to organization object.", + "properties": { + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", + "type": "string" + }, + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "other_users": { + "description": "Relationship to users.", + "properties": { + "data": { + "description": "Relationships to user objects.", + "example": [], + "items": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "roles": { + "description": "Relationship to roles.", + "properties": { + "data": { + "description": "An array containing type and the unique identifier of a role.", + "items": { + "description": "Relationship to role object.", + "properties": { + "id": { + "description": "The unique identifier of the role.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" + }, + "type": { + "default": "roles", + "description": "Roles type.", + "enum": [ + "roles" + ], + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "properties": false + } + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] } }, - "type": "object" - }, - "status": { - "description": "Status code of the response.", - "example": "400", - "type": "string" + "type": "object", + "x-merge-override": { + "required": false + } }, - "title": { - "description": "Short human-readable summary of the error.", - "example": "Bad Request", - "type": "string" + { + "description": "Information about the monitor identified by the downtime.", + "properties": { + "attributes": { + "description": "Attributes of the monitor identified by the downtime.", + "properties": { + "name": { + "description": "The name of the monitor identified by the downtime.", + "example": "A monitor name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the monitor identified by the downtime.", + "example": 12345, + "format": "int64", + "type": "integer" + }, + "type": { + "default": "monitors", + "description": "Monitor resource type.", + "enum": [ + "monitors" + ], + "example": "monitors", + "type": "string", + "x-enum-varnames": [ + "MONITORS" + ] + } + }, + "type": "object" } - }, - "type": "object" + ] }, "type": "array" + }, + "meta": { + "description": "Pagination metadata returned by the API.", + "properties": { + "page": { + "description": "Object containing the total filtered count.", + "properties": { + "total_filtered_count": { + "description": "Total count of elements matched by the filter.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" } }, - "required": [ - "errors" - ], "type": "object" } } }, - "description": "Bad Request" + "description": "OK" }, "403": { "content": { @@ -417159,7 +424100,7 @@ } } }, - "description": "Not Authorized" + "description": "Forbidden" }, "429": { "content": { @@ -417194,64 +424135,903 @@ { "apiKeyAuth": [], "appKeyAuth": [] + }, + { + "AuthZ": [ + "monitors_downtime" + ] } ], - "summary": "Get a list of failure events", + "summary": "Get all downtimes", "tags": [ - "DORA Metrics" + "Downtimes" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 4, + "x-menu-order": 1, + "x-pagination": { + "limitParam": "page[limit]", + "pageOffsetParam": "page[offset]", + "resultsPath": "data" + }, "x-permission": { "operator": "OR", "permissions": [ - "dora_metrics_read" + "monitors_downtime" ] }, "x-undo": { "type": "safe" } - } - }, - "/api/v2/dora/failures/{failure_id}": { - "get": { - "description": "Use this API endpoint to get a failure event.", - "operationId": "GetDORAFailure", - "parameters": [ - { - "description": "The ID of the failure event.", - "in": "path", - "name": "failure_id", - "required": true, - "schema": { - "type": "string" + }, + "post": { + "description": "Schedule a downtime.", + "operationId": "CreateDowntime", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request for creating a downtime.", + "properties": { + "data": { + "description": "Object to create a downtime.", + "properties": { + "attributes": { + "description": "Downtime details.", + "properties": { + "display_timezone": { + "default": "UTC", + "description": "The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.", + "example": "America/New_York", + "nullable": true, + "type": "string" + }, + "message": { + "description": "A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same `@username` notation as events.", + "example": "Message about the downtime", + "nullable": true, + "type": "string" + }, + "monitor_identifier": { + "description": "Monitor identifier for the downtime.", + "oneOf": [ + { + "additionalProperties": {}, + "description": "Object of the monitor identifier.", + "properties": { + "monitor_id": { + "description": "ID of the monitor to prevent notifications.", + "example": 123, + "format": "int64", + "type": "integer" + } + }, + "required": [ + "monitor_id" + ], + "type": "object" + }, + { + "additionalProperties": {}, + "description": "Object of the monitor tags.", + "properties": { + "monitor_tags": { + "description": "A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`\nto `[*]` configures the downtime to mute all monitors for the given scope.", + "example": [ + "service:postgres", + "team:frontend" + ], + "items": { + "description": "A list of monitor tags.", + "example": "service:postgres", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "monitor_tags" + ], + "type": "object" + } + ] + }, + "mute_first_recovery_notification": { + "description": "If the first recovery notification during a downtime should be muted.", + "example": false, + "type": "boolean" + }, + "notify_end_states": { + "description": "States that will trigger a monitor notification when the `notify_end_types` action occurs.", + "example": [ + "alert", + "warn" + ], + "items": { + "description": "State that will trigger a monitor notification when the `notify_end_types` action occurs.", + "enum": [ + "alert", + "no data", + "warn" + ], + "example": "alert", + "type": "string", + "x-enum-varnames": [ + "ALERT", + "NO_DATA", + "WARN" + ] + }, + "type": "array" + }, + "notify_end_types": { + "description": "Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", + "example": [ + "canceled", + "expired" + ], + "items": { + "description": "Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", + "enum": [ + "canceled", + "expired" + ], + "example": "canceled", + "type": "string", + "x-enum-varnames": [ + "CANCELED", + "EXPIRED" + ] + }, + "type": "array" + }, + "schedule": { + "description": "Schedule for the downtime.", + "oneOf": [ + { + "description": "A recurring downtime schedule definition.", + "properties": { + "recurrences": { + "description": "A list of downtime recurrences.", + "items": { + "additionalProperties": {}, + "description": "An object defining the recurrence of the downtime.", + "properties": { + "duration": { + "description": "The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.", + "example": "123d", + "type": "string" + }, + "rrule": { + "description": "The `RRULE` standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.\nMost common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.\n\n**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).\nMore examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).", + "example": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1", + "type": "string" + }, + "start": { + "description": "ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.", + "example": "2020-01-02T03:04", + "nullable": true, + "type": "string" + } + }, + "required": [ + "duration", + "rrule" + ], + "type": "object" + }, + "type": "array" + }, + "timezone": { + "default": "UTC", + "description": "The timezone in which to schedule the downtime.", + "example": "America/New_York", + "type": "string" + } + }, + "required": [ + "recurrences" + ], + "type": "object" + }, + { + "additionalProperties": false, + "description": "A one-time downtime definition.", + "properties": { + "end": { + "description": "ISO-8601 Datetime to end the downtime. Must include a UTC offset of zero. If not provided, the\ndowntime continues forever.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "start": { + "description": "ISO-8601 Datetime to start the downtime. Must include a UTC offset of zero. If not provided, the\ndowntime starts the moment it is created.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "nullable": true, + "type": "string" + } + }, + "type": "object" + } + ] + }, + "scope": { + "description": "The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).", + "example": "env:(staging OR prod) AND datacenter:us-east-1", + "type": "string" + } + }, + "required": [ + "scope", + "monitor_identifier" + ], + "type": "object" + }, + "type": { + "default": "downtime", + "description": "Downtime resource type.", + "enum": [ + "downtime" + ], + "example": "downtime", + "type": "string", + "x-enum-varnames": [ + "DOWNTIME" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } } - } - ], + }, + "description": "Schedule a downtime request body.", + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "description": "Response for the DORA fetch endpoints.", + "description": "Downtiming gives you greater control over monitor notifications by\nallowing you to globally exclude scopes from alerting.\nDowntime settings, which can be scheduled with start and end times,\nprevent all alerting related to specified Datadog tags.", "properties": { "data": { - "description": "A DORA event.", + "description": "Downtime data.", "properties": { "attributes": { - "description": "The attributes of the event.", + "description": "Downtime details.", + "properties": { + "canceled": { + "description": "Time that the downtime was canceled.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "created": { + "description": "Creation time of the downtime.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "type": "string" + }, + "display_timezone": { + "default": "UTC", + "description": "The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.", + "example": "America/New_York", + "nullable": true, + "type": "string" + }, + "message": { + "description": "A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same `@username` notation as events.", + "example": "Message about the downtime", + "nullable": true, + "type": "string" + }, + "modified": { + "description": "Time that the downtime was last modified.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "type": "string" + }, + "monitor_identifier": { + "description": "Monitor identifier for the downtime.", + "oneOf": [ + { + "additionalProperties": {}, + "description": "Object of the monitor identifier.", + "properties": { + "monitor_id": { + "description": "ID of the monitor to prevent notifications.", + "example": 123, + "format": "int64", + "type": "integer" + } + }, + "required": [ + "monitor_id" + ], + "type": "object" + }, + { + "additionalProperties": {}, + "description": "Object of the monitor tags.", + "properties": { + "monitor_tags": { + "description": "A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`\nto `[*]` configures the downtime to mute all monitors for the given scope.", + "example": [ + "service:postgres", + "team:frontend" + ], + "items": { + "description": "A list of monitor tags.", + "example": "service:postgres", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "monitor_tags" + ], + "type": "object" + } + ] + }, + "mute_first_recovery_notification": { + "description": "If the first recovery notification during a downtime should be muted.", + "example": false, + "type": "boolean" + }, + "notify_end_states": { + "description": "States that will trigger a monitor notification when the `notify_end_types` action occurs.", + "example": [ + "alert", + "warn" + ], + "items": { + "description": "State that will trigger a monitor notification when the `notify_end_types` action occurs.", + "enum": [ + "alert", + "no data", + "warn" + ], + "example": "alert", + "type": "string", + "x-enum-varnames": [ + "ALERT", + "NO_DATA", + "WARN" + ] + }, + "type": "array" + }, + "notify_end_types": { + "description": "Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", + "example": [ + "canceled", + "expired" + ], + "items": { + "description": "Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", + "enum": [ + "canceled", + "expired" + ], + "example": "canceled", + "type": "string", + "x-enum-varnames": [ + "CANCELED", + "EXPIRED" + ] + }, + "type": "array" + }, + "schedule": { + "description": "The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.", + "oneOf": [ + { + "description": "A recurring downtime schedule definition.", + "properties": { + "current_downtime": { + "description": "The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.", + "properties": { + "end": { + "description": "The end of the current downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "start": { + "description": "The start of the current downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "recurrences": { + "description": "A list of downtime recurrences.", + "items": { + "description": "An RRULE-based recurring downtime.", + "properties": { + "duration": { + "description": "The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.", + "example": "123d", + "type": "string" + }, + "rrule": { + "description": "The `RRULE` standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.\nMost common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.\n\n**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).\nMore examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).", + "example": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1", + "type": "string" + }, + "start": { + "description": "ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.", + "example": "2020-01-02T03:04", + "type": "string" + } + }, + "type": "object" + }, + "maxItems": 5, + "minItems": 1, + "type": "array" + }, + "timezone": { + "default": "UTC", + "description": "The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match `display_timezone`.", + "example": "America/New_York", + "type": "string" + } + }, + "required": [ + "recurrences" + ], + "type": "object" + }, + { + "description": "A one-time downtime definition.", + "properties": { + "end": { + "description": "ISO-8601 Datetime to end the downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "start": { + "description": "ISO-8601 Datetime to start the downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "start" + ], + "type": "object" + } + ] + }, + "scope": { + "description": "The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).", + "example": "env:(staging OR prod) AND datacenter:us-east-1", + "type": "string" + }, + "status": { + "description": "The current status of the downtime.", + "enum": [ + "active", + "canceled", + "ended", + "scheduled" + ], + "example": "active", + "type": "string", + "x-enum-varnames": [ + "ACTIVE", + "CANCELED", + "ENDED", + "SCHEDULED" + ] + } + }, "type": "object" }, "id": { - "description": "The ID of the event.", + "description": "The downtime ID.", + "example": "00000000-0000-1234-0000-000000000000", "type": "string" }, + "relationships": { + "description": "All relationships associated with downtime.", + "properties": { + "created_by": { + "description": "The user who created the downtime.", + "properties": { + "data": { + "description": "Data for the user who created the downtime.", + "nullable": true, + "properties": { + "id": { + "description": "User ID of the downtime creator.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + } + }, + "type": "object" + }, + "monitor": { + "description": "The monitor identified by the downtime.", + "properties": { + "data": { + "description": "Data for the monitor.", + "nullable": true, + "properties": { + "id": { + "description": "Monitor ID of the downtime.", + "example": "12345", + "type": "string" + }, + "type": { + "default": "monitors", + "description": "Monitor resource type.", + "enum": [ + "monitors" + ], + "example": "monitors", + "type": "string", + "x-enum-varnames": [ + "MONITORS" + ] + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, "type": { - "description": "The type of the event.", - "type": "string" + "default": "downtime", + "description": "Downtime resource type.", + "enum": [ + "downtime" + ], + "example": "downtime", + "type": "string", + "x-enum-varnames": [ + "DOWNTIME" + ] } }, - "type": "object" + "type": "object" + }, + "included": { + "description": "Array of objects related to the downtime that the user requested.", + "items": { + "description": "An object related to a downtime.", + "oneOf": [ + { + "description": "User object returned by the API.", + "properties": { + "attributes": { + "description": "Attributes of user object returned by the API.", + "properties": { + "created_at": { + "description": "Creation time of the user.", + "format": "date-time", + "type": "string" + }, + "disabled": { + "description": "Whether the user is disabled.", + "type": "boolean" + }, + "email": { + "description": "Email of the user.", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "type": "string" + }, + "icon": { + "description": "URL of the user's icon.", + "type": "string" + }, + "mfa_enabled": { + "description": "If user has MFA enabled.", + "readOnly": true, + "type": "boolean" + }, + "modified_at": { + "description": "Time that the user was last modified.", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "nullable": true, + "type": "string" + }, + "service_account": { + "description": "Whether the user is a service account.", + "type": "boolean" + }, + "status": { + "description": "Status of the user.", + "type": "string" + }, + "title": { + "description": "Title of the user.", + "nullable": true, + "type": "string" + }, + "verified": { + "description": "Whether the user is verified.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the user.", + "type": "string" + }, + "relationships": { + "description": "Relationships of the user object returned by the API.", + "properties": { + "org": { + "description": "Relationship to an organization.", + "properties": { + "data": { + "description": "Relationship to organization object.", + "properties": { + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", + "type": "string" + }, + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "other_orgs": { + "description": "Relationship to organizations.", + "properties": { + "data": { + "description": "Relationships to organization objects.", + "example": [], + "items": { + "description": "Relationship to organization object.", + "properties": { + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", + "type": "string" + }, + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "other_users": { + "description": "Relationship to users.", + "properties": { + "data": { + "description": "Relationships to user objects.", + "example": [], + "items": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "roles": { + "description": "Relationship to roles.", + "properties": { + "data": { + "description": "An array containing type and the unique identifier of a role.", + "items": { + "description": "Relationship to role object.", + "properties": { + "id": { + "description": "The unique identifier of the role.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" + }, + "type": { + "default": "roles", + "description": "Roles type.", + "enum": [ + "roles" + ], + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "properties": false + } + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + { + "description": "Information about the monitor identified by the downtime.", + "properties": { + "attributes": { + "description": "Attributes of the monitor identified by the downtime.", + "properties": { + "name": { + "description": "The name of the monitor identified by the downtime.", + "example": "A monitor name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the monitor identified by the downtime.", + "example": 12345, + "format": "int64", + "type": "integer" + }, + "type": { + "default": "monitors", + "description": "Monitor resource type.", + "enum": [ + "monitors" + ], + "example": "monitors", + "type": "string", + "x-enum-varnames": [ + "MONITORS" + ] + } + }, + "type": "object" + } + ] + }, + "type": "array" } }, "type": "object" @@ -417268,52 +425048,13 @@ "properties": { "errors": { "description": "A list of errors.", + "example": [ + "Bad Request" + ], "items": { - "description": "API error response body", - "properties": { - "detail": { - "description": "A human-readable explanation specific to this occurrence of the error.", - "example": "Missing required attribute in body", - "type": "string" - }, - "meta": { - "additionalProperties": {}, - "description": "Non-standard meta-information about the error", - "type": "object" - }, - "source": { - "description": "References to the source of the error.", - "properties": { - "header": { - "description": "A string indicating the name of a single request header which caused the error.", - "example": "Authorization", - "type": "string" - }, - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "limit", - "type": "string" - }, - "pointer": { - "description": "A JSON pointer to the value in the request document that caused the error.", - "example": "/data/attributes/title", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "Status code of the response.", - "example": "400", - "type": "string" - }, - "title": { - "description": "Short human-readable summary of the error.", - "example": "Bad Request", - "type": "string" - } - }, - "type": "object" + "description": "A list of items.", + "example": "Bad Request", + "type": "string" }, "type": "array" } @@ -417353,7 +425094,7 @@ } } }, - "description": "Not Authorized" + "description": "Forbidden" }, "429": { "content": { @@ -417386,239 +425127,71 @@ }, "security": [ { - "apiKeyAuth": [] + "apiKeyAuth": [], + "appKeyAuth": [] }, { - "appKeyAuth": [] + "AuthZ": [ + "monitors_downtime" + ] } ], - "summary": "Get a failure event", + "summary": "Schedule a downtime", "tags": [ - "DORA Metrics" + "Downtimes" ], "x-codegen-request-body-name": "body", - "x-menu-order": 6, + "x-given": { + "downtime_v2": { + "parameters": [ + { + "name": "body", + "value": "{\n \"data\": {\n \"attributes\": {\n \"message\": \"test message\",\n \"monitor_identifier\": {\n \"monitor_tags\": [\"cat:hat\"]\n },\n \"scope\": \"test:{{ unique_lower_alnum }}\",\n \"schedule\": {\n \"start\": null\n }\n },\n \"type\": \"downtime\"\n }\n}" + } + ], + "step": "there is a valid \"downtime_v2\" in the system" + } + }, + "x-menu-order": 2, "x-permission": { "operator": "OR", "permissions": [ - "dora_metrics_read" + "monitors_downtime" ] }, "x-undo": { - "type": "safe" + "operationId": "CancelDowntime", + "parameters": [ + { + "name": "downtime_id", + "source": "data.id" + } + ], + "type": "unsafe" } } }, - "/api/v2/dora/incident": { - "post": { - "deprecated": true, - "description": "**Note**: This endpoint is deprecated. Please use `/api/v2/dora/failure` instead.\n\nUse this API endpoint to provide failure data for DORA metrics.\n\nThis is necessary for:\n- Change Failure Rate\n- Time to Restore", - "operationId": "CreateDORAIncident", - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Request to create a DORA failure event.", - "properties": { - "data": { - "description": "The JSON:API data.", - "properties": { - "attributes": { - "description": "Attributes to create a DORA failure event.", - "properties": { - "custom_tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern. Up to 100 may be added per event.", - "example": [ - "language:java", - "department:engineering" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "env": { - "description": "Environment name that was impacted by the failure.", - "example": "staging", - "type": "string" - }, - "finished_at": { - "description": "Unix timestamp when the failure finished. It must be in nanoseconds, milliseconds, or seconds, and it should not be older than 1 hour.", - "example": 1693491984000000000, - "format": "int64", - "type": "integer" - }, - "git": { - "description": "Git info for DORA Metrics events.", - "properties": { - "commit_sha": { - "description": "Git Commit SHA.", - "example": "66adc9350f2cc9b250b69abddab733dd55e1a588", - "pattern": "^[a-fA-F0-9]{40,}$", - "type": "string" - }, - "repository_url": { - "description": "Git Repository URL", - "example": "https://github.com/organization/example-repository", - "type": "string" - } - }, - "required": [ - "repository_url", - "commit_sha" - ], - "type": "object" - }, - "id": { - "description": "Failure ID. Must have at least 16 characters. Required to update a previously sent failure.", - "type": "string" - }, - "name": { - "description": "Failure name.", - "example": "Webserver is down failing all requests.", - "type": "string" - }, - "services": { - "description": "Service names impacted by the failure. If possible, use names registered in the Service Catalog. Required when the team field is not provided.", - "example": [ - "shopist" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "severity": { - "description": "Failure severity.", - "example": "High", - "type": "string" - }, - "started_at": { - "description": "Unix timestamp when the failure started. It must be in nanoseconds, milliseconds, or seconds.", - "example": 1693491974000000000, - "format": "int64", - "type": "integer" - }, - "team": { - "description": "Name of the team owning the services impacted. If possible, use team handles registered in Datadog. Required when the services field is not provided.", - "example": "backend", - "type": "string" - }, - "version": { - "description": "Version to correlate with [APM Deployment Tracking](https://docs.datadoghq.com/tracing/services/deployment_tracking/).", - "example": "v1.12.07", - "type": "string" - } - }, - "required": [ - "started_at" - ], - "type": "object" - } - }, - "required": [ - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } + "/api/v2/downtime/{downtime_id}": { + "delete": { + "description": "Cancel a downtime.\n\n**Note**: Downtimes canceled through the API are no longer active, but are retained for approximately two days before being permanently removed. The downtime may still appear in search results until it is permanently removed.", + "operationId": "CancelDowntime", + "parameters": [ + { + "description": "ID of the downtime to cancel.", + "in": "path", + "name": "downtime_id", + "required": true, + "schema": { + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" } - }, - "required": true - }, + } + ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "Response after receiving a DORA failure event.", - "properties": { - "data": { - "description": "Response after receiving a DORA failure event.", - "properties": { - "id": { - "description": "The ID of the received DORA failure event.", - "example": "4242fcdd31586083", - "type": "string" - }, - "type": { - "default": "dora_failure", - "description": "JSON:API type for DORA failure events.", - "enum": [ - "dora_failure" - ], - "example": "dora_failure", - "type": "string", - "x-enum-varnames": [ - "DORA_FAILURE" - ] - } - }, - "required": [ - "id" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, + "204": { "description": "OK" }, - "202": { - "content": { - "application/json": { - "schema": { - "description": "Response after receiving a DORA failure event.", - "properties": { - "data": { - "description": "Response after receiving a DORA failure event.", - "properties": { - "id": { - "description": "The ID of the received DORA failure event.", - "example": "4242fcdd31586083", - "type": "string" - }, - "type": { - "default": "dora_failure", - "description": "JSON:API type for DORA failure events.", - "enum": [ - "dora_failure" - ], - "example": "dora_failure", - "type": "string", - "x-enum-varnames": [ - "DORA_FAILURE" - ] - } - }, - "required": [ - "id" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "description": "OK - but delayed due to incident" - }, - "400": { + "403": { "content": { "application/json": { "schema": { @@ -417626,52 +425199,13 @@ "properties": { "errors": { "description": "A list of errors.", + "example": [ + "Bad Request" + ], "items": { - "description": "API error response body", - "properties": { - "detail": { - "description": "A human-readable explanation specific to this occurrence of the error.", - "example": "Missing required attribute in body", - "type": "string" - }, - "meta": { - "additionalProperties": {}, - "description": "Non-standard meta-information about the error", - "type": "object" - }, - "source": { - "description": "References to the source of the error.", - "properties": { - "header": { - "description": "A string indicating the name of a single request header which caused the error.", - "example": "Authorization", - "type": "string" - }, - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "limit", - "type": "string" - }, - "pointer": { - "description": "A JSON pointer to the value in the request document that caused the error.", - "example": "/data/attributes/title", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "Status code of the response.", - "example": "400", - "type": "string" - }, - "title": { - "description": "Short human-readable summary of the error.", - "example": "Bad Request", - "type": "string" - } - }, - "type": "object" + "description": "A list of items.", + "example": "Bad Request", + "type": "string" }, "type": "array" } @@ -417683,9 +425217,9 @@ } } }, - "description": "Bad Request" + "description": "Forbidden" }, - "403": { + "404": { "content": { "application/json": { "schema": { @@ -417711,7 +425245,7 @@ } } }, - "description": "Not Authorized" + "description": "Downtime not found" }, "429": { "content": { @@ -417744,32 +425278,42 @@ }, "security": [ { - "apiKeyAuth": [] + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "monitors_downtime" + ] } ], - "summary": "Send an incident event for DORA Metrics", + "summary": "Cancel a downtime", "tags": [ - "DORA Metrics" + "Downtimes" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 2, + "x-menu-order": 4, + "x-permission": { + "operator": "OR", + "permissions": [ + "monitors_downtime" + ] + }, "x-undo": { "type": "idempotent" } - } - }, - "/api/v2/downtime": { + }, "get": { - "description": "Get all scheduled downtimes.", - "operationId": "ListDowntimes", + "description": "Get downtime detail by `downtime_id`.", + "operationId": "GetDowntime", "parameters": [ { - "description": "Only return downtimes that are active when the request is made.", - "in": "query", - "name": "current_only", - "required": false, + "description": "ID of the downtime to fetch.", + "in": "path", + "name": "downtime_id", + "required": true, "schema": { - "type": "boolean" + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" } }, { @@ -417781,30 +425325,6 @@ "example": "created_by,monitor", "type": "string" } - }, - { - "description": "Specific offset to use as the beginning of the returned page.", - "in": "query", - "name": "page[offset]", - "required": false, - "schema": { - "default": 0, - "example": 0, - "format": "int64", - "type": "integer" - } - }, - { - "description": "Maximum number of downtimes in the response.", - "example": 100, - "in": "query", - "name": "page[limit]", - "required": false, - "schema": { - "default": 30, - "format": "int64", - "type": "integer" - } } ], "responses": { @@ -417812,345 +425332,341 @@ "content": { "application/json": { "schema": { - "description": "Response for retrieving all downtimes.", + "description": "Downtiming gives you greater control over monitor notifications by\nallowing you to globally exclude scopes from alerting.\nDowntime settings, which can be scheduled with start and end times,\nprevent all alerting related to specified Datadog tags.", "properties": { "data": { - "description": "An array of downtimes.", - "items": { - "description": "Downtime data.", - "properties": { - "attributes": { - "description": "Downtime details.", - "properties": { - "canceled": { - "description": "Time that the downtime was canceled.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "created": { - "description": "Creation time of the downtime.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", - "type": "string" - }, - "display_timezone": { - "default": "UTC", - "description": "The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.", - "example": "America/New_York", - "nullable": true, - "type": "string" - }, - "message": { - "description": "A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same `@username` notation as events.", - "example": "Message about the downtime", - "nullable": true, - "type": "string" - }, - "modified": { - "description": "Time that the downtime was last modified.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", - "type": "string" - }, - "monitor_identifier": { - "description": "Monitor identifier for the downtime.", - "oneOf": [ - { - "additionalProperties": {}, - "description": "Object of the monitor identifier.", - "properties": { - "monitor_id": { - "description": "ID of the monitor to prevent notifications.", - "example": 123, - "format": "int64", - "type": "integer" - } - }, - "required": [ - "monitor_id" - ], - "type": "object" + "description": "Downtime data.", + "properties": { + "attributes": { + "description": "Downtime details.", + "properties": { + "canceled": { + "description": "Time that the downtime was canceled.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "created": { + "description": "Creation time of the downtime.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "type": "string" + }, + "display_timezone": { + "default": "UTC", + "description": "The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.", + "example": "America/New_York", + "nullable": true, + "type": "string" + }, + "message": { + "description": "A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same `@username` notation as events.", + "example": "Message about the downtime", + "nullable": true, + "type": "string" + }, + "modified": { + "description": "Time that the downtime was last modified.", + "example": "2020-01-02T03:04:05.282979+0000", + "format": "date-time", + "type": "string" + }, + "monitor_identifier": { + "description": "Monitor identifier for the downtime.", + "oneOf": [ + { + "additionalProperties": {}, + "description": "Object of the monitor identifier.", + "properties": { + "monitor_id": { + "description": "ID of the monitor to prevent notifications.", + "example": 123, + "format": "int64", + "type": "integer" + } }, - { - "additionalProperties": {}, - "description": "Object of the monitor tags.", - "properties": { - "monitor_tags": { - "description": "A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`\nto `[*]` configures the downtime to mute all monitors for the given scope.", - "example": [ - "service:postgres", - "team:frontend" - ], - "items": { - "description": "A list of monitor tags.", - "example": "service:postgres", - "type": "string" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "monitor_tags" - ], - "type": "object" - } - ] - }, - "mute_first_recovery_notification": { - "description": "If the first recovery notification during a downtime should be muted.", - "example": false, - "type": "boolean" - }, - "notify_end_states": { - "description": "States that will trigger a monitor notification when the `notify_end_types` action occurs.", - "example": [ + "required": [ + "monitor_id" + ], + "type": "object" + }, + { + "additionalProperties": {}, + "description": "Object of the monitor tags.", + "properties": { + "monitor_tags": { + "description": "A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`\nto `[*]` configures the downtime to mute all monitors for the given scope.", + "example": [ + "service:postgres", + "team:frontend" + ], + "items": { + "description": "A list of monitor tags.", + "example": "service:postgres", + "type": "string" + }, + "minItems": 1, + "type": "array" + } + }, + "required": [ + "monitor_tags" + ], + "type": "object" + } + ] + }, + "mute_first_recovery_notification": { + "description": "If the first recovery notification during a downtime should be muted.", + "example": false, + "type": "boolean" + }, + "notify_end_states": { + "description": "States that will trigger a monitor notification when the `notify_end_types` action occurs.", + "example": [ + "alert", + "warn" + ], + "items": { + "description": "State that will trigger a monitor notification when the `notify_end_types` action occurs.", + "enum": [ "alert", + "no data", "warn" ], - "items": { - "description": "State that will trigger a monitor notification when the `notify_end_types` action occurs.", - "enum": [ - "alert", - "no data", - "warn" - ], - "example": "alert", - "type": "string", - "x-enum-varnames": [ - "ALERT", - "NO_DATA", - "WARN" - ] - }, - "type": "array" + "example": "alert", + "type": "string", + "x-enum-varnames": [ + "ALERT", + "NO_DATA", + "WARN" + ] }, - "notify_end_types": { - "description": "Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", - "example": [ + "type": "array" + }, + "notify_end_types": { + "description": "Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", + "example": [ + "canceled", + "expired" + ], + "items": { + "description": "Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", + "enum": [ "canceled", "expired" ], - "items": { - "description": "Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", - "enum": [ - "canceled", - "expired" - ], - "example": "canceled", - "type": "string", - "x-enum-varnames": [ - "CANCELED", - "EXPIRED" - ] - }, - "type": "array" + "example": "canceled", + "type": "string", + "x-enum-varnames": [ + "CANCELED", + "EXPIRED" + ] }, - "schedule": { - "description": "The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.", - "oneOf": [ - { - "description": "A recurring downtime schedule definition.", - "properties": { - "current_downtime": { - "description": "The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.", + "type": "array" + }, + "schedule": { + "description": "The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.", + "oneOf": [ + { + "description": "A recurring downtime schedule definition.", + "properties": { + "current_downtime": { + "description": "The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.", + "properties": { + "end": { + "description": "The end of the current downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "start": { + "description": "The start of the current downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "recurrences": { + "description": "A list of downtime recurrences.", + "items": { + "description": "An RRULE-based recurring downtime.", "properties": { - "end": { - "description": "The end of the current downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "nullable": true, + "duration": { + "description": "The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.", + "example": "123d", + "type": "string" + }, + "rrule": { + "description": "The `RRULE` standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.\nMost common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.\n\n**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).\nMore examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).", + "example": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1", "type": "string" }, "start": { - "description": "The start of the current downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", + "description": "ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.", + "example": "2020-01-02T03:04", "type": "string" } }, "type": "object" }, - "recurrences": { - "description": "A list of downtime recurrences.", - "items": { - "description": "An RRULE-based recurring downtime.", - "properties": { - "duration": { - "description": "The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.", - "example": "123d", - "type": "string" - }, - "rrule": { - "description": "The `RRULE` standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.\nMost common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.\n\n**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).\nMore examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).", - "example": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1", - "type": "string" - }, - "start": { - "description": "ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.", - "example": "2020-01-02T03:04", - "type": "string" - } - }, - "type": "object" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "timezone": { - "default": "UTC", - "description": "The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match `display_timezone`.", - "example": "America/New_York", - "type": "string" - } + "maxItems": 5, + "minItems": 1, + "type": "array" }, - "required": [ - "recurrences" - ], - "type": "object" + "timezone": { + "default": "UTC", + "description": "The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match `display_timezone`.", + "example": "America/New_York", + "type": "string" + } }, - { - "description": "A one-time downtime definition.", - "properties": { - "end": { - "description": "ISO-8601 Datetime to end the downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "start": { - "description": "ISO-8601 Datetime to start the downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "type": "string" - } + "required": [ + "recurrences" + ], + "type": "object" + }, + { + "description": "A one-time downtime definition.", + "properties": { + "end": { + "description": "ISO-8601 Datetime to end the downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "nullable": true, + "type": "string" }, - "required": [ - "start" - ], - "type": "object" - } - ] - }, - "scope": { - "description": "The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).", - "example": "env:(staging OR prod) AND datacenter:us-east-1", - "type": "string" - }, - "status": { - "description": "The current status of the downtime.", - "enum": [ - "active", - "canceled", - "ended", - "scheduled" - ], - "example": "active", - "type": "string", - "x-enum-varnames": [ - "ACTIVE", - "CANCELED", - "ENDED", - "SCHEDULED" - ] - } + "start": { + "description": "ISO-8601 Datetime to start the downtime.", + "example": "2020-01-02T03:04:00.000Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "start" + ], + "type": "object" + } + ] }, - "type": "object" - }, - "id": { - "description": "The downtime ID.", - "example": "00000000-0000-1234-0000-000000000000", - "type": "string" + "scope": { + "description": "The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).", + "example": "env:(staging OR prod) AND datacenter:us-east-1", + "type": "string" + }, + "status": { + "description": "The current status of the downtime.", + "enum": [ + "active", + "canceled", + "ended", + "scheduled" + ], + "example": "active", + "type": "string", + "x-enum-varnames": [ + "ACTIVE", + "CANCELED", + "ENDED", + "SCHEDULED" + ] + } }, - "relationships": { - "description": "All relationships associated with downtime.", - "properties": { - "created_by": { - "description": "The user who created the downtime.", - "properties": { - "data": { - "description": "Data for the user who created the downtime.", - "nullable": true, - "properties": { - "id": { - "description": "User ID of the downtime creator.", - "example": "00000000-0000-1234-0000-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } + "type": "object" + }, + "id": { + "description": "The downtime ID.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, + "relationships": { + "description": "All relationships associated with downtime.", + "properties": { + "created_by": { + "description": "The user who created the downtime.", + "properties": { + "data": { + "description": "Data for the user who created the downtime.", + "nullable": true, + "properties": { + "id": { + "description": "User ID of the downtime creator.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" }, - "type": "object" - } - }, - "type": "object" + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + } }, - "monitor": { - "description": "The monitor identified by the downtime.", - "properties": { - "data": { - "description": "Data for the monitor.", - "nullable": true, - "properties": { - "id": { - "description": "Monitor ID of the downtime.", - "example": "12345", - "type": "string" - }, - "type": { - "default": "monitors", - "description": "Monitor resource type.", - "enum": [ - "monitors" - ], - "example": "monitors", - "type": "string", - "x-enum-varnames": [ - "MONITORS" - ] - } - }, - "type": "object" - } - }, - "type": "object" - } + "type": "object" }, - "type": "object" + "monitor": { + "description": "The monitor identified by the downtime.", + "properties": { + "data": { + "description": "Data for the monitor.", + "nullable": true, + "properties": { + "id": { + "description": "Monitor ID of the downtime.", + "example": "12345", + "type": "string" + }, + "type": { + "default": "monitors", + "description": "Monitor resource type.", + "enum": [ + "monitors" + ], + "example": "monitors", + "type": "string", + "x-enum-varnames": [ + "MONITORS" + ] + } + }, + "type": "object" + } + }, + "type": "object" + } }, - "type": { - "default": "downtime", - "description": "Downtime resource type.", - "enum": [ - "downtime" - ], - "example": "downtime", - "type": "string", - "x-enum-varnames": [ - "DOWNTIME" - ] - } + "type": "object" }, - "type": "object" + "type": { + "default": "downtime", + "description": "Downtime resource type.", + "enum": [ + "downtime" + ], + "example": "downtime", + "type": "string", + "x-enum-varnames": [ + "DOWNTIME" + ] + } }, - "type": "array" + "type": "object" }, "included": { - "description": "Array of objects related to the downtimes.", + "description": "Array of objects related to the downtime that the user requested.", "items": { "description": "An object related to a downtime.", "oneOf": [ @@ -418445,23 +425961,6 @@ ] }, "type": "array" - }, - "meta": { - "description": "Pagination metadata returned by the API.", - "properties": { - "page": { - "description": "Object containing the total filtered count.", - "properties": { - "total_filtered_count": { - "description": "Total count of elements matched by the filter.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - } - }, - "type": "object" } }, "type": "object" @@ -418470,6 +425969,34 @@ }, "description": "OK" }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, "403": { "content": { "application/json": { @@ -418498,6 +426025,34 @@ }, "description": "Forbidden" }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, "429": { "content": { "application/json": { @@ -418538,16 +426093,11 @@ ] } ], - "summary": "Get all downtimes", + "summary": "Get a downtime", "tags": [ "Downtimes" ], - "x-menu-order": 1, - "x-pagination": { - "limitParam": "page[limit]", - "pageOffsetParam": "page[offset]", - "resultsPath": "data" - }, + "x-menu-order": 5, "x-permission": { "operator": "OR", "permissions": [ @@ -418558,20 +426108,32 @@ "type": "safe" } }, - "post": { - "description": "Schedule a downtime.", - "operationId": "CreateDowntime", + "patch": { + "description": "Update a downtime by `downtime_id`.", + "operationId": "UpdateDowntime", + "parameters": [ + { + "description": "ID of the downtime to update.", + "in": "path", + "name": "downtime_id", + "required": true, + "schema": { + "example": "00e000000-0000-1234-0000-000000000000", + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "description": "Request for creating a downtime.", + "description": "Request for editing a downtime.", "properties": { "data": { - "description": "Object to create a downtime.", + "description": "Object to update a downtime.", "properties": { "attributes": { - "description": "Downtime details.", + "description": "Attributes of the downtime to update.", "properties": { "display_timezone": { "default": "UTC", @@ -418684,6 +426246,7 @@ "description": "Schedule for the downtime.", "oneOf": [ { + "additionalProperties": false, "description": "A recurring downtime schedule definition.", "properties": { "recurrences": { @@ -418724,9 +426287,6 @@ "type": "string" } }, - "required": [ - "recurrences" - ], "type": "object" }, { @@ -418758,12 +426318,13 @@ "type": "string" } }, - "required": [ - "scope", - "monitor_identifier" - ], "type": "object" }, + "id": { + "description": "ID of this downtime.", + "example": "00000000-0000-1234-0000-000000000000", + "type": "string" + }, "type": { "default": "downtime", "description": "Downtime resource type.", @@ -418778,6 +426339,7 @@ } }, "required": [ + "id", "type", "attributes" ], @@ -418791,7 +426353,7 @@ } } }, - "description": "Schedule a downtime request body.", + "description": "Update a downtime request body.", "required": true }, "responses": { @@ -419188,45 +426750,1187 @@ "type": "string" }, "title": { - "description": "Title of the user.", - "nullable": true, + "description": "Title of the user.", + "nullable": true, + "type": "string" + }, + "verified": { + "description": "Whether the user is verified.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the user.", + "type": "string" + }, + "relationships": { + "description": "Relationships of the user object returned by the API.", + "properties": { + "org": { + "description": "Relationship to an organization.", + "properties": { + "data": { + "description": "Relationship to organization object.", + "properties": { + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", + "type": "string" + }, + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "other_orgs": { + "description": "Relationship to organizations.", + "properties": { + "data": { + "description": "Relationships to organization objects.", + "example": [], + "items": { + "description": "Relationship to organization object.", + "properties": { + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", + "type": "string" + }, + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "other_users": { + "description": "Relationship to users.", + "properties": { + "data": { + "description": "Relationships to user objects.", + "example": [], + "items": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "roles": { + "description": "Relationship to roles.", + "properties": { + "data": { + "description": "An array containing type and the unique identifier of a role.", + "items": { + "description": "Relationship to role object.", + "properties": { + "id": { + "description": "The unique identifier of the role.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" + }, + "type": { + "default": "roles", + "description": "Roles type.", + "enum": [ + "roles" + ], + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "properties": false + } + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + { + "description": "Information about the monitor identified by the downtime.", + "properties": { + "attributes": { + "description": "Attributes of the monitor identified by the downtime.", + "properties": { + "name": { + "description": "The name of the monitor identified by the downtime.", + "example": "A monitor name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the monitor identified by the downtime.", + "example": 12345, + "format": "int64", + "type": "integer" + }, + "type": { + "default": "monitors", + "description": "Monitor resource type.", + "enum": [ + "monitors" + ], + "example": "monitors", + "type": "string", + "x-enum-varnames": [ + "MONITORS" + ] + } + }, + "type": "object" + } + ] + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Downtime not found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "monitors_downtime" + ] + } + ], + "summary": "Update a downtime", + "tags": [ + "Downtimes" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 6, + "x-permission": { + "operator": "OR", + "permissions": [ + "monitors_downtime" + ] + }, + "x-undo": { + "type": "idempotent" + } + } + }, + "/api/v2/error-tracking/issues/search": { + "post": { + "description": "Search issues endpoint allows you to programmatically search for issues within your organization. This endpoint returns a list of issues that match a given search query, following the event search syntax. The search results are limited to a maximum of 100 issues per request.", + "operationId": "SearchIssues", + "parameters": [ + { + "description": "Comma-separated list of relationship objects that should be included in the response.", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "description": "Relationship object that should be included in the search response.", + "enum": [ + "issue", + "issue.assignee", + "issue.case", + "issue.team_owners" + ], + "example": "issue.case", + "type": "string", + "x-enum-varnames": [ + "ISSUE", + "ISSUE_ASSIGNEE", + "ISSUE_CASE", + "ISSUE_TEAM_OWNERS" + ] + }, + "type": "array" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Search issues request payload.", + "properties": { + "data": { + "description": "Search issues request.", + "properties": { + "attributes": { + "description": "Object describing a search issue request.", + "properties": { + "from": { + "description": "Start date (inclusive) of the query in milliseconds since the Unix epoch.", + "example": 1671612804000, + "format": "int64", + "type": "integer" + }, + "order_by": { + "description": "The attribute to sort the search results by.", + "enum": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ], + "example": "IMPACTED_SESSIONS", + "type": "string", + "x-enum-varnames": [ + "TOTAL_COUNT", + "FIRST_SEEN", + "IMPACTED_SESSIONS", + "PRIORITY" + ] + }, + "persona": { + "description": "Persona for the search. Either track(s) or persona(s) must be specified.", + "enum": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ALL", + "BROWSER", + "MOBILE", + "BACKEND" + ] + }, + "query": { + "description": "Search query following the event search syntax.", + "example": "service:orders-* AND @language:go", + "type": "string" + }, + "to": { + "description": "End date (exclusive) of the query in milliseconds since the Unix epoch.", + "example": 1671620004000, + "format": "int64", + "type": "integer" + }, + "track": { + "description": "Track of the events to query. Either track(s) or persona(s) must be specified.", + "enum": [ + "trace", + "logs", + "rum" + ], + "example": "trace", + "type": "string", + "x-enum-varnames": [ + "TRACE", + "LOGS", + "RUM" + ] + } + }, + "required": [ + "query", + "from", + "to" + ], + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "search_request" + ], + "example": "search_request", + "type": "string", + "x-enum-varnames": [ + "SEARCH_REQUEST" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Search issues request payload.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Search issues response payload.", + "properties": { + "data": { + "description": "Array of results matching the search query.", + "items": { + "description": "Result matching the search query.", + "properties": { + "attributes": { + "description": "Object containing the information of a search result.", + "properties": { + "impacted_sessions": { + "description": "Count of sessions impacted by the issue over the queried time window.", + "example": 12, + "format": "int64", + "type": "integer" + }, + "impacted_users": { + "description": "Count of users impacted by the issue over the queried time window.", + "example": 4, + "format": "int64", + "type": "integer" + }, + "total_count": { + "description": "Total count of errors that match the issue over the queried time window.", + "example": 82, + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "Search result identifier (matches the nested issue's identifier).", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "relationships": { + "description": "Relationships between the search result and other resources.", + "properties": { + "issue": { + "description": "Relationship between the search result and the corresponding issue.", + "properties": { + "data": { + "description": "The issue the search result corresponds to.", + "properties": { + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "error_tracking_search_result" + ], + "example": "error_tracking_search_result", + "type": "string", + "x-enum-varnames": [ + "ERROR_TRACKING_SEARCH_RESULT" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Array of resources related to the search results.", + "items": { + "description": "An array of related resources, returned when the `include` query parameter is used.", + "oneOf": [ + { + "description": "The issue matching the request.", + "properties": { + "attributes": { + "description": "Object containing the information of an issue.", + "properties": { + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", + "type": "string" + }, + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", + "type": "string" + }, + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", + "type": "string" + }, + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" + }, + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", + "type": "string" + }, + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" + }, + "is_crash": { + "description": "Error is a crash.", + "example": false, + "type": "boolean" + }, + "languages": { + "description": "Array of programming languages associated with the issue.", + "example": [ + "PYTHON", + "GO" + ], + "items": { + "description": "Programming language associated with the issue.", + "enum": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ], + "example": "PYTHON", + "type": "string", + "x-enum-varnames": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ] + }, + "type": "array" + }, + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" + }, + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ] + }, + "service": { + "description": "Service name.", + "example": "email-api-py", + "type": "string" + }, + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "type": "object" + }, + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "relationships": { + "description": "Relationship between the issue and an assignee, case and/or teams.", + "properties": { + "assignee": { + "description": "Relationship between the issue and assignee.", + "properties": { + "data": { + "description": "The user the issue is assigned to.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "case": { + "description": "Relationship between the issue and case.", + "properties": { + "data": { + "description": "The case the issue is attached to.", + "properties": { + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A case", + "properties": { + "attributes": { + "description": "Case resource attributes", + "properties": { + "archived_at": { + "description": "Timestamp of when the case was archived", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "attributes": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, + "description": "The definition of `CaseObjectAttributes` object.", + "type": "object" + }, + "closed_at": { + "description": "Timestamp of when the case was closed", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "created_at": { + "description": "Timestamp of when the case was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description", + "type": "string" + }, + "jira_issue": { + "description": "Jira issue attached to case", + "nullable": true, + "properties": { + "result": { + "description": "Jira issue information", + "properties": { + "issue_id": { + "description": "Jira issue ID", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL", + "type": "string" + }, + "project_key": { + "description": "Jira project key", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "default": "IN_PROGRESS", + "description": "Case status", + "enum": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ], + "example": "COMPLETED", + "readOnly": true, + "type": "string", + "x-enum-varnames": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + } + }, + "readOnly": true, + "type": "object" + }, + "key": { + "description": "Key", + "example": "CASEM-4523", + "type": "string" + }, + "modified_at": { + "description": "Timestamp of when the case was last modified", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] + }, + "service_now_ticket": { + "description": "ServiceNow ticket attached to case", + "nullable": true, + "properties": { + "result": { + "description": "ServiceNow ticket information", + "properties": { + "sys_target_link": { + "description": "Link to the Incident created on ServiceNow", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "default": "IN_PROGRESS", + "description": "Case status", + "enum": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ], + "example": "COMPLETED", + "readOnly": true, + "type": "string", + "x-enum-varnames": [ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + } + }, + "readOnly": true, + "type": "object" + }, + "status": { + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ], + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] + }, + "title": { + "description": "Title", + "example": "Memory leak investigation on API", "type": "string" }, - "verified": { - "description": "Whether the user is verified.", - "type": "boolean" + "type": { + "description": "Case type", + "enum": [ + "STANDARD" + ], + "example": "STANDARD", + "type": "string", + "x-enum-varnames": [ + "STANDARD" + ] } }, "type": "object" }, "id": { - "description": "ID of the user.", + "description": "Case's identifier", + "example": "aeadc05e-98a8-11ec-ac2c-da7ad0900001", "type": "string" }, "relationships": { - "description": "Relationships of the user object returned by the API.", + "description": "Resources related to a case", "properties": { - "org": { - "description": "Relationship to an organization.", + "assignee": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationship to organization object.", + "description": "Relationship to user object.", + "nullable": true, "properties": { "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" }, "type": { - "default": "orgs", - "description": "Organizations resource type.", + "default": "user", + "description": "User resource type.", "enum": [ - "orgs" + "user" ], - "example": "orgs", + "example": "user", "type": "string", "x-enum-varnames": [ - "ORGS" + "USER" ] } }, @@ -419242,40 +427946,37 @@ ], "type": "object" }, - "other_orgs": { - "description": "Relationship to organizations.", + "created_by": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationships to organization objects.", - "example": [], - "items": { - "description": "Relationship to organization object.", - "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", - "type": "string" - }, - "type": { - "default": "orgs", - "description": "Organizations resource type.", - "enum": [ - "orgs" - ], - "example": "orgs", - "type": "string", - "x-enum-varnames": [ - "ORGS" - ] - } + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object" + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, "required": [ @@ -419283,43 +427984,37 @@ ], "type": "object" }, - "other_users": { - "description": "Relationship to users.", + "modified_by": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationships to user objects.", - "example": [], - "items": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, "required": [ @@ -419327,102 +428022,159 @@ ], "type": "object" }, - "roles": { - "description": "Relationship to roles.", + "project": { + "description": "Relationship to project", "properties": { "data": { - "description": "An array containing type and the unique identifier of a role.", - "items": { - "description": "Relationship to role object.", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" - }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" }, - "type": "object", - "x-merge-override": { - "required": false + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "data" + ], + "type": "object" } }, - "type": "object", - "x-merge-override": { - "properties": false - } + "type": "object" }, "type": { - "default": "users", - "description": "Users resource type.", + "default": "case", + "description": "Case resource type", "enum": [ - "users" + "case" ], - "example": "users", + "example": "case", "type": "string", "x-enum-varnames": [ - "USERS" + "CASE" ] } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" }, { - "description": "Information about the monitor identified by the downtime.", + "description": "The user to whom the issue is assigned.", "properties": { "attributes": { - "description": "Attributes of the monitor identified by the downtime.", + "description": "Object containing the information of a user.", "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, "name": { - "description": "The name of the monitor identified by the downtime.", - "example": "A monitor name", + "description": "Name of the user.", + "example": "User Name", "type": "string" } }, "type": "object" }, "id": { - "description": "ID of the monitor identified by the downtime.", - "example": 12345, - "format": "int64", - "type": "integer" + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" }, "type": { - "default": "monitors", - "description": "Monitor resource type.", + "description": "Type of the object", "enum": [ - "monitors" + "user" ], - "example": "monitors", + "example": "user", "type": "string", "x-enum-varnames": [ - "MONITORS" + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" ] } }, + "required": [ + "id", + "type", + "attributes" + ], "type": "object" } ] @@ -419464,35 +428216,7 @@ }, "description": "Bad Request" }, - "403": { - "content": { - "application/json": { - "schema": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", - "example": [ - "Bad Request" - ], - "items": { - "description": "A list of items.", - "example": "Bad Request", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden" - }, - "429": { + "401": { "content": { "application/json": { "schema": { @@ -419518,74 +428242,7 @@ } } }, - "description": "Too many requests" - } - }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "monitors_downtime" - ] - } - ], - "summary": "Schedule a downtime", - "tags": [ - "Downtimes" - ], - "x-codegen-request-body-name": "body", - "x-given": { - "downtime_v2": { - "parameters": [ - { - "name": "body", - "value": "{\n \"data\": {\n \"attributes\": {\n \"message\": \"test message\",\n \"monitor_identifier\": {\n \"monitor_tags\": [\"cat:hat\"]\n },\n \"scope\": \"test:{{ unique_lower_alnum }}\",\n \"schedule\": {\n \"start\": null\n }\n },\n \"type\": \"downtime\"\n }\n}" - } - ], - "step": "there is a valid \"downtime_v2\" in the system" - } - }, - "x-menu-order": 2, - "x-permission": { - "operator": "OR", - "permissions": [ - "monitors_downtime" - ] - }, - "x-undo": { - "operationId": "CancelDowntime", - "parameters": [ - { - "name": "downtime_id", - "source": "data.id" - } - ], - "type": "unsafe" - } - } - }, - "/api/v2/downtime/{downtime_id}": { - "delete": { - "description": "Cancel a downtime.\n\n**Note**: Downtimes canceled through the API are no longer active, but are retained for approximately two days before being permanently removed. The downtime may still appear in search results until it is permanently removed.", - "operationId": "CancelDowntime", - "parameters": [ - { - "description": "ID of the downtime to cancel.", - "in": "path", - "name": "downtime_id", - "required": true, - "schema": { - "example": "00000000-0000-1234-0000-000000000000", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "OK" + "description": "Unauthorized" }, "403": { "content": { @@ -419615,34 +428272,6 @@ }, "description": "Forbidden" }, - "404": { - "content": { - "application/json": { - "schema": { - "description": "API error response.", - "properties": { - "errors": { - "description": "A list of errors.", - "example": [ - "Bad Request" - ], - "items": { - "description": "A list of items.", - "example": "Bad Request", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - } - } - }, - "description": "Downtime not found" - }, "429": { "content": { "application/json": { @@ -419679,47 +428308,70 @@ }, { "AuthZ": [ - "monitors_downtime" + "error_tracking_read" ] } ], - "summary": "Cancel a downtime", + "summary": "Search error tracking issues", "tags": [ - "Downtimes" + "Error Tracking" ], - "x-menu-order": 4, - "x-permission": { - "operator": "OR", - "permissions": [ - "monitors_downtime" - ] + "x-given": { + "issue": { + "parameters": [ + { + "name": "body", + "value": "{\n \"data\": {\n \"attributes\": {\n \"query\": \"service:synthetics-browser\",\n \"from\": {{ timestamp(\"now - 15d\") }}000,\n \"to\": {{ timestamp(\"now\") }}000,\n \"track\": \"rum\"\n },\n \"type\": \"search_request\"\n }\n}" + } + ], + "source": "data[0]", + "step": "there is a valid \"issue\" in the system" + } }, + "x-menu-order": 1, "x-undo": { - "type": "idempotent" + "type": "safe" } - }, + } + }, + "/api/v2/error-tracking/issues/{issue_id}": { "get": { - "description": "Get downtime detail by `downtime_id`.", - "operationId": "GetDowntime", + "description": "Retrieve the full details for a specific error tracking issue, including attributes and relationships.", + "operationId": "GetIssue", "parameters": [ { - "description": "ID of the downtime to fetch.", + "description": "The identifier of the issue.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", "in": "path", - "name": "downtime_id", + "name": "issue_id", "required": true, "schema": { - "example": "00000000-0000-1234-0000-000000000000", "type": "string" } }, { - "description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`.", + "description": "Comma-separated list of relationship objects that should be included in the response.", + "explode": false, "in": "query", "name": "include", "required": false, "schema": { - "example": "created_by,monitor", - "type": "string" + "items": { + "description": "Relationship object that should be included in the response.", + "enum": [ + "assignee", + "case", + "team_owners" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "ASSIGNEE", + "CASE", + "TEAM_OWNERS" + ] + }, + "type": "array" } } ], @@ -419728,434 +428380,520 @@ "content": { "application/json": { "schema": { - "description": "Downtiming gives you greater control over monitor notifications by\nallowing you to globally exclude scopes from alerting.\nDowntime settings, which can be scheduled with start and end times,\nprevent all alerting related to specified Datadog tags.", + "description": "Response containing error tracking issue data.", "properties": { "data": { - "description": "Downtime data.", + "description": "The issue matching the request.", "properties": { "attributes": { - "description": "Downtime details.", + "description": "Object containing the information of an issue.", "properties": { - "canceled": { - "description": "Time that the downtime was canceled.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", - "nullable": true, + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", "type": "string" }, - "created": { - "description": "Creation time of the downtime.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", "type": "string" }, - "display_timezone": { - "default": "UTC", - "description": "The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.", - "example": "America/New_York", - "nullable": true, + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", "type": "string" }, - "message": { - "description": "A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same `@username` notation as events.", - "example": "Message about the downtime", - "nullable": true, - "type": "string" + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" }, - "modified": { - "description": "Time that the downtime was last modified.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", "type": "string" }, - "monitor_identifier": { - "description": "Monitor identifier for the downtime.", - "oneOf": [ - { - "additionalProperties": {}, - "description": "Object of the monitor identifier.", - "properties": { - "monitor_id": { - "description": "ID of the monitor to prevent notifications.", - "example": 123, - "format": "int64", - "type": "integer" - } - }, - "required": [ - "monitor_id" - ], - "type": "object" - }, - { - "additionalProperties": {}, - "description": "Object of the monitor tags.", - "properties": { - "monitor_tags": { - "description": "A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`\nto `[*]` configures the downtime to mute all monitors for the given scope.", - "example": [ - "service:postgres", - "team:frontend" - ], - "items": { - "description": "A list of monitor tags.", - "example": "service:postgres", - "type": "string" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "monitor_tags" - ], - "type": "object" - } - ] + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" }, - "mute_first_recovery_notification": { - "description": "If the first recovery notification during a downtime should be muted.", + "is_crash": { + "description": "Error is a crash.", "example": false, "type": "boolean" }, - "notify_end_states": { - "description": "States that will trigger a monitor notification when the `notify_end_types` action occurs.", + "languages": { + "description": "Array of programming languages associated with the issue.", "example": [ - "alert", - "warn" + "PYTHON", + "GO" ], "items": { - "description": "State that will trigger a monitor notification when the `notify_end_types` action occurs.", + "description": "Programming language associated with the issue.", "enum": [ - "alert", - "no data", - "warn" + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" ], - "example": "alert", + "example": "PYTHON", "type": "string", "x-enum-varnames": [ - "ALERT", - "NO_DATA", - "WARN" + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" ] }, "type": "array" }, - "notify_end_types": { - "description": "Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", - "example": [ - "canceled", - "expired" - ], - "items": { - "description": "Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", - "enum": [ - "canceled", - "expired" - ], - "example": "canceled", - "type": "string", - "x-enum-varnames": [ - "CANCELED", - "EXPIRED" - ] - }, - "type": "array" + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" }, - "schedule": { - "description": "The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.", - "oneOf": [ - { - "description": "A recurring downtime schedule definition.", - "properties": { - "current_downtime": { - "description": "The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.", - "properties": { - "end": { - "description": "The end of the current downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "start": { - "description": "The start of the current downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "recurrences": { - "description": "A list of downtime recurrences.", - "items": { - "description": "An RRULE-based recurring downtime.", - "properties": { - "duration": { - "description": "The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.", - "example": "123d", - "type": "string" - }, - "rrule": { - "description": "The `RRULE` standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.\nMost common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.\n\n**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).\nMore examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).", - "example": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1", - "type": "string" - }, - "start": { - "description": "ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.", - "example": "2020-01-02T03:04", - "type": "string" - } - }, - "type": "object" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "timezone": { - "default": "UTC", - "description": "The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match `display_timezone`.", - "example": "America/New_York", - "type": "string" - } - }, - "required": [ - "recurrences" - ], - "type": "object" - }, - { - "description": "A one-time downtime definition.", - "properties": { - "end": { - "description": "ISO-8601 Datetime to end the downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "start": { - "description": "ISO-8601 Datetime to start the downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "type": "string" - } - }, - "required": [ - "start" - ], - "type": "object" - } + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" ] }, - "scope": { - "description": "The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).", - "example": "env:(staging OR prod) AND datacenter:us-east-1", + "service": { + "description": "Service name.", + "example": "email-api-py", "type": "string" }, - "status": { - "description": "The current status of the downtime.", + "state": { + "description": "State of the issue", "enum": [ - "active", - "canceled", - "ended", - "scheduled" + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" ], - "example": "active", + "example": "RESOLVED", "type": "string", "x-enum-varnames": [ - "ACTIVE", - "CANCELED", - "ENDED", - "SCHEDULED" + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" ] } }, "type": "object" }, "id": { - "description": "The downtime ID.", - "example": "00000000-0000-1234-0000-000000000000", + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", "type": "string" }, "relationships": { - "description": "All relationships associated with downtime.", + "description": "Relationship between the issue and an assignee, case and/or teams.", "properties": { - "created_by": { - "description": "The user who created the downtime.", + "assignee": { + "description": "Relationship between the issue and assignee.", "properties": { "data": { - "description": "Data for the user who created the downtime.", - "nullable": true, + "description": "The user the issue is assigned to.", "properties": { "id": { - "description": "User ID of the downtime creator.", - "example": "00000000-0000-1234-0000-000000000000", + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", "type": "string" }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "Type of the object", "enum": [ - "users" + "user" ], - "example": "users", + "example": "user", "type": "string", "x-enum-varnames": [ - "USERS" + "USER" ] } }, + "required": [ + "id", + "type" + ], "type": "object" } }, + "required": [ + "data" + ], "type": "object" }, - "monitor": { - "description": "The monitor identified by the downtime.", + "case": { + "description": "Relationship between the issue and case.", "properties": { "data": { - "description": "Data for the monitor.", - "nullable": true, + "description": "The case the issue is attached to.", "properties": { "id": { - "description": "Monitor ID of the downtime.", - "example": "12345", + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, "type": { - "default": "monitors", - "description": "Monitor resource type.", + "description": "Type of the object.", "enum": [ - "monitors" + "case" ], - "example": "monitors", + "example": "case", "type": "string", "x-enum-varnames": [ - "MONITORS" + "CASE" ] } }, + "required": [ + "id", + "type" + ], "type": "object" } }, + "required": [ + "data" + ], + "type": "object" + }, + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], "type": "object" } }, "type": "object" }, "type": { - "default": "downtime", - "description": "Downtime resource type.", + "description": "Type of the object.", "enum": [ - "downtime" + "issue" ], - "example": "downtime", + "example": "issue", "type": "string", "x-enum-varnames": [ - "DOWNTIME" + "ISSUE" ] } }, + "required": [ + "id", + "type", + "attributes" + ], "type": "object" }, "included": { - "description": "Array of objects related to the downtime that the user requested.", + "description": "Array of resources related to the issue.", "items": { - "description": "An object related to a downtime.", + "description": "An array of related resources, returned when the `include` query parameter is used.", "oneOf": [ { - "description": "User object returned by the API.", + "description": "The case attached to the issue.", "properties": { "attributes": { - "description": "Attributes of user object returned by the API.", + "description": "Object containing the information of a case.", "properties": { - "created_at": { - "description": "Creation time of the user.", + "archived_at": { + "description": "Timestamp of when the case was archived.", + "example": "2025-01-01T00:00:00Z", "format": "date-time", "type": "string" }, - "disabled": { - "description": "Whether the user is disabled.", - "type": "boolean" + "closed_at": { + "description": "Timestamp of when the case was closed.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" }, - "email": { - "description": "Email of the user.", + "created_at": { + "description": "Timestamp of when the case was created.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", "type": "string" }, - "handle": { - "description": "Handle of the user.", + "creation_source": { + "description": "Source of the case creation.", + "example": "ERROR_TRACKING", "type": "string" }, - "icon": { - "description": "URL of the user's icon.", + "description": { + "description": "Description of the case.", "type": "string" }, - "mfa_enabled": { - "description": "If user has MFA enabled.", - "readOnly": true, - "type": "boolean" + "due_date": { + "description": "Due date of the case.", + "example": "2025-01-01", + "type": "string" }, - "modified_at": { - "description": "Time that the user was last modified.", - "format": "date-time", + "insights": { + "description": "Insights of the case.", + "items": { + "description": "Insight of the case.", + "properties": { + "ref": { + "description": "Reference of the insight.", + "example": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "resource_id": { + "description": "Insight identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the insight.", + "example": "ERROR_TRACKING", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "jira_issue": { + "description": "Jira issue of the case.", + "properties": { + "result": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", + "properties": { + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", + "type": "string" + }, + "project_key": { + "description": "Jira project key.", + "example": "ET", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Creation status of the Jira issue.", + "example": "COMPLETED", + "type": "string" + } + }, + "type": "object" + }, + "key": { + "description": "Key of the case.", + "example": "ET-123", "type": "string" }, - "name": { - "description": "Name of the user.", - "nullable": true, + "modified_at": { + "description": "Timestamp of when the case was last modified.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", "type": "string" }, - "service_account": { - "description": "Whether the user is a service account.", - "type": "boolean" + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] }, "status": { - "description": "Status of the user.", - "type": "string" + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ], + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] }, "title": { - "description": "Title of the user.", - "nullable": true, + "description": "Title of the case.", + "example": "Error: HTTP error", "type": "string" }, - "verified": { - "description": "Whether the user is verified.", - "type": "boolean" + "type": { + "description": "Type of the case.", + "example": "ERROR_TRACKING_ISSUE", + "type": "string" } }, "type": "object" }, "id": { - "description": "ID of the user.", + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, "relationships": { - "description": "Relationships of the user object returned by the API.", + "description": "Resources related to a case.", "properties": { - "org": { - "description": "Relationship to an organization.", + "assignee": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationship to organization object.", + "description": "Relationship to user object.", + "nullable": true, "properties": { "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" }, "type": { - "default": "orgs", - "description": "Organizations resource type.", + "default": "user", + "description": "User resource type.", "enum": [ - "orgs" + "user" ], - "example": "orgs", + "example": "user", "type": "string", "x-enum-varnames": [ - "ORGS" + "USER" ] } }, @@ -420171,40 +428909,37 @@ ], "type": "object" }, - "other_orgs": { - "description": "Relationship to organizations.", + "created_by": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationships to organization objects.", - "example": [], - "items": { - "description": "Relationship to organization object.", - "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", - "type": "string" - }, - "type": { - "default": "orgs", - "description": "Organizations resource type.", - "enum": [ - "orgs" - ], - "example": "orgs", - "type": "string", - "x-enum-varnames": [ - "ORGS" - ] - } + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object" + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, "required": [ @@ -420212,43 +428947,37 @@ ], "type": "object" }, - "other_users": { - "description": "Relationship to users.", + "modified_by": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationships to user objects.", - "example": [], - "items": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, "required": [ @@ -420256,102 +428985,158 @@ ], "type": "object" }, - "roles": { - "description": "Relationship to roles.", + "project": { + "description": "Relationship to project", "properties": { "data": { - "description": "An array containing type and the unique identifier of a role.", - "items": { - "description": "Relationship to role object.", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" - }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" }, - "type": "object", - "x-merge-override": { - "required": false + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "data" + ], + "type": "object" } }, - "type": "object", - "x-merge-override": { - "properties": false - } + "type": "object" }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "Type of the object.", "enum": [ - "users" + "case" ], - "example": "users", + "example": "case", "type": "string", "x-enum-varnames": [ - "USERS" + "CASE" ] } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" }, { - "description": "Information about the monitor identified by the downtime.", + "description": "The user to whom the issue is assigned.", "properties": { "attributes": { - "description": "Attributes of the monitor identified by the downtime.", + "description": "Object containing the information of a user.", "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, "name": { - "description": "The name of the monitor identified by the downtime.", - "example": "A monitor name", + "description": "Name of the user.", + "example": "User Name", "type": "string" } }, "type": "object" }, "id": { - "description": "ID of the monitor identified by the downtime.", - "example": 12345, - "format": "int64", - "type": "integer" + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" }, "type": { - "default": "monitors", - "description": "Monitor resource type.", + "description": "Type of the object", "enum": [ - "monitors" + "user" ], - "example": "monitors", + "example": "user", "type": "string", "x-enum-varnames": [ - "MONITORS" + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" ] } }, + "required": [ + "id", + "type", + "attributes" + ], "type": "object" } ] @@ -420393,6 +429178,34 @@ }, "description": "Bad Request" }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, "403": { "content": { "application/json": { @@ -420485,36 +429298,32 @@ }, { "AuthZ": [ - "monitors_downtime" + "error_tracking_read" ] } ], - "summary": "Get a downtime", + "summary": "Get the details of an error tracking issue", "tags": [ - "Downtimes" + "Error Tracking" ], - "x-menu-order": 5, - "x-permission": { - "operator": "OR", - "permissions": [ - "monitors_downtime" - ] - }, + "x-menu-order": 2, "x-undo": { "type": "safe" } - }, - "patch": { - "description": "Update a downtime by `downtime_id`.", - "operationId": "UpdateDowntime", + } + }, + "/api/v2/error-tracking/issues/{issue_id}/assignee": { + "put": { + "description": "Update the assignee of an issue by `issue_id`.", + "operationId": "UpdateIssueAssignee", "parameters": [ { - "description": "ID of the downtime to update.", + "description": "The identifier of the issue.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", "in": "path", - "name": "downtime_id", + "name": "issue_id", "required": true, "schema": { - "example": "00e000000-0000-1234-0000-000000000000", "type": "string" } } @@ -420523,221 +429332,31 @@ "content": { "application/json": { "schema": { - "description": "Request for editing a downtime.", + "description": "Update issue assignee request payload.", "properties": { "data": { - "description": "Object to update a downtime.", + "description": "Update issue assignee request.", "properties": { - "attributes": { - "description": "Attributes of the downtime to update.", - "properties": { - "display_timezone": { - "default": "UTC", - "description": "The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.", - "example": "America/New_York", - "nullable": true, - "type": "string" - }, - "message": { - "description": "A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same `@username` notation as events.", - "example": "Message about the downtime", - "nullable": true, - "type": "string" - }, - "monitor_identifier": { - "description": "Monitor identifier for the downtime.", - "oneOf": [ - { - "additionalProperties": {}, - "description": "Object of the monitor identifier.", - "properties": { - "monitor_id": { - "description": "ID of the monitor to prevent notifications.", - "example": 123, - "format": "int64", - "type": "integer" - } - }, - "required": [ - "monitor_id" - ], - "type": "object" - }, - { - "additionalProperties": {}, - "description": "Object of the monitor tags.", - "properties": { - "monitor_tags": { - "description": "A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`\nto `[*]` configures the downtime to mute all monitors for the given scope.", - "example": [ - "service:postgres", - "team:frontend" - ], - "items": { - "description": "A list of monitor tags.", - "example": "service:postgres", - "type": "string" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "monitor_tags" - ], - "type": "object" - } - ] - }, - "mute_first_recovery_notification": { - "description": "If the first recovery notification during a downtime should be muted.", - "example": false, - "type": "boolean" - }, - "notify_end_states": { - "description": "States that will trigger a monitor notification when the `notify_end_types` action occurs.", - "example": [ - "alert", - "warn" - ], - "items": { - "description": "State that will trigger a monitor notification when the `notify_end_types` action occurs.", - "enum": [ - "alert", - "no data", - "warn" - ], - "example": "alert", - "type": "string", - "x-enum-varnames": [ - "ALERT", - "NO_DATA", - "WARN" - ] - }, - "type": "array" - }, - "notify_end_types": { - "description": "Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", - "example": [ - "canceled", - "expired" - ], - "items": { - "description": "Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", - "enum": [ - "canceled", - "expired" - ], - "example": "canceled", - "type": "string", - "x-enum-varnames": [ - "CANCELED", - "EXPIRED" - ] - }, - "type": "array" - }, - "schedule": { - "description": "Schedule for the downtime.", - "oneOf": [ - { - "additionalProperties": false, - "description": "A recurring downtime schedule definition.", - "properties": { - "recurrences": { - "description": "A list of downtime recurrences.", - "items": { - "additionalProperties": {}, - "description": "An object defining the recurrence of the downtime.", - "properties": { - "duration": { - "description": "The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.", - "example": "123d", - "type": "string" - }, - "rrule": { - "description": "The `RRULE` standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.\nMost common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.\n\n**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).\nMore examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).", - "example": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1", - "type": "string" - }, - "start": { - "description": "ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.", - "example": "2020-01-02T03:04", - "nullable": true, - "type": "string" - } - }, - "required": [ - "duration", - "rrule" - ], - "type": "object" - }, - "type": "array" - }, - "timezone": { - "default": "UTC", - "description": "The timezone in which to schedule the downtime.", - "example": "America/New_York", - "type": "string" - } - }, - "type": "object" - }, - { - "additionalProperties": false, - "description": "A one-time downtime definition.", - "properties": { - "end": { - "description": "ISO-8601 Datetime to end the downtime. Must include a UTC offset of zero. If not provided, the\ndowntime continues forever.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "start": { - "description": "ISO-8601 Datetime to start the downtime. Must include a UTC offset of zero. If not provided, the\ndowntime starts the moment it is created.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - } - }, - "type": "object" - } - ] - }, - "scope": { - "description": "The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).", - "example": "env:(staging OR prod) AND datacenter:us-east-1", - "type": "string" - } - }, - "type": "object" - }, "id": { - "description": "ID of this downtime.", - "example": "00000000-0000-1234-0000-000000000000", + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", "type": "string" }, "type": { - "default": "downtime", - "description": "Downtime resource type.", + "description": "Type of the object.", "enum": [ - "downtime" + "assignee" ], - "example": "downtime", + "example": "assignee", "type": "string", "x-enum-varnames": [ - "DOWNTIME" + "ASSIGNEE" ] } }, "required": [ "id", - "type", - "attributes" + "type" ], "type": "object" } @@ -420749,7 +429368,7 @@ } } }, - "description": "Update a downtime request body.", + "description": "Update issue assignee request payload.", "required": true }, "responses": { @@ -420757,434 +429376,520 @@ "content": { "application/json": { "schema": { - "description": "Downtiming gives you greater control over monitor notifications by\nallowing you to globally exclude scopes from alerting.\nDowntime settings, which can be scheduled with start and end times,\nprevent all alerting related to specified Datadog tags.", + "description": "Response containing error tracking issue data.", "properties": { "data": { - "description": "Downtime data.", + "description": "The issue matching the request.", "properties": { "attributes": { - "description": "Downtime details.", + "description": "Object containing the information of an issue.", "properties": { - "canceled": { - "description": "Time that the downtime was canceled.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", - "nullable": true, + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", "type": "string" }, - "created": { - "description": "Creation time of the downtime.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", "type": "string" }, - "display_timezone": { - "default": "UTC", - "description": "The timezone in which to display the downtime's start and end times in Datadog applications. This is not used\nas an offset for scheduling.", - "example": "America/New_York", - "nullable": true, + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", "type": "string" }, - "message": { - "description": "A message to include with notifications for this downtime. Email notifications can be sent to specific users\nby using the same `@username` notation as events.", - "example": "Message about the downtime", - "nullable": true, - "type": "string" + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" }, - "modified": { - "description": "Time that the downtime was last modified.", - "example": "2020-01-02T03:04:05.282979+0000", - "format": "date-time", + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", "type": "string" }, - "monitor_identifier": { - "description": "Monitor identifier for the downtime.", - "oneOf": [ - { - "additionalProperties": {}, - "description": "Object of the monitor identifier.", - "properties": { - "monitor_id": { - "description": "ID of the monitor to prevent notifications.", - "example": 123, - "format": "int64", - "type": "integer" - } - }, - "required": [ - "monitor_id" - ], - "type": "object" - }, - { - "additionalProperties": {}, - "description": "Object of the monitor tags.", - "properties": { - "monitor_tags": { - "description": "A list of monitor tags. For example, tags that are applied directly to monitors,\nnot tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies.\nThe resulting downtime applies to monitors that match **all** provided monitor tags. Setting `monitor_tags`\nto `[*]` configures the downtime to mute all monitors for the given scope.", - "example": [ - "service:postgres", - "team:frontend" - ], - "items": { - "description": "A list of monitor tags.", - "example": "service:postgres", - "type": "string" - }, - "minItems": 1, - "type": "array" - } - }, - "required": [ - "monitor_tags" - ], - "type": "object" - } - ] + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" }, - "mute_first_recovery_notification": { - "description": "If the first recovery notification during a downtime should be muted.", + "is_crash": { + "description": "Error is a crash.", "example": false, "type": "boolean" }, - "notify_end_states": { - "description": "States that will trigger a monitor notification when the `notify_end_types` action occurs.", + "languages": { + "description": "Array of programming languages associated with the issue.", "example": [ - "alert", - "warn" + "PYTHON", + "GO" ], "items": { - "description": "State that will trigger a monitor notification when the `notify_end_types` action occurs.", + "description": "Programming language associated with the issue.", "enum": [ - "alert", - "no data", - "warn" + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" ], - "example": "alert", + "example": "PYTHON", "type": "string", "x-enum-varnames": [ - "ALERT", - "NO_DATA", - "WARN" + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" ] }, "type": "array" }, - "notify_end_types": { - "description": "Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", - "example": [ - "canceled", - "expired" - ], - "items": { - "description": "Action that will trigger a monitor notification if the downtime is in the `notify_end_types` state.", - "enum": [ - "canceled", - "expired" - ], - "example": "canceled", - "type": "string", - "x-enum-varnames": [ - "CANCELED", - "EXPIRED" - ] - }, - "type": "array" + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" }, - "schedule": { - "description": "The schedule that defines when the monitor starts, stops, and recurs. There are two types of schedules:\none-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are\nprovided, the downtime will begin immediately and never end.", - "oneOf": [ - { - "description": "A recurring downtime schedule definition.", - "properties": { - "current_downtime": { - "description": "The most recent actual start and end dates for a recurring downtime. For a canceled downtime,\nthis is the previously occurring downtime. For active downtimes, this is the ongoing downtime, and for scheduled\ndowntimes it is the upcoming downtime.", - "properties": { - "end": { - "description": "The end of the current downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "start": { - "description": "The start of the current downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "recurrences": { - "description": "A list of downtime recurrences.", - "items": { - "description": "An RRULE-based recurring downtime.", - "properties": { - "duration": { - "description": "The length of the downtime. Must begin with an integer and end with one of 'm', 'h', d', or 'w'.", - "example": "123d", - "type": "string" - }, - "rrule": { - "description": "The `RRULE` standard for defining recurring events.\nFor example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`.\nMost common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported.\n\n**Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`).\nMore examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api).", - "example": "FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1", - "type": "string" - }, - "start": { - "description": "ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the\ndowntime starts the moment it is created.", - "example": "2020-01-02T03:04", - "type": "string" - } - }, - "type": "object" - }, - "maxItems": 5, - "minItems": 1, - "type": "array" - }, - "timezone": { - "default": "UTC", - "description": "The timezone in which to schedule the downtime. This affects recurring start and end dates.\nMust match `display_timezone`.", - "example": "America/New_York", - "type": "string" - } - }, - "required": [ - "recurrences" - ], - "type": "object" - }, - { - "description": "A one-time downtime definition.", - "properties": { - "end": { - "description": "ISO-8601 Datetime to end the downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "start": { - "description": "ISO-8601 Datetime to start the downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "type": "string" - } - }, - "required": [ - "start" - ], - "type": "object" - } + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" ] }, - "scope": { - "description": "The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).", - "example": "env:(staging OR prod) AND datacenter:us-east-1", + "service": { + "description": "Service name.", + "example": "email-api-py", "type": "string" }, - "status": { - "description": "The current status of the downtime.", + "state": { + "description": "State of the issue", "enum": [ - "active", - "canceled", - "ended", - "scheduled" + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" ], - "example": "active", + "example": "RESOLVED", "type": "string", "x-enum-varnames": [ - "ACTIVE", - "CANCELED", - "ENDED", - "SCHEDULED" + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" ] } }, "type": "object" }, "id": { - "description": "The downtime ID.", - "example": "00000000-0000-1234-0000-000000000000", + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", "type": "string" }, "relationships": { - "description": "All relationships associated with downtime.", + "description": "Relationship between the issue and an assignee, case and/or teams.", "properties": { - "created_by": { - "description": "The user who created the downtime.", + "assignee": { + "description": "Relationship between the issue and assignee.", "properties": { "data": { - "description": "Data for the user who created the downtime.", - "nullable": true, + "description": "The user the issue is assigned to.", "properties": { "id": { - "description": "User ID of the downtime creator.", - "example": "00000000-0000-1234-0000-000000000000", + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", "type": "string" }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "Type of the object", "enum": [ - "users" + "user" ], - "example": "users", + "example": "user", "type": "string", "x-enum-varnames": [ - "USERS" + "USER" ] } }, + "required": [ + "id", + "type" + ], "type": "object" } }, + "required": [ + "data" + ], "type": "object" }, - "monitor": { - "description": "The monitor identified by the downtime.", + "case": { + "description": "Relationship between the issue and case.", "properties": { "data": { - "description": "Data for the monitor.", - "nullable": true, + "description": "The case the issue is attached to.", "properties": { "id": { - "description": "Monitor ID of the downtime.", - "example": "12345", + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, "type": { - "default": "monitors", - "description": "Monitor resource type.", + "description": "Type of the object.", "enum": [ - "monitors" + "case" ], - "example": "monitors", + "example": "case", "type": "string", "x-enum-varnames": [ - "MONITORS" + "CASE" ] } }, + "required": [ + "id", + "type" + ], "type": "object" } }, + "required": [ + "data" + ], + "type": "object" + }, + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], "type": "object" } }, "type": "object" }, "type": { - "default": "downtime", - "description": "Downtime resource type.", + "description": "Type of the object.", "enum": [ - "downtime" + "issue" ], - "example": "downtime", + "example": "issue", "type": "string", "x-enum-varnames": [ - "DOWNTIME" + "ISSUE" ] } }, + "required": [ + "id", + "type", + "attributes" + ], "type": "object" }, "included": { - "description": "Array of objects related to the downtime that the user requested.", + "description": "Array of resources related to the issue.", "items": { - "description": "An object related to a downtime.", + "description": "An array of related resources, returned when the `include` query parameter is used.", "oneOf": [ { - "description": "User object returned by the API.", + "description": "The case attached to the issue.", "properties": { "attributes": { - "description": "Attributes of user object returned by the API.", + "description": "Object containing the information of a case.", "properties": { - "created_at": { - "description": "Creation time of the user.", + "archived_at": { + "description": "Timestamp of when the case was archived.", + "example": "2025-01-01T00:00:00Z", "format": "date-time", "type": "string" }, - "disabled": { - "description": "Whether the user is disabled.", - "type": "boolean" + "closed_at": { + "description": "Timestamp of when the case was closed.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" }, - "email": { - "description": "Email of the user.", + "created_at": { + "description": "Timestamp of when the case was created.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", "type": "string" }, - "handle": { - "description": "Handle of the user.", + "creation_source": { + "description": "Source of the case creation.", + "example": "ERROR_TRACKING", "type": "string" }, - "icon": { - "description": "URL of the user's icon.", + "description": { + "description": "Description of the case.", "type": "string" }, - "mfa_enabled": { - "description": "If user has MFA enabled.", - "readOnly": true, - "type": "boolean" + "due_date": { + "description": "Due date of the case.", + "example": "2025-01-01", + "type": "string" }, - "modified_at": { - "description": "Time that the user was last modified.", - "format": "date-time", + "insights": { + "description": "Insights of the case.", + "items": { + "description": "Insight of the case.", + "properties": { + "ref": { + "description": "Reference of the insight.", + "example": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "resource_id": { + "description": "Insight identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the insight.", + "example": "ERROR_TRACKING", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "jira_issue": { + "description": "Jira issue of the case.", + "properties": { + "result": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", + "properties": { + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", + "type": "string" + }, + "project_key": { + "description": "Jira project key.", + "example": "ET", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Creation status of the Jira issue.", + "example": "COMPLETED", + "type": "string" + } + }, + "type": "object" + }, + "key": { + "description": "Key of the case.", + "example": "ET-123", "type": "string" }, - "name": { - "description": "Name of the user.", - "nullable": true, + "modified_at": { + "description": "Timestamp of when the case was last modified.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", "type": "string" }, - "service_account": { - "description": "Whether the user is a service account.", - "type": "boolean" + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] }, "status": { - "description": "Status of the user.", - "type": "string" + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ], + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] }, "title": { - "description": "Title of the user.", - "nullable": true, + "description": "Title of the case.", + "example": "Error: HTTP error", "type": "string" }, - "verified": { - "description": "Whether the user is verified.", - "type": "boolean" + "type": { + "description": "Type of the case.", + "example": "ERROR_TRACKING_ISSUE", + "type": "string" } }, "type": "object" }, "id": { - "description": "ID of the user.", + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", "type": "string" }, "relationships": { - "description": "Relationships of the user object returned by the API.", + "description": "Resources related to a case.", "properties": { - "org": { - "description": "Relationship to an organization.", + "assignee": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationship to organization object.", + "description": "Relationship to user object.", + "nullable": true, "properties": { "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" }, "type": { - "default": "orgs", - "description": "Organizations resource type.", + "default": "user", + "description": "User resource type.", "enum": [ - "orgs" + "user" ], - "example": "orgs", + "example": "user", "type": "string", "x-enum-varnames": [ - "ORGS" + "USER" ] } }, @@ -421200,40 +429905,37 @@ ], "type": "object" }, - "other_orgs": { - "description": "Relationship to organizations.", + "created_by": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationships to organization objects.", - "example": [], - "items": { - "description": "Relationship to organization object.", - "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", - "type": "string" - }, - "type": { - "default": "orgs", - "description": "Organizations resource type.", - "enum": [ - "orgs" - ], - "example": "orgs", - "type": "string", - "x-enum-varnames": [ - "ORGS" - ] - } + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object" + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, "required": [ @@ -421241,43 +429943,37 @@ ], "type": "object" }, - "other_users": { - "description": "Relationship to users.", + "modified_by": { + "description": "Relationship to user.", + "nullable": true, "properties": { "data": { - "description": "Relationships to user objects.", - "example": [], - "items": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, "required": [ @@ -421285,102 +429981,158 @@ ], "type": "object" }, - "roles": { - "description": "Relationship to roles.", + "project": { + "description": "Relationship to project", "properties": { "data": { - "description": "An array containing type and the unique identifier of a role.", - "items": { - "description": "Relationship to role object.", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" - }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" }, - "type": "object", - "x-merge-override": { - "required": false + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "data" + ], + "type": "object" } }, - "type": "object", - "x-merge-override": { - "properties": false - } + "type": "object" }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "Type of the object.", "enum": [ - "users" + "case" ], - "example": "users", + "example": "case", "type": "string", "x-enum-varnames": [ - "USERS" + "CASE" ] } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" }, { - "description": "Information about the monitor identified by the downtime.", + "description": "The user to whom the issue is assigned.", "properties": { "attributes": { - "description": "Attributes of the monitor identified by the downtime.", + "description": "Object containing the information of a user.", "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, "name": { - "description": "The name of the monitor identified by the downtime.", - "example": "A monitor name", + "description": "Name of the user.", + "example": "User Name", "type": "string" } }, "type": "object" }, "id": { - "description": "ID of the monitor identified by the downtime.", - "example": 12345, - "format": "int64", - "type": "integer" + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" }, "type": { - "default": "monitors", - "description": "Monitor resource type.", + "description": "Type of the object", "enum": [ - "monitors" + "user" ], - "example": "monitors", + "example": "user", "type": "string", "x-enum-varnames": [ - "MONITORS" + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" ] } }, + "required": [ + "id", + "type", + "attributes" + ], "type": "object" } ] @@ -421422,6 +430174,34 @@ }, "description": "Bad Request" }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, "403": { "content": { "application/json": { @@ -421476,7 +430256,7 @@ } } }, - "description": "Downtime not found" + "description": "Not Found" }, "429": { "content": { @@ -421514,22 +430294,1044 @@ }, { "AuthZ": [ - "monitors_downtime" + "error_tracking_read", + "error_tracking_write", + "cases_read", + "cases_write" ] } ], - "summary": "Update a downtime", + "summary": "Update the assignee of an issue", "tags": [ - "Downtimes" + "Error Tracking" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 6, - "x-permission": { - "operator": "OR", - "permissions": [ - "monitors_downtime" - ] + "x-menu-order": 4, + "x-undo": { + "type": "idempotent" + } + } + }, + "/api/v2/error-tracking/issues/{issue_id}/state": { + "put": { + "description": "Update the state of an issue by `issue_id`. Use this endpoint to move an issue between states such as `OPEN`, `RESOLVED`, or `IGNORED`.", + "operationId": "UpdateIssueState", + "parameters": [ + { + "description": "The identifier of the issue.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "in": "path", + "name": "issue_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Update issue state request payload.", + "properties": { + "data": { + "description": "Update issue state request.", + "properties": { + "attributes": { + "description": "Object describing an issue state update request.", + "properties": { + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "required": [ + "state" + ], + "type": "object" + }, + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "error_tracking_issue" + ], + "example": "error_tracking_issue", + "type": "string", + "x-enum-varnames": [ + "ERROR_TRACKING_ISSUE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Update issue state request payload.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response containing error tracking issue data.", + "properties": { + "data": { + "description": "The issue matching the request.", + "properties": { + "attributes": { + "description": "Object containing the information of an issue.", + "properties": { + "error_message": { + "description": "Error message associated with the issue.", + "example": "object of type 'NoneType' has no len()", + "type": "string" + }, + "error_type": { + "description": "Type of the error that matches the issue.", + "example": "builtins.TypeError", + "type": "string" + }, + "file_path": { + "description": "Path of the file where the issue occurred.", + "example": "/django-email/conduit/apps/core/utils.py", + "type": "string" + }, + "first_seen": { + "description": "Timestamp of the first seen error in milliseconds since the Unix epoch.", + "example": 1671612804001, + "format": "int64", + "type": "integer" + }, + "first_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was first observed.", + "example": "aaf65cd0", + "type": "string" + }, + "function_name": { + "description": "Name of the function where the issue occurred.", + "example": "filter_forbidden_tags", + "type": "string" + }, + "is_crash": { + "description": "Error is a crash.", + "example": false, + "type": "boolean" + }, + "languages": { + "description": "Array of programming languages associated with the issue.", + "example": [ + "PYTHON", + "GO" + ], + "items": { + "description": "Programming language associated with the issue.", + "enum": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ], + "example": "PYTHON", + "type": "string", + "x-enum-varnames": [ + "BRIGHTSCRIPT", + "C", + "C_PLUS_PLUS", + "C_SHARP", + "CLOJURE", + "DOT_NET", + "ELIXIR", + "ERLANG", + "GO", + "GROOVY", + "HASKELL", + "HCL", + "JAVA", + "JAVASCRIPT", + "JVM", + "KOTLIN", + "OBJECTIVE_C", + "PERL", + "PHP", + "PYTHON", + "RUBY", + "RUST", + "SCALA", + "SWIFT", + "TERRAFORM", + "TYPESCRIPT", + "UNKNOWN" + ] + }, + "type": "array" + }, + "last_seen": { + "description": "Timestamp of the last seen error in milliseconds since the Unix epoch.", + "example": 1671620003100, + "format": "int64", + "type": "integer" + }, + "last_seen_version": { + "description": "The application version (for example, git commit hash) where the issue was last observed.", + "example": "b6199f80", + "type": "string" + }, + "platform": { + "description": "Platform associated with the issue.", + "enum": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ], + "example": "BACKEND", + "type": "string", + "x-enum-varnames": [ + "ANDROID", + "BACKEND", + "BROWSER", + "FLUTTER", + "IOS", + "REACT_NATIVE", + "ROKU", + "UNKNOWN" + ] + }, + "service": { + "description": "Service name.", + "example": "email-api-py", + "type": "string" + }, + "state": { + "description": "State of the issue", + "enum": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ], + "example": "RESOLVED", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "ACKNOWLEDGED", + "RESOLVED", + "IGNORED", + "EXCLUDED" + ] + } + }, + "type": "object" + }, + "id": { + "description": "Issue identifier.", + "example": "c1726a66-1f64-11ee-b338-da7ad0900002", + "type": "string" + }, + "relationships": { + "description": "Relationship between the issue and an assignee, case and/or teams.", + "properties": { + "assignee": { + "description": "Relationship between the issue and assignee.", + "properties": { + "data": { + "description": "The user the issue is assigned to.", + "properties": { + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "case": { + "description": "Relationship between the issue and case.", + "properties": { + "data": { + "description": "The case the issue is attached to.", + "properties": { + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "team_owners": { + "description": "Relationship between the issue and teams.", + "properties": { + "data": { + "description": "Array of teams that are owners of the issue.", + "items": { + "description": "A team that owns the issue.", + "properties": { + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "issue" + ], + "example": "issue", + "type": "string", + "x-enum-varnames": [ + "ISSUE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "included": { + "description": "Array of resources related to the issue.", + "items": { + "description": "An array of related resources, returned when the `include` query parameter is used.", + "oneOf": [ + { + "description": "The case attached to the issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a case.", + "properties": { + "archived_at": { + "description": "Timestamp of when the case was archived.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "closed_at": { + "description": "Timestamp of when the case was closed.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "created_at": { + "description": "Timestamp of when the case was created.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "creation_source": { + "description": "Source of the case creation.", + "example": "ERROR_TRACKING", + "type": "string" + }, + "description": { + "description": "Description of the case.", + "type": "string" + }, + "due_date": { + "description": "Due date of the case.", + "example": "2025-01-01", + "type": "string" + }, + "insights": { + "description": "Insights of the case.", + "items": { + "description": "Insight of the case.", + "properties": { + "ref": { + "description": "Reference of the insight.", + "example": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "resource_id": { + "description": "Insight identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "type": { + "description": "Type of the insight.", + "example": "ERROR_TRACKING", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "jira_issue": { + "description": "Jira issue of the case.", + "properties": { + "result": { + "description": "Contains the identifiers and URL for a successfully created Jira issue.", + "properties": { + "issue_id": { + "description": "Jira issue identifier.", + "example": "1904866", + "type": "string" + }, + "issue_key": { + "description": "Jira issue key.", + "example": "ET-123", + "type": "string" + }, + "issue_url": { + "description": "Jira issue URL.", + "example": "https://your-jira-instance.atlassian.net/browse/ET-123", + "type": "string" + }, + "project_key": { + "description": "Jira project key.", + "example": "ET", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "Creation status of the Jira issue.", + "example": "COMPLETED", + "type": "string" + } + }, + "type": "object" + }, + "key": { + "description": "Key of the case.", + "example": "ET-123", + "type": "string" + }, + "modified_at": { + "description": "Timestamp of when the case was last modified.", + "example": "2025-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "priority": { + "default": "NOT_DEFINED", + "description": "Case priority", + "enum": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ], + "example": "NOT_DEFINED", + "type": "string", + "x-enum-varnames": [ + "NOT_DEFINED", + "P1", + "P2", + "P3", + "P4", + "P5" + ] + }, + "status": { + "description": "Case status", + "enum": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ], + "example": "OPEN", + "type": "string", + "x-enum-varnames": [ + "OPEN", + "IN_PROGRESS", + "CLOSED" + ] + }, + "title": { + "description": "Title of the case.", + "example": "Error: HTTP error", + "type": "string" + }, + "type": { + "description": "Type of the case.", + "example": "ERROR_TRACKING_ISSUE", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Case identifier.", + "example": "2841440d-e780-4fe2-96cd-6a8c1d194da5", + "type": "string" + }, + "relationships": { + "description": "Resources related to a case.", + "properties": { + "assignee": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "created_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modified_by": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", + "nullable": true, + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "user", + "description": "User resource type.", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "project": { + "description": "Relationship to project", + "properties": { + "data": { + "description": "Relationship to project object", + "properties": { + "id": { + "description": "A unique identifier that represents the project", + "example": "e555e290-ed65-49bd-ae18-8acbfcf18db7", + "type": "string" + }, + "type": { + "default": "project", + "description": "Project resource type", + "enum": [ + "project" + ], + "example": "project", + "type": "string", + "x-enum-varnames": [ + "PROJECT" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "case" + ], + "example": "case", + "type": "string", + "x-enum-varnames": [ + "CASE" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "The user to whom the issue is assigned.", + "properties": { + "attributes": { + "description": "Object containing the information of a user.", + "properties": { + "email": { + "description": "Email of the user.", + "example": "user@company.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "User Handle", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "User Name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "User identifier.", + "example": "87cb11a0-278c-440a-99fe-701223c80296", + "type": "string" + }, + "type": { + "description": "Type of the object", + "enum": [ + "user" + ], + "example": "user", + "type": "string", + "x-enum-varnames": [ + "USER" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + { + "description": "A team that owns an issue.", + "properties": { + "attributes": { + "description": "Object containing the information of a team.", + "properties": { + "handle": { + "description": "The team's identifier.", + "example": "team-handle", + "type": "string" + }, + "name": { + "description": "The name of the team.", + "example": "Team Name", + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from its description.", + "example": "This is a team.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Team identifier.", + "example": "221b0179-6447-4d03-91c3-3ca98bf60e8a", + "type": "string" + }, + "type": { + "description": "Type of the object.", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + ] + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "401": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "error_tracking_read", + "error_tracking_write" + ] + } + ], + "summary": "Update the state of an issue", + "tags": [ + "Error Tracking" + ], + "x-menu-order": 3, "x-undo": { "type": "idempotent" } @@ -637318,6 +647120,10 @@ "description": "**Note**: Downtime V2 is currently in private beta. To request access, contact [Datadog support](https://docs.datadoghq.com/help/).\n\n[Downtiming](https://docs.datadoghq.com/monitors/notify/downtimes) gives\nyou greater control over monitor notifications by allowing you to globally exclude\nscopes from alerting. Downtime settings, which can be scheduled with start and\nend times, prevent all alerting related to specified Datadog tags.", "name": "Downtimes" }, + { + "description": "View and manage issues within Error Tracking. See the [Error Tracking page](https://docs.datadoghq.com/error_tracking/) for more information.", + "name": "Error Tracking" + }, { "description": "The Event Management API allows you to programmatically post events to the Events Explorer and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/) for more information.\n\n**Update to Datadog monitor events `aggregation_key` starting March 1, 2025:** The Datadog monitor events `aggregation_key` is unique to each Monitor ID. Starting March 1st, this key will also include Monitor Group, making it unique per *Monitor ID and Monitor Group*. If you're using monitor events `aggregation_key` in dashboard queries or the Event API, you must migrate to use `@monitor.id`. Reach out to [support](https://www.datadoghq.com/support/) if you have any question.", "name": "Events"