diff --git a/.apigentools-info b/.apigentools-info index 30d4de47de1a9..9c79c4365bec6 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2024-11-11 17:26:39.551962", - "spec_repo_commit": "9de1804a" + "regenerated": "2024-11-12 17:53:18.357427", + "spec_repo_commit": "63b58a77" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2024-11-11 17:26:47.435208", - "spec_repo_commit": "9de1804a" + "regenerated": "2024-11-12 17:53:26.283892", + "spec_repo_commit": "63b58a77" } } } \ No newline at end of file diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 974d13ccb39c9..0d5f15f2a7828 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -22,6 +22,32 @@ menu: url: /api/latest/aws-integration/ identifier: aws-integration generated: true + - name: List available namespaces + url: '#list-available-namespaces' + identifier: aws-integration-list-available-namespaces + parent: aws-integration + generated: true + params: + versions: + - v2 + operationids: + - ListAWSNamespaces + unstable: + - v2 + order: 1 + - name: Get an AWS integration by config ID + url: '#get-an-aws-integration-by-config-id' + identifier: aws-integration-get-an-aws-integration-by-config-id + parent: aws-integration + generated: true + params: + versions: + - v2 + operationids: + - GetAWSAccount + unstable: + - v2 + order: 3 - name: Generate a new external ID url: '#generate-a-new-external-id' identifier: aws-integration-generate-a-new-external-id @@ -30,9 +56,11 @@ menu: params: versions: - v1 + - v2 operationids: - CreateNewAWSExternalID - unstable: [] + unstable: + - v2 order: 4 - name: Set an AWS tag filter url: '#set-an-aws-tag-filter' @@ -126,9 +154,11 @@ menu: params: versions: - v1 + - v2 operationids: - UpdateAWSAccount - unstable: [] + unstable: + - v2 order: 9 - name: Create an AWS integration url: '#create-an-aws-integration' @@ -138,9 +168,11 @@ menu: params: versions: - v1 + - v2 operationids: - CreateAWSAccount - unstable: [] + unstable: + - v2 order: 8 - name: List all AWS integrations url: '#list-all-aws-integrations' @@ -150,9 +182,11 @@ menu: params: versions: - v1 + - v2 operationids: - ListAWSAccounts - unstable: [] + unstable: + - v2 order: 6 - name: Delete an AWS integration url: '#delete-an-aws-integration' @@ -162,9 +196,11 @@ menu: params: versions: - v1 + - v2 operationids: - DeleteAWSAccount - unstable: [] + unstable: + - v2 order: 7 - name: AWS Logs Integration url: /api/latest/aws-logs-integration/ @@ -202,9 +238,11 @@ menu: params: versions: - v1 + - v2 operationids: - ListAWSLogsServices - unstable: [] + unstable: + - v2 order: 4 - name: Check that an AWS Lambda Function exists url: '#check-that-an-aws-lambda-function-exists' diff --git a/content/en/api/v2/aws-integration/examples.json b/content/en/api/v2/aws-integration/examples.json index 9e26dfeeb6e64..776efe47d9746 100644 --- a/content/en/api/v2/aws-integration/examples.json +++ b/content/en/api/v2/aws-integration/examples.json @@ -1 +1,638 @@ -{} \ No newline at end of file +{ + "ListAWSAccounts": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "account_tags": [ + "key:value" + ], + "auth_config": { + "access_key_id": "AKIAIOSFODNN7EXAMPLE", + "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + }, + "aws_account_id": "123456789012", + "aws_partition": "aws", + "aws_regions": { + "include_all": false + }, + "created_at": "2019-09-19T10:00:00.000Z", + "logs_config": { + "lambda_forwarder": { + "lambdas": [ + "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder" + ], + "sources": [ + "s3" + ] + } + }, + "metrics_config": { + "automute_enabled": true, + "collect_cloudwatch_alarms": true, + "collect_custom_metrics": true, + "enabled": true, + "namespace_filters": { + "exclude_all": false + }, + "tag_filters": [ + { + "namespace": "AWS/EC2", + "tags": [ + "key:value" + ] + } + ] + }, + "modified_at": "2019-09-19T10:00:00.000Z", + "resources_config": { + "cloud_security_posture_management_collection": false, + "extended_collection": false + }, + "traces_config": { + "xray_services": { + "include_all": false + } + } + }, + "id": "00000000-abcd-0001-0000-000000000000", + "type": "account" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of AWS Account Integration Configs

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

attributes

\n
\n

object

\n

The AWS Account Integration Config

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

account_tags

\n
\n

[string]

\n

Tags to apply to all metrics in the account

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

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config

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

Option 1

\n
\n

object

\n

AWS Authentication config for key-based account

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

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID

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

secret_access_key

\n
\n

string

\n

AWS Secret Access Key

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

Option 2

\n
\n

object

\n

AWS Authentication config for role-based account

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

external_id

\n
\n

string

\n

AWS IAM External ID for associated role

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

role_name [required]

\n
\n

string

\n

AWS IAM Role name

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

aws_account_id [required]

\n
\n

string

\n

AWS Account ID

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

aws_partition

\n
\n

enum

\n

AWS Account partition \nAllowed enum values: aws,aws-cn,aws-us-gov

default: aws

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

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from

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

Option 1

\n
\n

\n

Include all regions

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

include_all [required]

\n
\n

boolean

\n

Include all regions

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

Option 2

\n
\n

\n

Include only these regions

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

include_only [required]

\n
\n

[string]

\n

Include only these regions

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

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created

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

logs_config

\n
\n

object

\n

AWS Logs config

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

lambda_forwarder

\n
\n

object

\n

AWS Lambda forwarder

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

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs

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

sources

\n
\n

[string]

\n

List of AWS services that will send logs to the Datadog Lambda Log Forwarder

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

metrics_config

\n
\n

object

\n

AWS Metrics config

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

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics

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

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection

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

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection

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

enabled

\n
\n

boolean

\n

Enable AWS metrics collection

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

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters

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

Option 1

\n
\n

\n

Exclude all namespaces

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

exclude_all [required]

\n
\n

boolean

\n

Exclude all namespaces

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

Option 2

\n
\n

\n

Exclude only these namespaces

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

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces

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

Option 3

\n
\n

\n

Include all namespaces

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

include_all [required]

\n
\n

boolean

\n

Include all namespaces

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

Option 4

\n
\n

\n

Include only these namespaces

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

include_only [required]

\n
\n

[string]

\n

Include only these namespaces

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

tag_filters

\n
\n

[object]

\n

AWS Metrics tag filters list

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

namespace

\n
\n

string

\n

The AWS Namespace to apply the tag filters against

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

tags

\n
\n

[string]

\n

The tags to filter based on

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

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated

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

resources_config

\n
\n

object

\n

AWS Resources config

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

cloud_security_posture_management_collection

\n
\n

boolean

\n

Whether Datadog collects cloud security posture management resources from your AWS account.

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

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection.

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

traces_config

\n
\n

object

\n

AWS Traces config

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

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from

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

Option 1

\n
\n

\n

Include all services

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

include_all [required]

\n
\n

boolean

\n

Include all services

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

Option 2

\n
\n

\n

Include only these services

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

include_only [required]

\n
\n

[string]

\n

Include only these services

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

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config

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

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \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": {}, + "json": {}, + "html": "" + } + }, + "CreateAWSAccount": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "account_tags": [ + "key:value" + ], + "auth_config": { + "access_key_id": "AKIAIOSFODNN7EXAMPLE", + "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + }, + "aws_account_id": "123456789012", + "aws_partition": "aws", + "aws_regions": { + "include_all": false + }, + "created_at": "2019-09-19T10:00:00.000Z", + "logs_config": { + "lambda_forwarder": { + "lambdas": [ + "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder" + ], + "sources": [ + "s3" + ] + } + }, + "metrics_config": { + "automute_enabled": true, + "collect_cloudwatch_alarms": true, + "collect_custom_metrics": true, + "enabled": true, + "namespace_filters": { + "exclude_all": false + }, + "tag_filters": [ + { + "namespace": "AWS/EC2", + "tags": [ + "key:value" + ] + } + ] + }, + "modified_at": "2019-09-19T10:00:00.000Z", + "resources_config": { + "cloud_security_posture_management_collection": false, + "extended_collection": false + }, + "traces_config": { + "xray_services": { + "include_all": false + } + } + }, + "id": "00000000-abcd-0001-0000-000000000000", + "type": "account" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account Response body

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

attributes

\n
\n

object

\n

The AWS Account Integration Config

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

account_tags

\n
\n

[string]

\n

Tags to apply to all metrics in the account

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

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config

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

Option 1

\n
\n

object

\n

AWS Authentication config for key-based account

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

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID

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

secret_access_key

\n
\n

string

\n

AWS Secret Access Key

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

Option 2

\n
\n

object

\n

AWS Authentication config for role-based account

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

external_id

\n
\n

string

\n

AWS IAM External ID for associated role

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

role_name [required]

\n
\n

string

\n

AWS IAM Role name

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

aws_account_id [required]

\n
\n

string

\n

AWS Account ID

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

aws_partition

\n
\n

enum

\n

AWS Account partition \nAllowed enum values: aws,aws-cn,aws-us-gov

default: aws

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

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from

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

Option 1

\n
\n

\n

Include all regions

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

include_all [required]

\n
\n

boolean

\n

Include all regions

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

Option 2

\n
\n

\n

Include only these regions

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

include_only [required]

\n
\n

[string]

\n

Include only these regions

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

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created

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

logs_config

\n
\n

object

\n

AWS Logs config

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

lambda_forwarder

\n
\n

object

\n

AWS Lambda forwarder

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

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs

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

sources

\n
\n

[string]

\n

List of AWS services that will send logs to the Datadog Lambda Log Forwarder

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

metrics_config

\n
\n

object

\n

AWS Metrics config

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

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics

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

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection

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

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection

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

enabled

\n
\n

boolean

\n

Enable AWS metrics collection

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

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters

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

Option 1

\n
\n

\n

Exclude all namespaces

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

exclude_all [required]

\n
\n

boolean

\n

Exclude all namespaces

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

Option 2

\n
\n

\n

Exclude only these namespaces

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

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces

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

Option 3

\n
\n

\n

Include all namespaces

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

include_all [required]

\n
\n

boolean

\n

Include all namespaces

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

Option 4

\n
\n

\n

Include only these namespaces

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

include_only [required]

\n
\n

[string]

\n

Include only these namespaces

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

tag_filters

\n
\n

[object]

\n

AWS Metrics tag filters list

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

namespace

\n
\n

string

\n

The AWS Namespace to apply the tag filters against

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

tags

\n
\n

[string]

\n

The tags to filter based on

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

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated

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

resources_config

\n
\n

object

\n

AWS Resources config

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

cloud_security_posture_management_collection

\n
\n

boolean

\n

Whether Datadog collects cloud security posture management resources from your AWS account.

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

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection.

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

traces_config

\n
\n

object

\n

AWS Traces config

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

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from

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

Option 1

\n
\n

\n

Include all services

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

include_all [required]

\n
\n

boolean

\n

Include all services

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

Option 2

\n
\n

\n

Include only these services

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

include_only [required]

\n
\n

[string]

\n

Include only these services

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

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config

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

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\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
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "409": { + "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": { + "auth_config": {}, + "aws_account_id": "123456789012", + "aws_partition": "aws" + }, + "type": "account" + } + }, + "json": { + "data": { + "attributes": { + "account_tags": [ + "key:value" + ], + "auth_config": { + "access_key_id": "AKIAIOSFODNN7EXAMPLE", + "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + }, + "aws_account_id": "123456789012", + "aws_partition": "aws", + "aws_regions": { + "include_all": false + }, + "logs_config": { + "lambda_forwarder": { + "lambdas": [ + "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder" + ], + "sources": [ + "s3" + ] + } + }, + "metrics_config": { + "automute_enabled": true, + "collect_cloudwatch_alarms": true, + "collect_custom_metrics": true, + "enabled": true, + "namespace_filters": { + "exclude_all": false + }, + "tag_filters": [ + { + "namespace": "AWS/EC2", + "tags": [ + "key:value" + ] + } + ] + }, + "resources_config": { + "cloud_security_posture_management_collection": false, + "extended_collection": false + }, + "traces_config": { + "xray_services": { + "include_all": false + } + } + }, + "type": "account" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account Create Request data

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

attributes [required]

\n
\n

object

\n

The AWS Account Integration Config to be created

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

account_tags

\n
\n

[string]

\n

Tags to apply to all metrics in the account

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

auth_config [required]

\n
\n

 <oneOf>

\n

AWS Authentication config

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

Option 1

\n
\n

object

\n

AWS Authentication config for key-based account

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

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID

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

secret_access_key

\n
\n

string

\n

AWS Secret Access Key

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

Option 2

\n
\n

object

\n

AWS Authentication config for role-based account

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

external_id

\n
\n

string

\n

AWS IAM External ID for associated role

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

role_name [required]

\n
\n

string

\n

AWS IAM Role name

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

aws_account_id [required]

\n
\n

string

\n

AWS Account ID

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

aws_partition [required]

\n
\n

enum

\n

AWS Account partition \nAllowed enum values: aws,aws-cn,aws-us-gov

default: aws

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

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from

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

Option 1

\n
\n

\n

Include all regions

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

include_all [required]

\n
\n

boolean

\n

Include all regions

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

Option 2

\n
\n

\n

Include only these regions

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

include_only [required]

\n
\n

[string]

\n

Include only these regions

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

logs_config

\n
\n

object

\n

AWS Logs config

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

lambda_forwarder

\n
\n

object

\n

AWS Lambda forwarder

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

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs

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

sources

\n
\n

[string]

\n

List of AWS services that will send logs to the Datadog Lambda Log Forwarder

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

metrics_config

\n
\n

object

\n

AWS Metrics config

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

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics

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

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection

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

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection

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

enabled

\n
\n

boolean

\n

Enable AWS metrics collection

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

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters

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

Option 1

\n
\n

\n

Exclude all namespaces

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

exclude_all [required]

\n
\n

boolean

\n

Exclude all namespaces

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

Option 2

\n
\n

\n

Exclude only these namespaces

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

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces

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

Option 3

\n
\n

\n

Include all namespaces

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

include_all [required]

\n
\n

boolean

\n

Include all namespaces

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

Option 4

\n
\n

\n

Include only these namespaces

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

include_only [required]

\n
\n

[string]

\n

Include only these namespaces

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

tag_filters

\n
\n

[object]

\n

AWS Metrics tag filters list

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

namespace

\n
\n

string

\n

The AWS Namespace to apply the tag filters against

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

tags

\n
\n

[string]

\n

The tags to filter based on

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

resources_config

\n
\n

object

\n

AWS Resources config

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

cloud_security_posture_management_collection

\n
\n

boolean

\n

Whether Datadog collects cloud security posture management resources from your AWS account.

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

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection.

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

traces_config

\n
\n

object

\n

AWS Traces config

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

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from

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

Option 1

\n
\n

\n

Include all services

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

include_all [required]

\n
\n

boolean

\n

Include all services

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

Option 2

\n
\n

\n

Include only these services

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

include_only [required]

\n
\n

[string]

\n

Include only these services

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

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteAWSAccount": { + "responses": { + "400": { + "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": "" + } + }, + "GetAWSAccount": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "account_tags": [ + "key:value" + ], + "auth_config": { + "access_key_id": "AKIAIOSFODNN7EXAMPLE", + "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + }, + "aws_account_id": "123456789012", + "aws_partition": "aws", + "aws_regions": { + "include_all": false + }, + "created_at": "2019-09-19T10:00:00.000Z", + "logs_config": { + "lambda_forwarder": { + "lambdas": [ + "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder" + ], + "sources": [ + "s3" + ] + } + }, + "metrics_config": { + "automute_enabled": true, + "collect_cloudwatch_alarms": true, + "collect_custom_metrics": true, + "enabled": true, + "namespace_filters": { + "exclude_all": false + }, + "tag_filters": [ + { + "namespace": "AWS/EC2", + "tags": [ + "key:value" + ] + } + ] + }, + "modified_at": "2019-09-19T10:00:00.000Z", + "resources_config": { + "cloud_security_posture_management_collection": false, + "extended_collection": false + }, + "traces_config": { + "xray_services": { + "include_all": false + } + } + }, + "id": "00000000-abcd-0001-0000-000000000000", + "type": "account" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account Response body

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

attributes

\n
\n

object

\n

The AWS Account Integration Config

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

account_tags

\n
\n

[string]

\n

Tags to apply to all metrics in the account

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

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config

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

Option 1

\n
\n

object

\n

AWS Authentication config for key-based account

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

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID

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

secret_access_key

\n
\n

string

\n

AWS Secret Access Key

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

Option 2

\n
\n

object

\n

AWS Authentication config for role-based account

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

external_id

\n
\n

string

\n

AWS IAM External ID for associated role

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

role_name [required]

\n
\n

string

\n

AWS IAM Role name

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

aws_account_id [required]

\n
\n

string

\n

AWS Account ID

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

aws_partition

\n
\n

enum

\n

AWS Account partition \nAllowed enum values: aws,aws-cn,aws-us-gov

default: aws

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

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from

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

Option 1

\n
\n

\n

Include all regions

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

include_all [required]

\n
\n

boolean

\n

Include all regions

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

Option 2

\n
\n

\n

Include only these regions

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

include_only [required]

\n
\n

[string]

\n

Include only these regions

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

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created

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

logs_config

\n
\n

object

\n

AWS Logs config

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

lambda_forwarder

\n
\n

object

\n

AWS Lambda forwarder

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

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs

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

sources

\n
\n

[string]

\n

List of AWS services that will send logs to the Datadog Lambda Log Forwarder

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

metrics_config

\n
\n

object

\n

AWS Metrics config

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

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics

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

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection

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

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection

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

enabled

\n
\n

boolean

\n

Enable AWS metrics collection

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

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters

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

Option 1

\n
\n

\n

Exclude all namespaces

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

exclude_all [required]

\n
\n

boolean

\n

Exclude all namespaces

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

Option 2

\n
\n

\n

Exclude only these namespaces

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

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces

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

Option 3

\n
\n

\n

Include all namespaces

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

include_all [required]

\n
\n

boolean

\n

Include all namespaces

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

Option 4

\n
\n

\n

Include only these namespaces

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

include_only [required]

\n
\n

[string]

\n

Include only these namespaces

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

tag_filters

\n
\n

[object]

\n

AWS Metrics tag filters list

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

namespace

\n
\n

string

\n

The AWS Namespace to apply the tag filters against

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

tags

\n
\n

[string]

\n

The tags to filter based on

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

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated

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

resources_config

\n
\n

object

\n

AWS Resources config

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

cloud_security_posture_management_collection

\n
\n

boolean

\n

Whether Datadog collects cloud security posture management resources from your AWS account.

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

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection.

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

traces_config

\n
\n

object

\n

AWS Traces config

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

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from

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

Option 1

\n
\n

\n

Include all services

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

include_all [required]

\n
\n

boolean

\n

Include all services

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

Option 2

\n
\n

\n

Include only these services

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

include_only [required]

\n
\n

[string]

\n

Include only these services

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

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config

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

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\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
" + }, + "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": "" + } + }, + "UpdateAWSAccount": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "account_tags": [ + "key:value" + ], + "auth_config": { + "access_key_id": "AKIAIOSFODNN7EXAMPLE", + "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + }, + "aws_account_id": "123456789012", + "aws_partition": "aws", + "aws_regions": { + "include_all": false + }, + "created_at": "2019-09-19T10:00:00.000Z", + "logs_config": { + "lambda_forwarder": { + "lambdas": [ + "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder" + ], + "sources": [ + "s3" + ] + } + }, + "metrics_config": { + "automute_enabled": true, + "collect_cloudwatch_alarms": true, + "collect_custom_metrics": true, + "enabled": true, + "namespace_filters": { + "exclude_all": false + }, + "tag_filters": [ + { + "namespace": "AWS/EC2", + "tags": [ + "key:value" + ] + } + ] + }, + "modified_at": "2019-09-19T10:00:00.000Z", + "resources_config": { + "cloud_security_posture_management_collection": false, + "extended_collection": false + }, + "traces_config": { + "xray_services": { + "include_all": false + } + } + }, + "id": "00000000-abcd-0001-0000-000000000000", + "type": "account" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account Response body

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

attributes

\n
\n

object

\n

The AWS Account Integration Config

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

account_tags

\n
\n

[string]

\n

Tags to apply to all metrics in the account

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

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config

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

Option 1

\n
\n

object

\n

AWS Authentication config for key-based account

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

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID

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

secret_access_key

\n
\n

string

\n

AWS Secret Access Key

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

Option 2

\n
\n

object

\n

AWS Authentication config for role-based account

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

external_id

\n
\n

string

\n

AWS IAM External ID for associated role

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

role_name [required]

\n
\n

string

\n

AWS IAM Role name

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

aws_account_id [required]

\n
\n

string

\n

AWS Account ID

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

aws_partition

\n
\n

enum

\n

AWS Account partition \nAllowed enum values: aws,aws-cn,aws-us-gov

default: aws

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

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from

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

Option 1

\n
\n

\n

Include all regions

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

include_all [required]

\n
\n

boolean

\n

Include all regions

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

Option 2

\n
\n

\n

Include only these regions

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

include_only [required]

\n
\n

[string]

\n

Include only these regions

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

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created

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

logs_config

\n
\n

object

\n

AWS Logs config

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

lambda_forwarder

\n
\n

object

\n

AWS Lambda forwarder

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

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs

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

sources

\n
\n

[string]

\n

List of AWS services that will send logs to the Datadog Lambda Log Forwarder

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

metrics_config

\n
\n

object

\n

AWS Metrics config

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

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics

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

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection

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

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection

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

enabled

\n
\n

boolean

\n

Enable AWS metrics collection

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

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters

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

Option 1

\n
\n

\n

Exclude all namespaces

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

exclude_all [required]

\n
\n

boolean

\n

Exclude all namespaces

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

Option 2

\n
\n

\n

Exclude only these namespaces

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

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces

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

Option 3

\n
\n

\n

Include all namespaces

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

include_all [required]

\n
\n

boolean

\n

Include all namespaces

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

Option 4

\n
\n

\n

Include only these namespaces

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

include_only [required]

\n
\n

[string]

\n

Include only these namespaces

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

tag_filters

\n
\n

[object]

\n

AWS Metrics tag filters list

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

namespace

\n
\n

string

\n

The AWS Namespace to apply the tag filters against

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

tags

\n
\n

[string]

\n

The tags to filter based on

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

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated

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

resources_config

\n
\n

object

\n

AWS Resources config

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

cloud_security_posture_management_collection

\n
\n

boolean

\n

Whether Datadog collects cloud security posture management resources from your AWS account.

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

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection.

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

traces_config

\n
\n

object

\n

AWS Traces config

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

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from

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

Option 1

\n
\n

\n

Include all services

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

include_all [required]

\n
\n

boolean

\n

Include all services

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

Option 2

\n
\n

\n

Include only these services

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

include_only [required]

\n
\n

[string]

\n

Include only these services

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

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config

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

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\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
" + }, + "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": { + "aws_account_id": "123456789012" + }, + "type": "account" + } + }, + "json": { + "data": { + "attributes": { + "account_tags": [ + "key:value" + ], + "auth_config": { + "access_key_id": "AKIAIOSFODNN7EXAMPLE", + "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + }, + "aws_account_id": "123456789012", + "aws_partition": "aws", + "aws_regions": { + "include_all": false + }, + "logs_config": { + "lambda_forwarder": { + "lambdas": [ + "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder" + ], + "sources": [ + "s3" + ] + } + }, + "metrics_config": { + "automute_enabled": true, + "collect_cloudwatch_alarms": true, + "collect_custom_metrics": true, + "enabled": true, + "namespace_filters": { + "exclude_all": false + }, + "tag_filters": [ + { + "namespace": "AWS/EC2", + "tags": [ + "key:value" + ] + } + ] + }, + "resources_config": { + "cloud_security_posture_management_collection": false, + "extended_collection": false + }, + "traces_config": { + "xray_services": { + "include_all": false + } + } + }, + "id": "00000000-abcd-0001-0000-000000000000", + "type": "account" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account Update Request data

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

attributes [required]

\n
\n

object

\n

The AWS Account Integration Config to be updated

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

account_tags

\n
\n

[string]

\n

Tags to apply to all metrics in the account

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

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config

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

Option 1

\n
\n

object

\n

AWS Authentication config for key-based account

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

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID

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

secret_access_key

\n
\n

string

\n

AWS Secret Access Key

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

Option 2

\n
\n

object

\n

AWS Authentication config for role-based account

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

external_id

\n
\n

string

\n

AWS IAM External ID for associated role

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

role_name [required]

\n
\n

string

\n

AWS IAM Role name

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

aws_account_id [required]

\n
\n

string

\n

AWS Account ID

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

aws_partition

\n
\n

enum

\n

AWS Account partition \nAllowed enum values: aws,aws-cn,aws-us-gov

default: aws

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

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from

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

Option 1

\n
\n

\n

Include all regions

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

include_all [required]

\n
\n

boolean

\n

Include all regions

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

Option 2

\n
\n

\n

Include only these regions

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

include_only [required]

\n
\n

[string]

\n

Include only these regions

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

logs_config

\n
\n

object

\n

AWS Logs config

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

lambda_forwarder

\n
\n

object

\n

AWS Lambda forwarder

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

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs

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

sources

\n
\n

[string]

\n

List of AWS services that will send logs to the Datadog Lambda Log Forwarder

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

metrics_config

\n
\n

object

\n

AWS Metrics config

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

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics

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

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection

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

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection

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

enabled

\n
\n

boolean

\n

Enable AWS metrics collection

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

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters

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

Option 1

\n
\n

\n

Exclude all namespaces

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

exclude_all [required]

\n
\n

boolean

\n

Exclude all namespaces

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

Option 2

\n
\n

\n

Exclude only these namespaces

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

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces

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

Option 3

\n
\n

\n

Include all namespaces

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

include_all [required]

\n
\n

boolean

\n

Include all namespaces

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

Option 4

\n
\n

\n

Include only these namespaces

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

include_only [required]

\n
\n

[string]

\n

Include only these namespaces

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

tag_filters

\n
\n

[object]

\n

AWS Metrics tag filters list

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

namespace

\n
\n

string

\n

The AWS Namespace to apply the tag filters against

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

tags

\n
\n

[string]

\n

The tags to filter based on

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

resources_config

\n
\n

object

\n

AWS Resources config

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

cloud_security_posture_management_collection

\n
\n

boolean

\n

Whether Datadog collects cloud security posture management resources from your AWS account.

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

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection.

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

traces_config

\n
\n

object

\n

AWS Traces config

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

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from

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

Option 1

\n
\n

\n

Include all services

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

include_all [required]

\n
\n

boolean

\n

Include all services

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

Option 2

\n
\n

\n

Include only these services

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

include_only [required]

\n
\n

[string]

\n

Include only these services

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

id

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config

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

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" + } + }, + "ListAWSNamespaces": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "namespaces": [ + "AWS/ApiGateway" + ] + }, + "id": "namespaces", + "type": "namespaces" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Namespaces response body

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

attributes

\n
\n

object

\n

AWS Namespaces response body

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

namespaces [required]

\n
\n

[string]

\n

AWS CloudWatch namespace

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

id [required]

\n
\n

string

\n

The AWSNamespacesResponseData id.

default: namespaces

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

type [required]

\n
\n

enum

\n

The AWSNamespacesResponseData type. \nAllowed enum values: namespaces

default: namespaces

\n
\n \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": {}, + "json": {}, + "html": "" + } + }, + "CreateNewAWSExternalID": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "external_id": "acb8f6b8a844443dbb726d07dcb1a870" + }, + "id": "external_id", + "type": "external_id" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS External ID response body

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

attributes

\n
\n

object

\n

AWS External ID response body

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

external_id [required]

\n
\n

string

\n

AWS IAM External ID for associated role

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

id [required]

\n
\n

string

\n

The AWSNewExternalIDResponseData id.

default: external_id

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

type [required]

\n
\n

enum

\n

The AWSNewExternalIDResponseData type. \nAllowed enum values: external_id

default: external_id

\n
\n \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": {}, + "json": {}, + "html": "" + } + } +} \ No newline at end of file diff --git a/content/en/api/v2/aws-integration/request.CreateAWSAccount.json b/content/en/api/v2/aws-integration/request.CreateAWSAccount.json new file mode 100644 index 0000000000000..3a44a36675b88 --- /dev/null +++ b/content/en/api/v2/aws-integration/request.CreateAWSAccount.json @@ -0,0 +1,45 @@ +{ + "data": { + "attributes": { + "account_tags": [ + "key:value" + ], + "auth_config": { + "access_key_id": "AKIAIOSFODNN7EXAMPLE", + "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + }, + "aws_account_id": "123456789012", + "aws_partition": "aws", + "logs_config": { + "lambda_forwarder": { + "lambdas": [ + "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder" + ], + "sources": [ + "s3" + ] + } + }, + "metrics_config": { + "automute_enabled": true, + "collect_cloudwatch_alarms": true, + "collect_custom_metrics": true, + "enabled": true, + "tag_filters": [ + { + "namespace": "AWS/EC2", + "tags": [ + "key:value" + ] + } + ] + }, + "resources_config": { + "cloud_security_posture_management_collection": false, + "extended_collection": false + }, + "traces_config": {} + }, + "type": "account" + } +} \ No newline at end of file diff --git a/content/en/api/v2/aws-integration/request.CreateAWSAccount_1716720881.json b/content/en/api/v2/aws-integration/request.CreateAWSAccount_1716720881.json new file mode 100644 index 0000000000000..b2c76441ac947 --- /dev/null +++ b/content/en/api/v2/aws-integration/request.CreateAWSAccount_1716720881.json @@ -0,0 +1,44 @@ +{ + "data": { + "attributes": { + "account_tags": [ + "key:value" + ], + "auth_config": { + "role_name": "DatadogIntegrationRole" + }, + "aws_account_id": "123456789012", + "aws_partition": "aws", + "logs_config": { + "lambda_forwarder": { + "lambdas": [ + "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder" + ], + "sources": [ + "s3" + ] + } + }, + "metrics_config": { + "automute_enabled": true, + "collect_cloudwatch_alarms": true, + "collect_custom_metrics": true, + "enabled": true, + "tag_filters": [ + { + "namespace": "AWS/EC2", + "tags": [ + "key:value" + ] + } + ] + }, + "resources_config": { + "cloud_security_posture_management_collection": false, + "extended_collection": false + }, + "traces_config": {} + }, + "type": "account" + } +} \ No newline at end of file diff --git a/content/en/api/v2/aws-integration/request.UpdateAWSAccount.json b/content/en/api/v2/aws-integration/request.UpdateAWSAccount.json new file mode 100644 index 0000000000000..b2c76441ac947 --- /dev/null +++ b/content/en/api/v2/aws-integration/request.UpdateAWSAccount.json @@ -0,0 +1,44 @@ +{ + "data": { + "attributes": { + "account_tags": [ + "key:value" + ], + "auth_config": { + "role_name": "DatadogIntegrationRole" + }, + "aws_account_id": "123456789012", + "aws_partition": "aws", + "logs_config": { + "lambda_forwarder": { + "lambdas": [ + "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder" + ], + "sources": [ + "s3" + ] + } + }, + "metrics_config": { + "automute_enabled": true, + "collect_cloudwatch_alarms": true, + "collect_custom_metrics": true, + "enabled": true, + "tag_filters": [ + { + "namespace": "AWS/EC2", + "tags": [ + "key:value" + ] + } + ] + }, + "resources_config": { + "cloud_security_posture_management_collection": false, + "extended_collection": false + }, + "traces_config": {} + }, + "type": "account" + } +} \ No newline at end of file diff --git a/content/en/api/v2/aws-logs-integration/examples.json b/content/en/api/v2/aws-logs-integration/examples.json index 9e26dfeeb6e64..b3fede7db26a3 100644 --- a/content/en/api/v2/aws-logs-integration/examples.json +++ b/content/en/api/v2/aws-logs-integration/examples.json @@ -1 +1,41 @@ -{} \ No newline at end of file +{ + "ListAWSLogsServices": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "logs_services": [ + "s3" + ] + }, + "id": "logs_services", + "type": "logs_services" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Logs Services response body

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

attributes

\n
\n

object

\n

AWS Logs Services response body

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

logs_services [required]

\n
\n

[string]

\n

List of AWS services that can send logs to Datadog

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

id [required]

\n
\n

string

\n

The AWSLogsServicesResponseData id.

default: logs_services

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

type [required]

\n
\n

enum

\n

The AWSLogsServicesResponseData type. \nAllowed enum values: logs_services

default: logs_services

\n
\n \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": {}, + "json": {}, + "html": "" + } + } +} \ No newline at end of file diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index 05f978062983e..df28a5a11810a 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -20,6 +20,25 @@ "description": "Update a retention filter returns \"OK\" response" } ], + "CreateAWSAccount": [ + { + "group": "aws_integration", + "suffix": "_1716720881", + "description": "Create an AWS account returns \"AWS Account object\" response" + }, + { + "group": "aws_integration", + "suffix": "", + "description": "Create an AWS integration returns \"AWS Account object\" response" + } + ], + "UpdateAWSAccount": [ + { + "group": "aws_integration", + "suffix": "", + "description": "Update an AWS integration returns \"AWS Account object\" response" + } + ], "SearchAuditLogs": [ { "group": "audit", diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 65fe29763dfa3..370141319b419 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -92,6 +92,13 @@ components: required: false schema: $ref: '#/components/schemas/APIKeysSort' + AWSAccountConfigIDPathParameter: + description: Unique Datadog ID of the AWS Account Integration Config + in: path + name: aws_account_config_id + required: true + schema: + type: string ApplicationKeyFilterCreatedAtEndParameter: description: Only include application keys created on or before the specified date. @@ -1024,6 +1031,536 @@ components: type: string x-enum-varnames: - API_KEYS + AWSAccountConfigID: + description: Unique Datadog ID of the AWS Account Integration Config + example: 00000000-abcd-0001-0000-000000000000 + type: string + AWSAccountCreateRequest: + description: AWS Account Create Request body + properties: + data: + $ref: '#/components/schemas/AWSAccountCreateRequestData' + required: + - data + type: object + AWSAccountCreateRequestAttributes: + description: The AWS Account Integration Config to be created + properties: + account_tags: + $ref: '#/components/schemas/AWSAccountTags' + auth_config: + $ref: '#/components/schemas/AWSAuthConfig' + aws_account_id: + $ref: '#/components/schemas/AWSAccountID' + aws_partition: + $ref: '#/components/schemas/AWSAccountPartition' + aws_regions: + $ref: '#/components/schemas/AWSRegions' + logs_config: + $ref: '#/components/schemas/AWSLogsConfig' + metrics_config: + $ref: '#/components/schemas/AWSMetricsConfig' + resources_config: + $ref: '#/components/schemas/AWSResourcesConfig' + traces_config: + $ref: '#/components/schemas/AWSTracesConfig' + required: + - aws_account_id + - aws_partition + - auth_config + type: object + AWSAccountCreateRequestData: + description: AWS Account Create Request data + properties: + attributes: + $ref: '#/components/schemas/AWSAccountCreateRequestAttributes' + type: + $ref: '#/components/schemas/AWSAccountType' + required: + - attributes + - type + type: object + AWSAccountID: + description: AWS Account ID + example: '123456789012' + type: string + AWSAccountPartition: + default: aws + description: AWS Account partition + enum: + - aws + - aws-cn + - aws-us-gov + example: aws + type: string + x-enum-varnames: + - AWS + - AWS_CN + - AWS_US_GOV + AWSAccountResponse: + description: AWS Account response body + properties: + data: + $ref: '#/components/schemas/AWSAccountResponseData' + required: + - data + type: object + AWSAccountResponseAttributes: + description: The AWS Account Integration Config + properties: + account_tags: + $ref: '#/components/schemas/AWSAccountTags' + auth_config: + $ref: '#/components/schemas/AWSAuthConfig' + aws_account_id: + $ref: '#/components/schemas/AWSAccountID' + aws_partition: + $ref: '#/components/schemas/AWSAccountPartition' + aws_regions: + $ref: '#/components/schemas/AWSRegions' + created_at: + description: Timestamp of when the account integration was created + format: date-time + readOnly: true + type: string + logs_config: + $ref: '#/components/schemas/AWSLogsConfig' + metrics_config: + $ref: '#/components/schemas/AWSMetricsConfig' + modified_at: + description: Timestamp of when the account integration was updated + format: date-time + readOnly: true + type: string + resources_config: + $ref: '#/components/schemas/AWSResourcesConfig' + traces_config: + $ref: '#/components/schemas/AWSTracesConfig' + required: + - aws_account_id + type: object + AWSAccountResponseData: + description: AWS Account Response body + properties: + attributes: + $ref: '#/components/schemas/AWSAccountResponseAttributes' + id: + $ref: '#/components/schemas/AWSAccountConfigID' + type: + $ref: '#/components/schemas/AWSAccountType' + required: + - id + - type + type: object + AWSAccountTags: + description: Tags to apply to all metrics in the account + items: + description: Tag to apply to all metrics in the account + example: key:value + type: string + nullable: true + type: array + AWSAccountType: + default: account + description: AWS Account resource type. + enum: + - account + example: account + type: string + x-enum-varnames: + - ACCOUNT + AWSAccountUpdateRequest: + description: AWS Account Update Request body + properties: + data: + $ref: '#/components/schemas/AWSAccountUpdateRequestData' + required: + - data + type: object + AWSAccountUpdateRequestAttributes: + description: The AWS Account Integration Config to be updated + properties: + account_tags: + $ref: '#/components/schemas/AWSAccountTags' + auth_config: + $ref: '#/components/schemas/AWSAuthConfig' + aws_account_id: + $ref: '#/components/schemas/AWSAccountID' + aws_partition: + $ref: '#/components/schemas/AWSAccountPartition' + aws_regions: + $ref: '#/components/schemas/AWSRegions' + logs_config: + $ref: '#/components/schemas/AWSLogsConfig' + metrics_config: + $ref: '#/components/schemas/AWSMetricsConfig' + resources_config: + $ref: '#/components/schemas/AWSResourcesConfig' + traces_config: + $ref: '#/components/schemas/AWSTracesConfig' + required: + - aws_account_id + type: object + AWSAccountUpdateRequestData: + description: AWS Account Update Request data + properties: + attributes: + $ref: '#/components/schemas/AWSAccountUpdateRequestAttributes' + id: + $ref: '#/components/schemas/AWSAccountConfigID' + type: + $ref: '#/components/schemas/AWSAccountType' + required: + - attributes + - type + type: object + AWSAccountsResponse: + description: AWS Accounts response body + properties: + data: + description: List of AWS Account Integration Configs + items: + $ref: '#/components/schemas/AWSAccountResponseData' + type: array + required: + - data + type: object + AWSAuthConfig: + description: AWS Authentication config + oneOf: + - $ref: '#/components/schemas/AWSAuthConfigKeys' + - $ref: '#/components/schemas/AWSAuthConfigRole' + AWSAuthConfigKeys: + description: AWS Authentication config for key-based account + properties: + access_key_id: + description: AWS Access Key ID + example: AKIAIOSFODNN7EXAMPLE + type: string + secret_access_key: + description: AWS Secret Access Key + example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY + minLength: 1 + type: string + writeOnly: true + required: + - access_key_id + type: object + AWSAuthConfigRole: + description: AWS Authentication config for role-based account + properties: + external_id: + description: AWS IAM External ID for associated role + type: string + role_name: + description: AWS IAM Role name + example: DatadogIntegrationRole + maxLength: 576 + minLength: 1 + type: string + required: + - role_name + type: object + AWSLambdaForwarderConfig: + description: AWS Lambda forwarder + properties: + lambdas: + description: List of Datadog Lambda Log Forwarder ARNs + items: + example: arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder + type: string + type: array + sources: + description: List of AWS services that will send logs to the Datadog Lambda + Log Forwarder + items: + example: s3 + type: string + type: array + type: object + AWSLogsConfig: + description: AWS Logs config + properties: + lambda_forwarder: + $ref: '#/components/schemas/AWSLambdaForwarderConfig' + type: object + AWSLogsServicesResponse: + description: AWS Logs Services response body + properties: + data: + $ref: '#/components/schemas/AWSLogsServicesResponseData' + required: + - data + type: object + AWSLogsServicesResponseAttributes: + description: AWS Logs Services response body + properties: + logs_services: + description: List of AWS services that can send logs to Datadog + example: + - s3 + items: + example: s3 + type: string + type: array + required: + - logs_services + type: object + AWSLogsServicesResponseData: + description: AWS Logs Services response body + properties: + attributes: + $ref: '#/components/schemas/AWSLogsServicesResponseAttributes' + id: + default: logs_services + description: The `AWSLogsServicesResponseData` `id`. + example: logs_services + type: string + type: + $ref: '#/components/schemas/AWSLogsServicesResponseDataType' + required: + - id + - type + type: object + AWSLogsServicesResponseDataType: + default: logs_services + description: The `AWSLogsServicesResponseData` `type`. + enum: + - logs_services + example: logs_services + type: string + x-enum-varnames: + - LOGS_SERVICES + AWSMetricsConfig: + description: AWS Metrics config + properties: + automute_enabled: + description: Enable EC2 automute for AWS metrics + example: true + type: boolean + collect_cloudwatch_alarms: + description: Enable CloudWatch alarms collection + example: true + type: boolean + collect_custom_metrics: + description: Enable custom metrics collection + example: true + type: boolean + enabled: + description: Enable AWS metrics collection + example: true + type: boolean + namespace_filters: + $ref: '#/components/schemas/AWSNamespaceFilters' + tag_filters: + description: AWS Metrics tag filters list + items: + $ref: '#/components/schemas/AWSNamespaceTagFilter' + type: array + type: object + AWSNamespaceFilters: + description: AWS Metrics namespace filters + oneOf: + - $ref: '#/components/schemas/AWSNamespaceFiltersExcludeAll' + - $ref: '#/components/schemas/AWSNamespaceFiltersExcludeOnly' + - $ref: '#/components/schemas/AWSNamespaceFiltersIncludeAll' + - $ref: '#/components/schemas/AWSNamespaceFiltersIncludeOnly' + AWSNamespaceFiltersExcludeAll: + description: Exclude all namespaces + properties: + exclude_all: + description: Exclude all namespaces + example: false + type: boolean + required: + - exclude_all + AWSNamespaceFiltersExcludeOnly: + description: Exclude only these namespaces + properties: + exclude_only: + description: Exclude only these namespaces + example: + - AWS/EC2 + items: + example: AWS/EC2 + type: string + type: array + required: + - exclude_only + AWSNamespaceFiltersIncludeAll: + description: Include all namespaces + properties: + include_all: + description: Include all namespaces + example: false + type: boolean + required: + - include_all + AWSNamespaceFiltersIncludeOnly: + description: Include only these namespaces + properties: + include_only: + description: Include only these namespaces + example: + - AWS/EC2 + items: + example: AWS/EC2 + type: string + type: array + required: + - include_only + AWSNamespaceTagFilter: + description: AWS Metrics tag filters + properties: + namespace: + description: The AWS Namespace to apply the tag filters against + example: AWS/EC2 + type: string + tags: + description: The tags to filter based on + items: + example: key:value + type: string + nullable: true + type: array + type: object + AWSNamespacesResponse: + description: AWS Namespaces response body + properties: + data: + $ref: '#/components/schemas/AWSNamespacesResponseData' + required: + - data + type: object + AWSNamespacesResponseAttributes: + description: AWS Namespaces response body + properties: + namespaces: + description: AWS CloudWatch namespace + example: + - AWS/ApiGateway + items: + example: AWS/ApiGateway + type: string + type: array + required: + - namespaces + type: object + AWSNamespacesResponseData: + description: AWS Namespaces response body + properties: + attributes: + $ref: '#/components/schemas/AWSNamespacesResponseAttributes' + id: + default: namespaces + description: The `AWSNamespacesResponseData` `id`. + example: namespaces + type: string + type: + $ref: '#/components/schemas/AWSNamespacesResponseDataType' + required: + - id + - type + type: object + AWSNamespacesResponseDataType: + default: namespaces + description: The `AWSNamespacesResponseData` `type`. + enum: + - namespaces + example: namespaces + type: string + x-enum-varnames: + - NAMESPACES + AWSNewExternalIDResponse: + description: AWS External ID response body + properties: + data: + $ref: '#/components/schemas/AWSNewExternalIDResponseData' + required: + - data + type: object + AWSNewExternalIDResponseAttributes: + description: AWS External ID response body + properties: + external_id: + description: AWS IAM External ID for associated role + example: acb8f6b8a844443dbb726d07dcb1a870 + type: string + required: + - external_id + type: object + AWSNewExternalIDResponseData: + description: AWS External ID response body + properties: + attributes: + $ref: '#/components/schemas/AWSNewExternalIDResponseAttributes' + id: + default: external_id + description: The `AWSNewExternalIDResponseData` `id`. + example: external_id + type: string + type: + $ref: '#/components/schemas/AWSNewExternalIDResponseDataType' + required: + - id + - type + type: object + AWSNewExternalIDResponseDataType: + default: external_id + description: The `AWSNewExternalIDResponseData` `type`. + enum: + - external_id + example: external_id + type: string + x-enum-varnames: + - EXTERNAL_ID + AWSRegions: + description: AWS Regions to collect data from + oneOf: + - $ref: '#/components/schemas/AWSRegionsIncludeAll' + - $ref: '#/components/schemas/AWSRegionsIncludeOnly' + AWSRegionsIncludeAll: + description: Include all regions + properties: + include_all: + description: Include all regions + example: false + type: boolean + required: + - include_all + AWSRegionsIncludeOnly: + description: Include only these regions + properties: + include_only: + description: Include only these regions + example: + - us-east-1 + items: + example: us-east-1 + type: string + type: array + required: + - include_only + AWSResourcesConfig: + description: AWS Resources config + properties: + cloud_security_posture_management_collection: + description: Whether Datadog collects cloud security posture management + resources from your AWS account. + example: false + type: boolean + extended_collection: + description: Whether Datadog collects additional attributes and configuration + information about the resources in your AWS account. Required for `cspm_resource_collection`. + example: false + type: boolean + type: object + AWSTracesConfig: + description: AWS Traces config + properties: + xray_services: + $ref: '#/components/schemas/XRayServicesList' + type: object ActiveBillingDimensionsAttributes: description: List of active billing dimensions. properties: @@ -27012,6 +27549,34 @@ components: description: The id of the instance. type: string type: object + XRayServicesIncludeAll: + description: Include all services + properties: + include_all: + description: Include all services + example: false + type: boolean + required: + - include_all + XRayServicesIncludeOnly: + description: Include only these services + nullable: true + properties: + include_only: + description: Include only these services + example: + - AWS/AppSync + items: + example: AWS/AppSync + type: string + type: array + required: + - include_only + XRayServicesList: + description: AWS X-Ray services to collect traces from + oneOf: + - $ref: '#/components/schemas/XRayServicesIncludeAll' + - $ref: '#/components/schemas/XRayServicesIncludeOnly' securitySchemes: AuthZ: description: This API uses OAuth 2 with the implicit grant flow. @@ -32660,6 +33225,295 @@ paths: x-unstable: '**Note**: This endpoint is in public beta. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + /api/v2/integration/aws/accounts: + get: + description: Get a list of AWS Account Integration Configs. + operationId: ListAWSAccounts + parameters: + - description: Optional query filter accounts by AWS Account ID + example: '123456789012' + in: query + name: aws_account_id + required: false + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AWSAccountsResponse' + description: AWS Accounts List object + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: List all AWS integrations + tags: + - AWS Integration + x-menu-order: 1 + x-permission: + operator: OR + permissions: + - aws_configuration_read + x-undo: + type: safe + x-unstable: '**Note: This endpoint is in public beta. If you have any feedback, + + contact [Datadog support](https://docs.datadoghq.com/help/).**' + post: + description: Create a new AWS Account Integration Config. + operationId: CreateAWSAccount + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AWSAccountCreateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AWSAccountResponse' + description: AWS Account object + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '409': + $ref: '#/components/responses/ConflictResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Create an AWS integration + tags: + - AWS Integration + x-codegen-request-body-name: body + x-given: + aws_account_v2: + parameters: + - name: body + value: "{\n \"data\": {\n \"type\": \"account\",\n \"attributes\": + {\n \"account_tags\": [\n \"key:value\"\n ],\n \"auth_config\": + {\n \"role_name\": \"DatadogIntegrationRole\"\n },\n \"aws_account_id\": + \"123456789012\",\n \"aws_partition\": \"aws\",\n \"aws_regions\": + {\n \"include_only\": [\n \"us-east-1\"\n ]\n + \ },\n \"logs_config\": {\n \"lambda_forwarder\": {\n + \ \"lambdas\": [\n \"arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder\"\n + \ ],\n \"sources\": [\n \"s3\"\n ]\n + \ }\n },\n \"metrics_config\": {\n \"enabled\": + true,\n \"automute_enabled\": true,\n \"collect_custom_metrics\": + false,\n \"collect_cloudwatch_alarms\": false,\n \"tag_filters\": + [\n {\n \"namespace\": \"AWS/EC2\",\n \"tags\": + [\n \"key:value\"\n ]\n }\n ],\n + \ \"namespace_filters\": {\n \"include_only\": [\n \"AWS/EC2\"\n + \ ]\n }\n },\n \"resources_config\": {\n \"cloud_security_posture_management_collection\": + false,\n \"extended_collection\": false\n },\n \"traces_config\": + {\n \"xray_services\": {\n \"include_only\": [\n \"AWS/AppSync\"\n + \ ]\n }\n }\n }\n }\n}" + step: there is a valid "aws_account_v2" in the system + x-menu-order: 2 + x-permission: + operator: OR + permissions: + - aws_configurations_manage + x-undo: + operationId: DeleteAWSAccount + parameters: + - name: aws_account_config_id + source: data.id + type: unsafe + x-unstable: '**Note: This endpoint is in public beta. If you have any feedback, + + contact [Datadog support](https://docs.datadoghq.com/help/).**' + /api/v2/integration/aws/accounts/{aws_account_config_id}: + delete: + description: Delete an AWS Account Integration Config + operationId: DeleteAWSAccount + parameters: + - $ref: '#/components/parameters/AWSAccountConfigIDPathParameter' + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Delete an AWS integration + tags: + - AWS Integration + x-menu-order: 4 + x-permission: + operator: OR + permissions: + - aws_configurations_manage + x-undo: + type: idempotent + x-unstable: '**Note: This endpoint is in public beta. If you have any feedback, + + contact [Datadog support](https://docs.datadoghq.com/help/).**' + get: + description: Get an AWS Account Integration Config + operationId: GetAWSAccount + parameters: + - $ref: '#/components/parameters/AWSAccountConfigIDPathParameter' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AWSAccountResponse' + description: AWS Account object + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get an AWS integration by config ID + tags: + - AWS Integration + x-menu-order: 3 + x-permission: + operator: OR + permissions: + - aws_configuration_read + x-undo: + type: safe + x-unstable: '**Note: This endpoint is in public beta. If you have any feedback, + + contact [Datadog support](https://docs.datadoghq.com/help/).**' + patch: + description: Update an AWS Account Integration Config + operationId: UpdateAWSAccount + parameters: + - $ref: '#/components/parameters/AWSAccountConfigIDPathParameter' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AWSAccountUpdateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AWSAccountResponse' + description: AWS Account object + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Update an AWS integration + tags: + - AWS Integration + x-codegen-request-body-name: body + x-menu-order: 5 + x-permission: + operator: OR + permissions: + - aws_configuration_edit + x-undo: + type: idempotent + x-unstable: '**Note: This endpoint is in public beta. If you have any feedback, + + contact [Datadog support](https://docs.datadoghq.com/help/).**' + /api/v2/integration/aws/available_namespaces: + get: + description: Get a list of available AWS CloudWatch namespaces that can send + metrics to Datadog. + operationId: ListAWSNamespaces + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AWSNamespacesResponse' + description: AWS Namespaces List object + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: List available namespaces + tags: + - AWS Integration + x-menu-order: 1 + x-permission: + operator: OR + permissions: + - aws_configuration_read + x-undo: + type: safe + x-unstable: '**Note: This endpoint is in public beta. If you have any feedback, + + contact [Datadog support](https://docs.datadoghq.com/help/).**' + /api/v2/integration/aws/generate_new_external_id: + post: + description: Generate a new external ID for AWS role-based authentication. + operationId: CreateNewAWSExternalID + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AWSNewExternalIDResponse' + description: AWS External ID object + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Generate a new external ID + tags: + - AWS Integration + x-menu-order: 2 + x-permission: + operator: OR + permissions: + - aws_configuration_edit + x-undo: + type: safe + x-unstable: '**Note: This endpoint is in public beta. If you have any feedback, + + contact [Datadog support](https://docs.datadoghq.com/help/).**' + /api/v2/integration/aws/logs/services: + get: + description: Get a list of AWS services that can send logs to Datadog. + operationId: ListAWSLogsServices + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AWSLogsServicesResponse' + description: AWS Logs Services List object + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get list of AWS log ready services + tags: + - AWS Logs Integration + x-menu-order: 1 + x-permission: + operator: OR + permissions: + - aws_configuration_read + x-undo: + type: safe + x-unstable: '**Note: This endpoint is in public beta. If you have any feedback, + + contact [Datadog support](https://docs.datadoghq.com/help/).**' /api/v2/integration/gcp/accounts: get: description: List all GCP STS-enabled service accounts configured in your Datadog @@ -45860,6 +46714,18 @@ tags: description: Find out more at url: https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/ name: APM Retention Filters +- description: 'Configure your Datadog-AWS integration directly through the Datadog + API. + + For more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services).' + name: AWS Integration +- description: 'Configure your Datadog-AWS-Logs integration directly through Datadog + API. + + For more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection).' + externalDocs: + url: https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection + name: AWS Logs Integration - description: Search your Audit Logs events over HTTP. name: Audit - description: '[The AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example) diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index 7d074e1167bdf..c04c37753b74d 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -134,6 +134,15 @@ ] } }, + "AWSAccountConfigIDPathParameter": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "in": "path", + "name": "aws_account_config_id", + "required": true, + "schema": { + "type": "string" + } + }, "ApplicationKeyFilterCreatedAtEndParameter": { "description": "Only include application keys created on or before the specified date.", "in": "query", @@ -3375,1763 +3384,1720 @@ "API_KEYS" ] }, - "ActiveBillingDimensionsAttributes": { - "description": "List of active billing dimensions.", - "properties": { - "month": { - "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.", - "format": "date-time", - "type": "string" - }, - "values": { - "description": "List of active billing dimensions. Example: `[infra_host, apm_host, serverless_infra]`.", - "items": { - "description": "A given billing dimension in a list.", - "example": "infra_host", - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ActiveBillingDimensionsBody": { - "description": "Active billing dimensions data.", - "properties": { - "attributes": { - "description": "List of active billing dimensions.", - "properties": { - "month": { - "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.", - "format": "date-time", - "type": "string" - }, - "values": { - "description": "List of active billing dimensions. Example: `[infra_host, apm_host, serverless_infra]`.", - "items": { - "description": "A given billing dimension in a list.", - "example": "infra_host", - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "id": { - "description": "Unique ID of the response.", - "type": "string" - }, - "type": { - "default": "billing_dimensions", - "description": "Type of active billing dimensions data.", - "enum": [ - "billing_dimensions" - ], - "type": "string", - "x-enum-varnames": [ - "BILLING_DIMENSIONS" - ] - } - }, - "type": "object" + "AWSAccountConfigID": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" }, - "ActiveBillingDimensionsResponse": { - "description": "Active billing dimensions response.", + "AWSAccountCreateRequest": { + "description": "AWS Account Create Request body", "properties": { "data": { - "description": "Active billing dimensions data.", + "description": "AWS Account Create Request data", "properties": { "attributes": { - "description": "List of active billing dimensions.", + "description": "The AWS Account Integration Config to be created", "properties": { - "month": { - "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.", - "format": "date-time", - "type": "string" - }, - "values": { - "description": "List of active billing dimensions. Example: `[infra_host, apm_host, serverless_infra]`.", + "account_tags": { + "description": "Tags to apply to all metrics in the account", "items": { - "description": "A given billing dimension in a list.", - "example": "infra_host", + "description": "Tag to apply to all metrics in the account", + "example": "key:value", "type": "string" }, + "nullable": true, "type": "array" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" + } + ] + }, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "logs_config": { + "description": "AWS Logs config", + "properties": { + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "metrics_config": { + "description": "AWS Metrics config", + "properties": { + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + } + }, + "type": "object" } }, + "required": [ + "aws_account_id", + "aws_partition", + "auth_config" + ], "type": "object" }, - "id": { - "description": "Unique ID of the response.", - "type": "string" - }, "type": { - "default": "billing_dimensions", - "description": "Type of active billing dimensions data.", + "default": "account", + "description": "AWS Account resource type.", "enum": [ - "billing_dimensions" + "account" ], + "example": "account", "type": "string", "x-enum-varnames": [ - "BILLING_DIMENSIONS" + "ACCOUNT" ] } }, + "required": [ + "attributes", + "type" + ], "type": "object" } }, - "type": "object" - }, - "ActiveBillingDimensionsType": { - "default": "billing_dimensions", - "description": "Type of active billing dimensions data.", - "enum": [ - "billing_dimensions" - ], - "type": "string", - "x-enum-varnames": [ - "BILLING_DIMENSIONS" - ] - }, - "ApiID": { - "description": "API identifier.", - "example": "90646597-5fdb-4a17-a240-647003f8c028", - "format": "uuid", - "type": "string" - }, - "ApmRetentionFilterType": { - "default": "apm_retention_filter", - "description": "The type of the resource.", - "enum": [ - "apm_retention_filter" + "required": [ + "data" ], - "example": "apm_retention_filter", - "type": "string", - "x-enum-varnames": [ - "apm_retention_filter" - ] + "type": "object" }, - "ApplicationKeyCreateAttributes": { - "description": "Attributes used to create an application Key.", + "AWSAccountCreateRequestAttributes": { + "description": "The AWS Account Integration Config to be created", "properties": { - "name": { - "description": "Name of the application key.", - "example": "Application Key for managing dashboards", - "type": "string" - }, - "scopes": { - "description": "Array of scopes to grant the application key.", - "example": [ - "dashboards_read", - "dashboards_write", - "dashboards_public_share" - ], + "account_tags": { + "description": "Tags to apply to all metrics in the account", "items": { - "description": "Name of scope.", + "description": "Tag to apply to all metrics in the account", + "example": "key:value", "type": "string" }, "nullable": true, "type": "array" - } - }, - "required": [ - "name" - ], - "type": "object", - "x-merge-override": { - "properties": false - } - }, - "ApplicationKeyCreateData": { - "description": "Object used to create an application key.", - "properties": { - "attributes": { - "description": "Attributes used to create an application Key.", - "properties": { - "name": { - "description": "Name of the application key.", - "example": "Application Key for managing dashboards", - "type": "string" - }, - "scopes": { - "description": "Array of scopes to grant the application key.", - "example": [ - "dashboards_read", - "dashboards_write", - "dashboards_public_share" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" ], - "items": { - "description": "Name of scope.", - "type": "string" + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } }, - "nullable": true, - "type": "array" + "required": [ + "role_name" + ], + "type": "object" } - }, - "required": [ - "name" - ], - "type": "object", - "x-merge-override": { - "properties": false - } + ] }, - "type": { - "default": "application_keys", - "description": "Application Keys resource type.", + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", "enum": [ - "application_keys" + "aws", + "aws-cn", + "aws-us-gov" ], - "example": "application_keys", + "example": "aws", "type": "string", "x-enum-varnames": [ - "APPLICATION_KEYS" + "AWS", + "AWS_CN", + "AWS_US_GOV" ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "ApplicationKeyCreateRequest": { - "description": "Request used to create an application key.", - "properties": { - "data": { - "description": "Object used to create an application key.", - "properties": { - "attributes": { - "description": "Attributes used to create an application Key.", + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", "properties": { - "name": { - "description": "Name of the application key.", - "example": "Application Key for managing dashboards", - "type": "string" - }, - "scopes": { - "description": "Array of scopes to grant the application key.", + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", "example": [ - "dashboards_read", - "dashboards_write", - "dashboards_public_share" + "us-east-1" ], "items": { - "description": "Name of scope.", + "example": "us-east-1", "type": "string" }, - "nullable": true, "type": "array" } }, "required": [ - "name" - ], - "type": "object", - "x-merge-override": { - "properties": false - } - }, - "type": { - "default": "application_keys", - "description": "Application Keys resource type.", - "enum": [ - "application_keys" - ], - "example": "application_keys", - "type": "string", - "x-enum-varnames": [ - "APPLICATION_KEYS" + "include_only" ] } - }, - "required": [ - "attributes", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "ApplicationKeyRelationships": { - "description": "Resources related to the application key.", - "properties": { - "owned_by": { - "description": "Relationship to user.", + ] + }, + "logs_config": { + "description": "AWS Logs config", "properties": { - "data": { - "description": "Relationship to user object.", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, - "required": [ - "data" - ], "type": "object" - } - }, - "type": "object", - "x-merge-override": { - "properties": false - } - }, - "ApplicationKeyResponse": { - "description": "Response for retrieving an application key.", - "properties": { - "data": { - "description": "Datadog application key.", + }, + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "attributes": { - "description": "Attributes of a full application key.", - "properties": { - "created_at": { - "description": "Creation date of the application key.", - "example": "2020-11-23T10:00:00.000Z", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "key": { - "description": "The application key.", - "readOnly": true, - "type": "string", - "x-secret": true + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] }, - "last4": { - "description": "The last four characters of the application key.", - "example": "abcd", - "maxLength": 4, - "minLength": 4, - "readOnly": true, - "type": "string", - "x-secret": true + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] }, - "name": { - "description": "Name of the application key.", - "example": "Application Key for managing dashboards", - "type": "string" + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] }, - "scopes": { - "description": "Array of scopes to grant the application key.", - "example": [ - "dashboards_read", - "dashboards_write", - "dashboards_public_share" - ], - "items": { - "description": "Name of scope.", + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", "type": "string" }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", "nullable": true, - "type": "array" + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] } + ] + } + }, + "type": "object" + } + }, + "required": [ + "aws_account_id", + "aws_partition", + "auth_config" + ], + "type": "object" + }, + "AWSAccountCreateRequestData": { + "description": "AWS Account Create Request data", + "properties": { + "attributes": { + "description": "The AWS Account Integration Config to be created", + "properties": { + "account_tags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" }, - "type": "object", - "x-merge-override": { - "properties": false - } - }, - "id": { - "description": "ID of the application key.", - "type": "string" + "nullable": true, + "type": "array" }, - "relationships": { - "description": "Resources related to the application key.", - "properties": { - "owned_by": { - "description": "Relationship to user.", + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", "properties": { - "data": { - "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 - } + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true } }, "required": [ - "data" + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" ], "type": "object" } - }, - "type": "object", - "x-merge-override": { - "properties": false - } + ] }, - "type": { - "default": "application_keys", - "description": "Application Keys resource type.", + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", "enum": [ - "application_keys" + "aws", + "aws-cn", + "aws-us-gov" ], - "example": "application_keys", + "example": "aws", "type": "string", "x-enum-varnames": [ - "APPLICATION_KEYS" + "AWS", + "AWS_CN", + "AWS_US_GOV" ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - }, - "included": { - "description": "Array of objects related to the application key.", - "items": { - "description": "An object related to an application key.", - "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.", + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", "type": "string" }, - "handle": { - "description": "Handle of the user.", + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "logs_config": { + "description": "AWS Logs config", + "properties": { + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" }, - "icon": { - "description": "URL of the user's icon.", + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", "type": "string" }, - "mfa_enabled": { - "description": "If user has MFA enabled.", - "readOnly": true, - "type": "boolean" + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "metrics_config": { + "description": "AWS Metrics config", + "properties": { + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } }, - "modified_at": { - "description": "Time that the user was last modified.", - "format": "date-time", - "type": "string" + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } }, - "name": { - "description": "Name of the user.", - "nullable": true, - "type": "string" + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } }, - "service_account": { - "description": "Whether the user is a service account.", - "type": "boolean" + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } }, - "status": { - "description": "Status of the user.", + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", "type": "string" }, - "title": { - "description": "Title of the user.", + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, "nullable": true, - "type": "string" - }, - "verified": { - "description": "Whether the user is verified.", - "type": "boolean" + "type": "array" } }, "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" + "type": "array" + } + }, + "type": "object" + }, + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } }, - "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": "Role object returned by the API.", - "properties": { - "attributes": { - "description": "Attributes of the role.", - "properties": { - "created_at": { - "description": "Creation time of the role.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "modified_at": { - "description": "Time of last role modification.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", - "type": "string" - }, - "user_count": { - "description": "Number of users with that role.", - "format": "int64", - "readOnly": true, - "type": "integer" - } + "required": [ + "include_all" + ] }, - "type": "object" - }, - "id": { - "description": "The unique identifier of the role.", - "type": "string" - }, - "relationships": { - "description": "Relationships of the role object returned by the API.", - "properties": { - "permissions": { - "description": "Relationship to multiple permissions objects.", - "properties": { - "data": { - "description": "Relationships to permission objects.", - "items": { - "description": "Relationship to permission object.", - "properties": { - "id": { - "description": "ID of the permission.", - "type": "string" - }, - "type": { - "default": "permissions", - "description": "Permissions resource type.", - "enum": [ - "permissions" - ], - "example": "permissions", - "type": "string", - "x-enum-varnames": [ - "PERMISSIONS" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "type": "object", - "x-merge-override": { - "required": false + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" } - } - }, - "type": "object" - }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } - }, - "required": [ - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + }, + "required": [ + "include_only" + ] + } + ] } }, - { - "description": "The definition of LeakedKey object.", - "properties": { - "attributes": { - "description": "The definition of LeakedKeyAttributes object.", - "properties": { - "date": { - "description": "The LeakedKeyAttributes date.", - "example": "2017-07-21T17:32:28Z", - "format": "date-time", - "type": "string" - }, - "leak_source": { - "description": "The LeakedKeyAttributes leak_source.", - "type": "string" - } - }, - "required": [ - "date" - ], - "type": "object" - }, - "id": { - "description": "The LeakedKey id.", - "example": "id", - "type": "string" - }, - "type": { - "default": "leaked_keys", - "description": "The definition of LeakedKeyType object.", - "enum": [ - "leaked_keys" - ], - "example": "leaked_keys", - "type": "string", - "x-enum-varnames": [ - "LEAKED_KEYS" - ] - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - } - ] + "type": "object" + } }, - "type": "array" + "required": [ + "aws_account_id", + "aws_partition", + "auth_config" + ], + "type": "object" + }, + "type": { + "default": "account", + "description": "AWS Account resource type.", + "enum": [ + "account" + ], + "example": "account", + "type": "string", + "x-enum-varnames": [ + "ACCOUNT" + ] } }, + "required": [ + "attributes", + "type" + ], "type": "object" }, - "ApplicationKeyResponseIncludedItem": { - "description": "An object related to an application key.", - "oneOf": [ - { - "description": "User object returned by the API.", + "AWSAccountID": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "AWSAccountPartition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "AWSAccountResponse": { + "description": "AWS Account response body", + "properties": { + "data": { + "description": "AWS Account Response body", "properties": { "attributes": { - "description": "Attributes of user object returned by the API.", + "description": "The AWS Account Integration Config", "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.", + "account_tags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, "nullable": true, - "type": "string" + "type": "array" }, - "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.", + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, - "type": { - "default": "orgs", - "description": "Organizations resource type.", - "enum": [ - "orgs" - ], - "example": "orgs", + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, "type": "string", - "x-enum-varnames": [ - "ORGS" - ] + "writeOnly": true } }, "required": [ - "id", - "type" + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" ], "type": "object" } - }, - "required": [ - "data" + ] + }, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" ], - "type": "object" + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] }, - "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", + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", "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" + } }, - "type": "array" + "required": [ + "include_only" + ] } - }, - "required": [ - "data" - ], - "type": "object" + ] }, - "other_users": { - "description": "Relationship to users.", + "created_at": { + "description": "Timestamp of when the account integration was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "logs_config": { + "description": "AWS Logs config", "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", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } + "type": "array" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, - "type": "array" + "type": "object" } }, - "required": [ - "data" - ], "type": "object" }, - "roles": { - "description": "Relationship to roles.", + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "data": { - "description": "An array containing type and the unique identifier of a role.", + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", "items": { - "description": "Relationship to role object.", + "description": "AWS Metrics tag filters", "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", "type": "string" }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, "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": "Role object returned by the API.", - "properties": { - "attributes": { - "description": "Attributes of the role.", - "properties": { - "created_at": { - "description": "Creation time of the role.", - "format": "date-time", - "readOnly": true, - "type": "string" + "type": "object" }, "modified_at": { - "description": "Time of last role modification.", + "description": "Timestamp of when the account integration was updated", "format": "date-time", "readOnly": true, "type": "string" }, - "name": { - "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", - "type": "string" + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" }, - "user_count": { - "description": "Number of users with that role.", - "format": "int64", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "id": { - "description": "The unique identifier of the role.", - "type": "string" - }, - "relationships": { - "description": "Relationships of the role object returned by the API.", - "properties": { - "permissions": { - "description": "Relationship to multiple permissions objects.", + "traces_config": { + "description": "AWS Traces config", "properties": { - "data": { - "description": "Relationships to permission objects.", - "items": { - "description": "Relationship to permission object.", - "properties": { - "id": { - "description": "ID of the permission.", - "type": "string" + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } }, - "type": { - "default": "permissions", - "description": "Permissions resource type.", - "enum": [ - "permissions" - ], - "example": "permissions", - "type": "string", - "x-enum-varnames": [ - "PERMISSIONS" - ] - } + "required": [ + "include_all" + ] }, - "type": "object", - "x-merge-override": { - "required": false + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] } - }, - "type": "array" + ] } }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object" - }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } - }, - "required": [ - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - { - "description": "The definition of LeakedKey object.", - "properties": { - "attributes": { - "description": "The definition of LeakedKeyAttributes object.", - "properties": { - "date": { - "description": "The LeakedKeyAttributes date.", - "example": "2017-07-21T17:32:28Z", - "format": "date-time", - "type": "string" - }, - "leak_source": { - "description": "The LeakedKeyAttributes leak_source.", - "type": "string" + "type": "object" } }, "required": [ - "date" + "aws_account_id" ], "type": "object" }, "id": { - "description": "The LeakedKey id.", - "example": "id", + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, "type": { - "default": "leaked_keys", - "description": "The definition of LeakedKeyType object.", + "default": "account", + "description": "AWS Account resource type.", "enum": [ - "leaked_keys" + "account" ], - "example": "leaked_keys", + "example": "account", "type": "string", "x-enum-varnames": [ - "LEAKED_KEYS" + "ACCOUNT" ] } }, "required": [ - "attributes", "id", "type" ], "type": "object" } - ] - }, - "ApplicationKeyResponseMeta": { - "description": "Additional information related to the application key response.", - "properties": { - "max_allowed_per_user": { - "description": "Max allowed number of application keys per user.", - "format": "int64", - "type": "integer" - }, - "page": { - "description": "Additional information related to the application key response.", - "properties": { - "total_filtered_count": { - "description": "Total filtered application key count.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "ApplicationKeyResponseMetaPage": { - "description": "Additional information related to the application key response.", - "properties": { - "total_filtered_count": { - "description": "Total filtered application key count.", - "format": "int64", - "type": "integer" - } }, + "required": [ + "data" + ], "type": "object" }, - "ApplicationKeyUpdateAttributes": { - "description": "Attributes used to update an application Key.", + "AWSAccountResponseAttributes": { + "description": "The AWS Account Integration Config", "properties": { - "name": { - "description": "Name of the application key.", - "example": "Application Key for managing dashboards", - "type": "string" - }, - "scopes": { - "description": "Array of scopes to grant the application key.", - "example": [ - "dashboards_read", - "dashboards_write", - "dashboards_public_share" - ], + "account_tags": { + "description": "Tags to apply to all metrics in the account", "items": { - "description": "Name of scope.", + "description": "Tag to apply to all metrics in the account", + "example": "key:value", "type": "string" }, "nullable": true, "type": "array" - } - }, - "type": "object", - "x-merge-override": { - "properties": false - } - }, - "ApplicationKeyUpdateData": { - "description": "Object used to update an application key.", - "properties": { - "attributes": { - "description": "Attributes used to update an application Key.", - "properties": { - "name": { - "description": "Name of the application key.", - "example": "Application Key for managing dashboards", - "type": "string" - }, - "scopes": { - "description": "Array of scopes to grant the application key.", - "example": [ - "dashboards_read", - "dashboards_write", - "dashboards_public_share" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" ], - "items": { - "description": "Name of scope.", - "type": "string" + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } }, - "nullable": true, - "type": "array" + "required": [ + "role_name" + ], + "type": "object" } - }, - "type": "object", - "x-merge-override": { - "properties": false - } + ] }, - "id": { - "description": "ID of the application key.", - "example": "00112233-4455-6677-8899-aabbccddeeff", + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", "type": "string" }, - "type": { - "default": "application_keys", - "description": "Application Keys resource type.", + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", "enum": [ - "application_keys" + "aws", + "aws-cn", + "aws-us-gov" ], - "example": "application_keys", + "example": "aws", "type": "string", "x-enum-varnames": [ - "APPLICATION_KEYS" + "AWS", + "AWS_CN", + "AWS_US_GOV" ] - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "ApplicationKeyUpdateRequest": { - "description": "Request used to update an application key.", - "properties": { - "data": { - "description": "Object used to update an application key.", - "properties": { - "attributes": { - "description": "Attributes used to update an application Key.", + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", "properties": { - "name": { - "description": "Name of the application key.", - "example": "Application Key for managing dashboards", - "type": "string" - }, - "scopes": { - "description": "Array of scopes to grant the application key.", + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", "example": [ - "dashboards_read", - "dashboards_write", - "dashboards_public_share" + "us-east-1" ], "items": { - "description": "Name of scope.", + "example": "us-east-1", "type": "string" }, - "nullable": true, "type": "array" } }, - "type": "object", - "x-merge-override": { - "properties": false - } - }, - "id": { - "description": "ID of the application key.", - "example": "00112233-4455-6677-8899-aabbccddeeff", - "type": "string" - }, - "type": { - "default": "application_keys", - "description": "Application Keys resource type.", - "enum": [ - "application_keys" - ], - "example": "application_keys", - "type": "string", - "x-enum-varnames": [ - "APPLICATION_KEYS" + "required": [ + "include_only" ] } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "ApplicationKeysSort": { - "default": "name", - "description": "Sorting options", - "enum": [ - "created_at", - "-created_at", - "last4", - "-last4", - "name", - "-name" - ], - "type": "string", - "x-enum-varnames": [ - "CREATED_AT_ASCENDING", - "CREATED_AT_DESCENDING", - "LAST4_ASCENDING", - "LAST4_DESCENDING", - "NAME_ASCENDING", - "NAME_DESCENDING" - ] - }, - "ApplicationKeysType": { - "default": "application_keys", - "description": "Application Keys resource type.", - "enum": [ - "application_keys" - ], - "example": "application_keys", - "type": "string", - "x-enum-varnames": [ - "APPLICATION_KEYS" - ] - }, - "AuditLogsEvent": { - "description": "Object description of an Audit Logs event after it is processed and stored by Datadog.", - "properties": { - "attributes": { - "description": "JSON object containing all event attributes and their associated values.", - "properties": { - "attributes": { - "additionalProperties": {}, - "description": "JSON object of attributes from Audit Logs events.", - "example": { - "customAttribute": 123, - "duration": 2345 - }, - "type": "object" - }, - "message": { - "description": "Message of the event.", - "type": "string" - }, - "service": { - "description": "Name of the application or service generating Audit Logs events.\nThis name is used to correlate Audit Logs to APM, so make sure you specify the same\nvalue when you use both products.", - "example": "web-app", - "type": "string" - }, - "tags": { - "description": "Array of tags associated with your event.", - "example": [ - "team:A" - ], - "items": { - "description": "Tag associated with your event.", - "type": "string" - }, - "type": "array" - }, - "timestamp": { - "description": "Timestamp of your event.", - "example": "2019-01-02T09:42:36.320Z", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "Unique ID of the event.", - "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", - "type": "string" - }, - "type": { - "default": "audit", - "description": "Type of the event.", - "enum": [ - "audit" - ], - "example": "audit", - "type": "string", - "x-enum-varnames": [ - "Audit" ] - } - }, - "type": "object" - }, - "AuditLogsEventAttributes": { - "description": "JSON object containing all event attributes and their associated values.", - "properties": { - "attributes": { - "additionalProperties": {}, - "description": "JSON object of attributes from Audit Logs events.", - "example": { - "customAttribute": 123, - "duration": 2345 - }, - "type": "object" - }, - "message": { - "description": "Message of the event.", - "type": "string" - }, - "service": { - "description": "Name of the application or service generating Audit Logs events.\nThis name is used to correlate Audit Logs to APM, so make sure you specify the same\nvalue when you use both products.", - "example": "web-app", - "type": "string" - }, - "tags": { - "description": "Array of tags associated with your event.", - "example": [ - "team:A" - ], - "items": { - "description": "Tag associated with your event.", - "type": "string" - }, - "type": "array" }, - "timestamp": { - "description": "Timestamp of your event.", - "example": "2019-01-02T09:42:36.320Z", + "created_at": { + "description": "Timestamp of when the account integration was created", "format": "date-time", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "AuditLogsEventType": { - "default": "audit", - "description": "Type of the event.", - "enum": [ - "audit" - ], - "example": "audit", - "type": "string", - "x-enum-varnames": [ - "Audit" - ] - }, - "AuditLogsEventsResponse": { - "description": "Response object with all events matching the request and pagination information.", - "properties": { - "data": { - "description": "Array of events matching the request.", - "items": { - "description": "Object description of an Audit Logs event after it is processed and stored by Datadog.", - "properties": { - "attributes": { - "description": "JSON object containing all event attributes and their associated values.", - "properties": { - "attributes": { - "additionalProperties": {}, - "description": "JSON object of attributes from Audit Logs events.", - "example": { - "customAttribute": 123, - "duration": 2345 - }, - "type": "object" - }, - "message": { - "description": "Message of the event.", + }, + "logs_config": { + "description": "AWS Logs config", + "properties": { + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" }, - "service": { - "description": "Name of the application or service generating Audit Logs events.\nThis name is used to correlate Audit Logs to APM, so make sure you specify the same\nvalue when you use both products.", - "example": "web-app", + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", "type": "string" }, - "tags": { - "description": "Array of tags associated with your event.", - "example": [ - "team:A" - ], - "items": { - "description": "Tag associated with your event.", - "type": "string" - }, - "type": "array" - }, - "timestamp": { - "description": "Timestamp of your event.", - "example": "2019-01-02T09:42:36.320Z", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "Unique ID of the event.", - "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", - "type": "string" + "type": "array" + } }, - "type": { - "default": "audit", - "description": "Type of the event.", - "enum": [ - "audit" - ], - "example": "audit", - "type": "string", - "x-enum-varnames": [ - "Audit" - ] - } - }, - "type": "object" - }, - "type": "array" - }, - "links": { - "description": "Links attributes.", - "properties": { - "next": { - "description": "Link for the next set of results. Note that the request can also be made using the\nPOST endpoint.", - "example": "https://app.datadoghq.com/api/v2/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" + "type": "object" } }, "type": "object" }, - "meta": { - "description": "The metadata associated with a request.", + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "elapsed": { - "description": "Time elapsed in milliseconds.", - "example": 132, - "format": "int64", - "type": "integer" + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" }, - "page": { - "description": "Paging attributes.", - "properties": { - "after": { - "description": "The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - } - }, - "type": "object" + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" }, - "request_id": { - "description": "The identifier of the request.", - "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", - "type": "string" + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" }, - "status": { - "description": "The status of the response.", - "enum": [ - "done", - "timeout" - ], - "example": "done", - "type": "string", - "x-enum-varnames": [ - "DONE", - "TIMEOUT" + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } ] }, - "warnings": { - "description": "A list of warnings (non-fatal errors) encountered. Partial results may return if\nwarnings are present in the response.", + "tag_filters": { + "description": "AWS Metrics tag filters list", "items": { - "description": "Warning message indicating something that went wrong with the query.", + "description": "AWS Metrics tag filters", "properties": { - "code": { - "description": "Unique code for this type of warning.", - "example": "unknown_index", - "type": "string" - }, - "detail": { - "description": "Detailed explanation of this specific warning.", - "example": "indexes: foo, bar", + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", "type": "string" }, - "title": { - "description": "Short human-readable summary of the warning.", - "example": "One or several indexes are missing or invalid, results hold data from the other indexes", - "type": "string" + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" } }, "type": "object" @@ -5140,448 +5106,439 @@ } }, "type": "object" - } - }, - "type": "object" - }, - "AuditLogsQueryFilter": { - "description": "Search and filter query settings.", - "properties": { - "from": { - "default": "now-15m", - "description": "Minimum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).", - "example": "now-15m", - "type": "string" - }, - "query": { - "default": "*", - "description": "Search query following the Audit Logs search syntax.", - "example": "@type:session AND @session.type:user", - "type": "string" - }, - "to": { - "default": "now", - "description": "Maximum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).", - "example": "now", - "type": "string" - } - }, - "type": "object" - }, - "AuditLogsQueryOptions": { - "description": "Global query options that are used during the query.\nNote: Specify either timezone or time offset, not both. Otherwise, the query fails.", - "properties": { - "time_offset": { - "description": "Time offset (in seconds) to apply to the query.", - "format": "int64", - "type": "integer" - }, - "timezone": { - "default": "UTC", - "description": "The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).", - "example": "GMT", - "type": "string" - } - }, - "type": "object" - }, - "AuditLogsQueryPageOptions": { - "description": "Paging attributes for listing events.", - "properties": { - "cursor": { - "description": "List following results with a cursor provided in the previous query.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - }, - "limit": { - "default": 10, - "description": "Maximum number of events in the response.", - "example": 25, - "format": "int32", - "maximum": 1000, - "type": "integer" - } - }, - "type": "object" - }, - "AuditLogsResponseLinks": { - "description": "Links attributes.", - "properties": { - "next": { - "description": "Link for the next set of results. Note that the request can also be made using the\nPOST endpoint.", - "example": "https://app.datadoghq.com/api/v2/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - } - }, - "type": "object" - }, - "AuditLogsResponseMetadata": { - "description": "The metadata associated with a request.", - "properties": { - "elapsed": { - "description": "Time elapsed in milliseconds.", - "example": 132, - "format": "int64", - "type": "integer" - }, - "page": { - "description": "Paging attributes.", - "properties": { - "after": { - "description": "The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - } - }, - "type": "object" - }, - "request_id": { - "description": "The identifier of the request.", - "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", - "type": "string" - }, - "status": { - "description": "The status of the response.", - "enum": [ - "done", - "timeout" - ], - "example": "done", - "type": "string", - "x-enum-varnames": [ - "DONE", - "TIMEOUT" - ] }, - "warnings": { - "description": "A list of warnings (non-fatal errors) encountered. Partial results may return if\nwarnings are present in the response.", - "items": { - "description": "Warning message indicating something that went wrong with the query.", - "properties": { - "code": { - "description": "Unique code for this type of warning.", - "example": "unknown_index", - "type": "string" - }, - "detail": { - "description": "Detailed explanation of this specific warning.", - "example": "indexes: foo, bar", - "type": "string" - }, - "title": { - "description": "Short human-readable summary of the warning.", - "example": "One or several indexes are missing or invalid, results hold data from the other indexes", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - }, - "AuditLogsResponsePage": { - "description": "Paging attributes.", - "properties": { - "after": { - "description": "The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "modified_at": { + "description": "Timestamp of when the account integration was updated", + "format": "date-time", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "AuditLogsResponseStatus": { - "description": "The status of the response.", - "enum": [ - "done", - "timeout" - ], - "example": "done", - "type": "string", - "x-enum-varnames": [ - "DONE", - "TIMEOUT" - ] - }, - "AuditLogsSearchEventsRequest": { - "description": "The request for a Audit Logs events list.", - "properties": { - "filter": { - "description": "Search and filter query settings.", - "properties": { - "from": { - "default": "now-15m", - "description": "Minimum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).", - "example": "now-15m", - "type": "string" - }, - "query": { - "default": "*", - "description": "Search query following the Audit Logs search syntax.", - "example": "@type:session AND @session.type:user", - "type": "string" - }, - "to": { - "default": "now", - "description": "Maximum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).", - "example": "now", - "type": "string" - } - }, - "type": "object" }, - "options": { - "description": "Global query options that are used during the query.\nNote: Specify either timezone or time offset, not both. Otherwise, the query fails.", + "resources_config": { + "description": "AWS Resources config", "properties": { - "time_offset": { - "description": "Time offset (in seconds) to apply to the query.", - "format": "int64", - "type": "integer" + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" }, - "timezone": { - "default": "UTC", - "description": "The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).", - "example": "GMT", - "type": "string" + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" } }, "type": "object" }, - "page": { - "description": "Paging attributes for listing events.", + "traces_config": { + "description": "AWS Traces config", "properties": { - "cursor": { - "description": "List following results with a cursor provided in the previous query.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - }, - "limit": { - "default": 10, - "description": "Maximum number of events in the response.", - "example": 25, - "format": "int32", - "maximum": 1000, - "type": "integer" + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] } }, "type": "object" - }, - "sort": { - "description": "Sort parameters when querying events.", - "enum": [ - "timestamp", - "-timestamp" - ], - "type": "string", - "x-enum-varnames": [ - "TIMESTAMP_ASCENDING", - "TIMESTAMP_DESCENDING" - ] } }, - "type": "object" - }, - "AuditLogsSort": { - "description": "Sort parameters when querying events.", - "enum": [ - "timestamp", - "-timestamp" + "required": [ + "aws_account_id" ], - "type": "string", - "x-enum-varnames": [ - "TIMESTAMP_ASCENDING", - "TIMESTAMP_DESCENDING" - ] - }, - "AuditLogsWarning": { - "description": "Warning message indicating something that went wrong with the query.", - "properties": { - "code": { - "description": "Unique code for this type of warning.", - "example": "unknown_index", - "type": "string" - }, - "detail": { - "description": "Detailed explanation of this specific warning.", - "example": "indexes: foo, bar", - "type": "string" - }, - "title": { - "description": "Short human-readable summary of the warning.", - "example": "One or several indexes are missing or invalid, results hold data from the other indexes", - "type": "string" - } - }, "type": "object" }, - "AuthNMapping": { - "description": "The AuthN Mapping object returned by API.", + "AWSAccountResponseData": { + "description": "AWS Account Response body", "properties": { "attributes": { - "description": "Attributes of AuthN Mapping.", + "description": "The AWS Account Integration Config", "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" + "account_tags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" + } + ] }, - "created_at": { - "description": "Creation time of the AuthN Mapping.", - "format": "date-time", - "readOnly": true, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", "type": "string" }, - "modified_at": { - "description": "Time of last AuthN Mapping modification.", + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "created_at": { + "description": "Timestamp of when the account integration was created", "format": "date-time", "readOnly": true, "type": "string" }, - "saml_assertion_attribute_id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "ID of the AuthN Mapping.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" - }, - "relationships": { - "description": "All relationships associated with AuthN Mapping.", - "properties": { - "role": { - "description": "Relationship to role.", + "logs_config": { + "description": "AWS Logs config", "properties": { - "data": { - "description": "Relationship to role object.", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, - "saml_assertion_attribute": { - "description": "AuthN Mapping relationship to SAML Assertion Attribute.", + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "data": { - "description": "Data of AuthN Mapping relationship to SAML Assertion Attribute.", - "properties": { - "id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] }, - "type": { - "default": "saml_assertion_attributes", - "description": "SAML assertion attributes resource type.", - "enum": [ - "saml_assertion_attributes" - ], - "example": "saml_assertion_attributes", - "type": "string", - "x-enum-varnames": [ - "SAML_ASSERTION_ATTRIBUTES" + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" ] } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" } }, - "required": [ - "data" - ], "type": "object" }, - "team": { - "description": "Relationship to team.", + "modified_at": { + "description": "Timestamp of when the account integration was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "resources_config": { + "description": "AWS Resources config", "properties": { - "data": { - "description": "Relationship to Team object.", - "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" ] } - }, - "type": "object", - "x-merge-override": { - "required": false - } + ] } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, + "required": [ + "aws_account_id" + ], "type": "object" }, + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, "type": { - "default": "authn_mappings", - "description": "AuthN Mappings resource type.", + "default": "account", + "description": "AWS Account resource type.", "enum": [ - "authn_mappings" + "account" ], - "example": "authn_mappings", + "example": "account", "type": "string", "x-enum-varnames": [ - "AUTHN_MAPPINGS" + "ACCOUNT" ] } }, @@ -5589,412 +5546,386 @@ "id", "type" ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "AuthNMappingAttributes": { - "description": "Attributes of AuthN Mapping.", - "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" - }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" - }, - "created_at": { - "description": "Creation time of the AuthN Mapping.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "modified_at": { - "description": "Time of last AuthN Mapping modification.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "saml_assertion_attribute_id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" - } - }, "type": "object" }, - "AuthNMappingCreateAttributes": { - "description": "Key/Value pair of attributes used for create request.", - "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" - }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" - } + "AWSAccountTags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" }, - "type": "object" + "nullable": true, + "type": "array" }, - "AuthNMappingCreateData": { - "description": "Data for creating an AuthN Mapping.", + "AWSAccountType": { + "default": "account", + "description": "AWS Account resource type.", + "enum": [ + "account" + ], + "example": "account", + "type": "string", + "x-enum-varnames": [ + "ACCOUNT" + ] + }, + "AWSAccountUpdateRequest": { + "description": "AWS Account Update Request body", "properties": { - "attributes": { - "description": "Key/Value pair of attributes used for create request.", + "data": { + "description": "AWS Account Update Request data", "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" - }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" - } - }, - "type": "object" - }, - "relationships": { - "description": "Relationship of AuthN Mapping create object to a Role or Team.", - "oneOf": [ - { - "description": "Relationship of AuthN Mapping to a Role.", + "attributes": { + "description": "The AWS Account Integration Config to be updated", "properties": { - "role": { - "description": "Relationship to role.", - "properties": { - "data": { - "description": "Relationship to role object.", + "account_tags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, "type": "string", - "x-enum-varnames": [ - "ROLES" - ] + "writeOnly": true } }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "role" - ], - "type": "object" - }, - { - "description": "Relationship of AuthN Mapping to a Team.", - "properties": { - "team": { - "description": "Relationship to team.", - "properties": { - "data": { - "description": "Relationship to Team object.", + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "external_id": { + "description": "AWS IAM External ID for associated role", "type": "string" }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "role_name" + ], + "type": "object" } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "team" - ], - "type": "object" - } - ] - }, - "type": { - "default": "authn_mappings", - "description": "AuthN Mappings resource type.", - "enum": [ - "authn_mappings" - ], - "example": "authn_mappings", - "type": "string", - "x-enum-varnames": [ - "AUTHN_MAPPINGS" - ] - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "AuthNMappingCreateRelationships": { - "description": "Relationship of AuthN Mapping create object to a Role or Team.", - "oneOf": [ - { - "description": "Relationship of AuthN Mapping to a Role.", - "properties": { - "role": { - "description": "Relationship to role.", - "properties": { - "data": { - "description": "Relationship to role object.", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" + ] + }, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" ] } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "role" - ], - "type": "object" - }, - { - "description": "Relationship of AuthN Mapping to a Team.", - "properties": { - "team": { - "description": "Relationship to team.", - "properties": { - "data": { - "description": "Relationship to Team object.", + ] + }, + "logs_config": { + "description": "AWS Logs config", "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" } }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "team" - ], - "type": "object" - } - ] - }, - "AuthNMappingCreateRequest": { - "description": "Request for creating an AuthN Mapping.", - "properties": { - "data": { - "description": "Data for creating an AuthN Mapping.", - "properties": { - "attributes": { - "description": "Key/Value pair of attributes used for create request.", - "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" + "type": "object" }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" - } - }, - "type": "object" - }, - "relationships": { - "description": "Relationship of AuthN Mapping create object to a Role or Team.", - "oneOf": [ - { - "description": "Relationship of AuthN Mapping to a Role.", + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "role": { - "description": "Relationship to role.", - "properties": { - "data": { - "description": "Relationship to role object.", + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", "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" + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" } }, - "required": [ - "role" - ], "type": "object" }, - { - "description": "Relationship of AuthN Mapping to a Team.", + "resources_config": { + "description": "AWS Resources config", "properties": { - "team": { - "description": "Relationship to team.", - "properties": { - "data": { - "description": "Relationship to Team object.", + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "include_only" + ] } - }, - "type": "object", - "x-merge-override": { - "required": false - } + ] } }, - "required": [ - "team" - ], "type": "object" } - ] + }, + "required": [ + "aws_account_id" + ], + "type": "object" + }, + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" }, "type": { - "default": "authn_mappings", - "description": "AuthN Mappings resource type.", + "default": "account", + "description": "AWS Account resource type.", "enum": [ - "authn_mappings" + "account" ], - "example": "authn_mappings", + "example": "account", "type": "string", "x-enum-varnames": [ - "AUTHN_MAPPINGS" + "ACCOUNT" ] } }, "required": [ + "attributes", "type" ], "type": "object" @@ -6005,1355 +5936,1663 @@ ], "type": "object" }, - "AuthNMappingIncluded": { - "description": "Included data in the AuthN Mapping response.", - "oneOf": [ - { - "description": "SAML assertion attribute.", - "properties": { - "attributes": { - "description": "Key/Value pair of attributes used in SAML assertion attributes.", + "AWSAccountUpdateRequestAttributes": { + "description": "The AWS Account Integration Config to be updated", + "properties": { + "account_tags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true } }, + "required": [ + "access_key_id" + ], "type": "object" }, - "id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" - }, - "type": { - "default": "saml_assertion_attributes", - "description": "SAML assertion attributes resource type.", - "enum": [ - "saml_assertion_attributes" - ], - "example": "saml_assertion_attributes", - "type": "string", - "x-enum-varnames": [ - "SAML_ASSERTION_ATTRIBUTES" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - { - "description": "Role object returned by the API.", - "properties": { - "attributes": { - "description": "Attributes of the role.", + { + "description": "AWS Authentication config for role-based account", "properties": { - "created_at": { - "description": "Creation time of the role.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "modified_at": { - "description": "Time of last role modification.", - "format": "date-time", - "readOnly": true, + "external_id": { + "description": "AWS IAM External ID for associated role", "type": "string" }, - "name": { - "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, "type": "string" - }, - "user_count": { - "description": "Number of users with that role.", - "format": "int64", - "readOnly": true, - "type": "integer" } }, + "required": [ + "role_name" + ], "type": "object" + } + ] + }, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] }, - "id": { - "description": "The unique identifier of the role.", - "type": "string" - }, - "relationships": { - "description": "Relationships of the role object returned by the API.", + { + "description": "Include only these regions", "properties": { - "permissions": { - "description": "Relationship to multiple permissions objects.", - "properties": { - "data": { - "description": "Relationships to permission objects.", - "items": { - "description": "Relationship to permission object.", - "properties": { - "id": { - "description": "ID of the permission.", - "type": "string" - }, - "type": { - "default": "permissions", - "description": "Permissions resource type.", - "enum": [ - "permissions" - ], - "example": "permissions", - "type": "string", - "x-enum-varnames": [ - "PERMISSIONS" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" } }, - "type": "object" - }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" + "required": [ + "include_only" ] } - }, - "required": [ - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + ] }, - { - "description": "Team.", + "logs_config": { + "description": "AWS Logs config", "properties": { - "attributes": { - "description": "Team attributes.", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, - "type": "string" - }, - "link_count": { - "description": "The number of links belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, - "type": "string" - }, - "summary": { - "description": "A brief summary of the team, derived from the `description`", - "maxLength": 120, - "nullable": true, - "type": "string" + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" }, - "user_count": { - "description": "The number of users belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, "type": "object" - }, - "id": { - "description": "The ID of the Team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] } }, "type": "object" - } - ] - }, - "AuthNMappingRelationshipToRole": { - "description": "Relationship of AuthN Mapping to a Role.", - "properties": { - "role": { - "description": "Relationship to role.", + }, + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "data": { - "description": "Relationship to role object.", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "role" - ], - "type": "object" - }, - "AuthNMappingRelationshipToTeam": { - "description": "Relationship of AuthN Mapping to a Team.", - "properties": { - "team": { - "description": "Relationship to team.", - "properties": { - "data": { - "description": "Relationship to Team object.", - "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "team" - ], - "type": "object" - }, - "AuthNMappingRelationships": { - "description": "All relationships associated with AuthN Mapping.", - "properties": { - "role": { - "description": "Relationship to role.", - "properties": { - "data": { - "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": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" ] } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, - "saml_assertion_attribute": { - "description": "AuthN Mapping relationship to SAML Assertion Attribute.", + "resources_config": { + "description": "AWS Resources config", "properties": { - "data": { - "description": "Data of AuthN Mapping relationship to SAML Assertion Attribute.", - "properties": { - "id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" - }, - "type": { - "default": "saml_assertion_attributes", - "description": "SAML assertion attributes resource type.", - "enum": [ - "saml_assertion_attributes" - ], - "example": "saml_assertion_attributes", - "type": "string", - "x-enum-varnames": [ - "SAML_ASSERTION_ATTRIBUTES" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" } }, - "required": [ - "data" - ], "type": "object" }, - "team": { - "description": "Relationship to team.", + "traces_config": { + "description": "AWS Traces config", "properties": { - "data": { - "description": "Relationship to Team object.", - "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" ] } - }, - "type": "object", - "x-merge-override": { - "required": false - } + ] } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, - "type": "object" - }, - "AuthNMappingResourceType": { - "description": "The type of resource being mapped to.", - "enum": [ - "role", - "team" + "required": [ + "aws_account_id" ], - "type": "string", - "x-enum-varnames": [ - "ROLE", - "TEAM" - ] + "type": "object" }, - "AuthNMappingResponse": { - "description": "AuthN Mapping response from the API.", + "AWSAccountUpdateRequestData": { + "description": "AWS Account Update Request data", "properties": { - "data": { - "description": "The AuthN Mapping object returned by API.", + "attributes": { + "description": "The AWS Account Integration Config to be updated", "properties": { - "attributes": { - "description": "Attributes of AuthN Mapping.", - "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" - }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" - }, - "created_at": { - "description": "Creation time of the AuthN Mapping.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "modified_at": { - "description": "Time of last AuthN Mapping modification.", - "format": "date-time", - "readOnly": true, - "type": "string" + "account_tags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" + ], + "type": "object" }, - "saml_assertion_attribute_id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" } - }, - "type": "object" + ] }, - "id": { - "description": "ID of the AuthN Mapping.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", "type": "string" }, - "relationships": { - "description": "All relationships associated with AuthN Mapping.", + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "logs_config": { + "description": "AWS Logs config", "properties": { - "role": { - "description": "Relationship to role.", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", "properties": { - "data": { - "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" - ] - } + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" + } + }, + "type": "object" + }, + "metrics_config": { + "description": "AWS Metrics config", + "properties": { + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" }, - "saml_assertion_attribute": { - "description": "AuthN Mapping relationship to SAML Assertion Attribute.", - "properties": { - "data": { - "description": "Data of AuthN Mapping relationship to SAML Assertion Attribute.", + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", "properties": { - "id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" - }, - "type": { - "default": "saml_assertion_attributes", - "description": "SAML assertion attributes resource type.", - "enum": [ - "saml_assertion_attributes" + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" ], - "example": "saml_assertion_attributes", - "type": "string", - "x-enum-varnames": [ - "SAML_ASSERTION_ATTRIBUTES" - ] + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" } }, "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] } - }, - "required": [ - "data" - ], - "type": "object" + ] }, - "team": { - "description": "Relationship to team.", - "properties": { - "data": { - "description": "Relationship to Team object.", - "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", "type": "string" }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" + "nullable": true, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "include_only" + ] } - }, - "type": "object", - "x-merge-override": { - "required": false - } + ] } }, "type": "object" - }, - "type": { - "default": "authn_mappings", - "description": "AuthN Mappings resource type.", - "enum": [ - "authn_mappings" - ], - "example": "authn_mappings", - "type": "string", - "x-enum-varnames": [ - "AUTHN_MAPPINGS" - ] } }, "required": [ - "id", - "type" + "aws_account_id" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, - "included": { - "description": "Included data in the AuthN Mapping response.", + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "type": { + "default": "account", + "description": "AWS Account resource type.", + "enum": [ + "account" + ], + "example": "account", + "type": "string", + "x-enum-varnames": [ + "ACCOUNT" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "AWSAccountsResponse": { + "description": "AWS Accounts response body", + "properties": { + "data": { + "description": "List of AWS Account Integration Configs", "items": { - "description": "Included data in the AuthN Mapping response.", - "oneOf": [ - { - "description": "SAML assertion attribute.", + "description": "AWS Account Response body", + "properties": { + "attributes": { + "description": "The AWS Account Integration Config", "properties": { - "attributes": { - "description": "Key/Value pair of attributes used in SAML assertion attributes.", - "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" + "account_tags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" + ], + "type": "object" }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" } - }, - "type": "object" + ] }, - "id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", "type": "string" }, - "type": { - "default": "saml_assertion_attributes", - "description": "SAML assertion attributes resource type.", + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", "enum": [ - "saml_assertion_attributes" + "aws", + "aws-cn", + "aws-us-gov" ], - "example": "saml_assertion_attributes", + "example": "aws", "type": "string", "x-enum-varnames": [ - "SAML_ASSERTION_ATTRIBUTES" + "AWS", + "AWS_CN", + "AWS_US_GOV" ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - { - "description": "Role object returned by the API.", - "properties": { - "attributes": { - "description": "Attributes of the role.", - "properties": { - "created_at": { - "description": "Creation time of the role.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "modified_at": { - "description": "Time of last role modification.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", - "type": "string" + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] }, - "user_count": { - "description": "Number of users with that role.", - "format": "int64", - "readOnly": true, - "type": "integer" + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] } - }, - "type": "object" + ] }, - "id": { - "description": "The unique identifier of the role.", + "created_at": { + "description": "Timestamp of when the account integration was created", + "format": "date-time", + "readOnly": true, "type": "string" }, - "relationships": { - "description": "Relationships of the role object returned by the API.", + "logs_config": { + "description": "AWS Logs config", "properties": { - "permissions": { - "description": "Relationship to multiple permissions objects.", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", "properties": { - "data": { - "description": "Relationships to permission objects.", + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", "items": { - "description": "Relationship to permission object.", - "properties": { - "id": { - "description": "ID of the permission.", - "type": "string" - }, - "type": { - "default": "permissions", - "description": "Permissions resource type.", - "enum": [ - "permissions" - ], - "example": "permissions", - "type": "string", - "x-enum-varnames": [ - "PERMISSIONS" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" }, "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, "type": "object" }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } - }, - "required": [ - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - { - "description": "Team.", - "properties": { - "attributes": { - "description": "Team attributes.", + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, - "type": "string" + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" }, - "link_count": { - "description": "The number of links belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, - "type": "string" + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" }, - "summary": { - "description": "A brief summary of the team, derived from the `description`", - "maxLength": 120, - "nullable": true, - "type": "string" + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] }, - "user_count": { - "description": "The number of users belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" } }, "type": "object" }, - "id": { - "description": "The ID of the Team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "modified_at": { + "description": "Timestamp of when the account integration was updated", + "format": "date-time", + "readOnly": true, "type": "string" }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + } + }, + "type": "object" } }, + "required": [ + "aws_account_id" + ], "type": "object" + }, + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "type": { + "default": "account", + "description": "AWS Account resource type.", + "enum": [ + "account" + ], + "example": "account", + "type": "string", + "x-enum-varnames": [ + "ACCOUNT" + ] } - ] + }, + "required": [ + "id", + "type" + ], + "type": "object" }, "type": "array" } }, + "required": [ + "data" + ], "type": "object" }, - "AuthNMappingTeam": { - "description": "Team.", - "properties": { - "attributes": { - "description": "Team attributes.", + "AWSAuthConfig": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, - "link_count": { - "description": "The number of links belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", "type": "string" }, - "summary": { - "description": "A brief summary of the team, derived from the `description`", - "maxLength": 120, - "nullable": true, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, "type": "string" - }, - "user_count": { - "description": "The number of users belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" } }, + "required": [ + "role_name" + ], "type": "object" - }, - "id": { - "description": "The ID of the Team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + } + ] + }, + "AWSAuthConfigKeys": { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, "type": "string", - "x-enum-varnames": [ - "TEAM" - ] + "writeOnly": true } }, + "required": [ + "access_key_id" + ], "type": "object" }, - "AuthNMappingTeamAttributes": { - "description": "Team attributes.", + "AWSAuthConfigRole": { + "description": "AWS Authentication config for role-based account", "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, + "external_id": { + "description": "AWS IAM External ID for associated role", "type": "string" }, - "link_count": { - "description": "The number of links belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, - "type": "string" - }, - "summary": { - "description": "A brief summary of the team, derived from the `description`", - "maxLength": 120, - "nullable": true, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, "type": "string" - }, - "user_count": { - "description": "The number of users belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" } }, + "required": [ + "role_name" + ], "type": "object" }, - "AuthNMappingUpdateAttributes": { - "description": "Key/Value pair of attributes used for update request.", + "AWSLambdaForwarderConfig": { + "description": "AWS Lambda forwarder", "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "AuthNMappingUpdateData": { - "description": "Data for updating an AuthN Mapping.", + "AWSLogsConfig": { + "description": "AWS Logs config", "properties": { - "attributes": { - "description": "Key/Value pair of attributes used for update request.", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, "type": "object" - }, - "id": { - "description": "ID of the AuthN Mapping.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" - }, - "relationships": { - "description": "Relationship of AuthN Mapping update object to a Role or Team.", - "oneOf": [ - { - "description": "Relationship of AuthN Mapping to a Role.", + } + }, + "type": "object" + }, + "AWSLogsServicesResponse": { + "description": "AWS Logs Services response body", + "properties": { + "data": { + "description": "AWS Logs Services response body", + "properties": { + "attributes": { + "description": "AWS Logs Services response body", "properties": { - "role": { - "description": "Relationship to role.", - "properties": { - "data": { - "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 - } - } + "logs_services": { + "description": "List of AWS services that can send logs to Datadog", + "example": [ + "s3" + ], + "items": { + "example": "s3", + "type": "string" }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" } }, "required": [ - "role" + "logs_services" ], "type": "object" }, - { - "description": "Relationship of AuthN Mapping to a Team.", - "properties": { - "team": { - "description": "Relationship to team.", - "properties": { - "data": { - "description": "Relationship to Team object.", - "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "team" + "id": { + "default": "logs_services", + "description": "The `AWSLogsServicesResponseData` `id`.", + "example": "logs_services", + "type": "string" + }, + "type": { + "default": "logs_services", + "description": "The `AWSLogsServicesResponseData` `type`.", + "enum": [ + "logs_services" ], - "type": "object" + "example": "logs_services", + "type": "string", + "x-enum-varnames": [ + "LOGS_SERVICES" + ] } - ] - }, - "type": { - "default": "authn_mappings", - "description": "AuthN Mappings resource type.", - "enum": [ - "authn_mappings" + }, + "required": [ + "id", + "type" ], - "example": "authn_mappings", - "type": "string", - "x-enum-varnames": [ - "AUTHN_MAPPINGS" - ] + "type": "object" } }, "required": [ - "id", - "type" + "data" ], "type": "object" }, - "AuthNMappingUpdateRelationships": { - "description": "Relationship of AuthN Mapping update object to a Role or Team.", - "oneOf": [ - { - "description": "Relationship of AuthN Mapping to a Role.", - "properties": { - "role": { - "description": "Relationship to role.", - "properties": { - "data": { - "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 - } - } + "AWSLogsServicesResponseAttributes": { + "description": "AWS Logs Services response body", + "properties": { + "logs_services": { + "description": "List of AWS services that can send logs to Datadog", + "example": [ + "s3" + ], + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "logs_services" + ], + "type": "object" + }, + "AWSLogsServicesResponseData": { + "description": "AWS Logs Services response body", + "properties": { + "attributes": { + "description": "AWS Logs Services response body", + "properties": { + "logs_services": { + "description": "List of AWS services that can send logs to Datadog", + "example": [ + "s3" + ], + "items": { + "example": "s3", + "type": "string" }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" } }, "required": [ - "role" + "logs_services" ], "type": "object" }, - { - "description": "Relationship of AuthN Mapping to a Team.", - "properties": { - "team": { - "description": "Relationship to team.", + "id": { + "default": "logs_services", + "description": "The `AWSLogsServicesResponseData` `id`.", + "example": "logs_services", + "type": "string" + }, + "type": { + "default": "logs_services", + "description": "The `AWSLogsServicesResponseData` `type`.", + "enum": [ + "logs_services" + ], + "example": "logs_services", + "type": "string", + "x-enum-varnames": [ + "LOGS_SERVICES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "AWSLogsServicesResponseDataType": { + "default": "logs_services", + "description": "The `AWSLogsServicesResponseData` `type`.", + "enum": [ + "logs_services" + ], + "example": "logs_services", + "type": "string", + "x-enum-varnames": [ + "LOGS_SERVICES" + ] + }, + "AWSMetricsConfig": { + "description": "AWS Metrics config", + "properties": { + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", "properties": { - "data": { - "description": "Relationship to Team object.", - "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "AWSNamespaceFilters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" } }, "required": [ - "team" + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "AWSNamespaceFiltersExcludeAll": { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + "AWSNamespaceFiltersExcludeOnly": { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" ], - "type": "object" + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" } + }, + "required": [ + "exclude_only" ] }, - "AuthNMappingUpdateRequest": { - "description": "Request to update an AuthN Mapping.", + "AWSNamespaceFiltersIncludeAll": { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + "AWSNamespaceFiltersIncludeOnly": { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + }, + "AWSNamespaceTagFilter": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + }, + "AWSNamespacesResponse": { + "description": "AWS Namespaces response body", "properties": { "data": { - "description": "Data for updating an AuthN Mapping.", + "description": "AWS Namespaces response body", "properties": { "attributes": { - "description": "Key/Value pair of attributes used for update request.", + "description": "AWS Namespaces response body", "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" - }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" + "namespaces": { + "description": "AWS CloudWatch namespace", + "example": [ + "AWS/ApiGateway" + ], + "items": { + "example": "AWS/ApiGateway", + "type": "string" + }, + "type": "array" } }, + "required": [ + "namespaces" + ], "type": "object" }, "id": { - "description": "ID of the AuthN Mapping.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "default": "namespaces", + "description": "The `AWSNamespacesResponseData` `id`.", + "example": "namespaces", "type": "string" }, - "relationships": { - "description": "Relationship of AuthN Mapping update object to a Role or Team.", - "oneOf": [ - { - "description": "Relationship of AuthN Mapping to a Role.", - "properties": { - "role": { - "description": "Relationship to role.", - "properties": { - "data": { - "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": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "role" - ], - "type": "object" - }, - { - "description": "Relationship of AuthN Mapping to a Team.", - "properties": { - "team": { - "description": "Relationship to team.", - "properties": { - "data": { - "description": "Relationship to Team object.", - "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "team" - ], - "type": "object" - } - ] - }, "type": { - "default": "authn_mappings", - "description": "AuthN Mappings resource type.", + "default": "namespaces", + "description": "The `AWSNamespacesResponseData` `type`.", "enum": [ - "authn_mappings" + "namespaces" ], - "example": "authn_mappings", + "example": "namespaces", "type": "string", "x-enum-varnames": [ - "AUTHN_MAPPINGS" + "NAMESPACES" ] } }, @@ -7369,771 +7608,130 @@ ], "type": "object" }, - "AuthNMappingsResponse": { - "description": "Array of AuthN Mappings response.", + "AWSNamespacesResponseAttributes": { + "description": "AWS Namespaces response body", "properties": { - "data": { - "description": "Array of returned AuthN Mappings.", - "items": { - "description": "The AuthN Mapping object returned by API.", - "properties": { - "attributes": { - "description": "Attributes of AuthN Mapping.", - "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" - }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" - }, - "created_at": { - "description": "Creation time of the AuthN Mapping.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "modified_at": { - "description": "Time of last AuthN Mapping modification.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "saml_assertion_attribute_id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "ID of the AuthN Mapping.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" - }, - "relationships": { - "description": "All relationships associated with AuthN Mapping.", - "properties": { - "role": { - "description": "Relationship to role.", - "properties": { - "data": { - "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": "object", - "x-merge-override": { - "required": false - } - }, - "saml_assertion_attribute": { - "description": "AuthN Mapping relationship to SAML Assertion Attribute.", - "properties": { - "data": { - "description": "Data of AuthN Mapping relationship to SAML Assertion Attribute.", - "properties": { - "id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" - }, - "type": { - "default": "saml_assertion_attributes", - "description": "SAML assertion attributes resource type.", - "enum": [ - "saml_assertion_attributes" - ], - "example": "saml_assertion_attributes", - "type": "string", - "x-enum-varnames": [ - "SAML_ASSERTION_ATTRIBUTES" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "team": { - "description": "Relationship to team.", - "properties": { - "data": { - "description": "Relationship to Team object.", - "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object" - }, - "type": { - "default": "authn_mappings", - "description": "AuthN Mappings resource type.", - "enum": [ - "authn_mappings" - ], - "example": "authn_mappings", - "type": "string", - "x-enum-varnames": [ - "AUTHN_MAPPINGS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - }, - "included": { - "description": "Included data in the AuthN Mapping response.", + "namespaces": { + "description": "AWS CloudWatch namespace", + "example": [ + "AWS/ApiGateway" + ], "items": { - "description": "Included data in the AuthN Mapping response.", - "oneOf": [ - { - "description": "SAML assertion attribute.", - "properties": { - "attributes": { - "description": "Key/Value pair of attributes used in SAML assertion attributes.", - "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" - }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" - }, - "type": { - "default": "saml_assertion_attributes", - "description": "SAML assertion attributes resource type.", - "enum": [ - "saml_assertion_attributes" - ], - "example": "saml_assertion_attributes", - "type": "string", - "x-enum-varnames": [ - "SAML_ASSERTION_ATTRIBUTES" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - { - "description": "Role object returned by the API.", - "properties": { - "attributes": { - "description": "Attributes of the role.", - "properties": { - "created_at": { - "description": "Creation time of the role.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "modified_at": { - "description": "Time of last role modification.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", - "type": "string" - }, - "user_count": { - "description": "Number of users with that role.", - "format": "int64", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "id": { - "description": "The unique identifier of the role.", - "type": "string" - }, - "relationships": { - "description": "Relationships of the role object returned by the API.", - "properties": { - "permissions": { - "description": "Relationship to multiple permissions objects.", - "properties": { - "data": { - "description": "Relationships to permission objects.", - "items": { - "description": "Relationship to permission object.", - "properties": { - "id": { - "description": "ID of the permission.", - "type": "string" - }, - "type": { - "default": "permissions", - "description": "Permissions resource type.", - "enum": [ - "permissions" - ], - "example": "permissions", - "type": "string", - "x-enum-varnames": [ - "PERMISSIONS" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object" - }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } - }, - "required": [ - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - { - "description": "Team.", - "properties": { - "attributes": { - "description": "Team attributes.", - "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, - "type": "string" - }, - "link_count": { - "description": "The number of links belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, - "type": "string" - }, - "summary": { - "description": "A brief summary of the team, derived from the `description`", - "maxLength": 120, - "nullable": true, - "type": "string" - }, - "user_count": { - "description": "The number of users belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "id": { - "description": "The ID of the Team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } - }, - "type": "object" - } - ] + "example": "AWS/ApiGateway", + "type": "string" }, "type": "array" - }, - "meta": { - "description": "Object describing meta attributes of response.", - "properties": { - "page": { - "description": "Pagination object.", - "properties": { - "total_count": { - "description": "Total count.", - "format": "int64", - "type": "integer" - }, - "total_filtered_count": { - "description": "Total count of elements matched by the filter.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - } - }, - "type": "object", - "x-merge-override": { - "properties": false - } } }, - "type": "object" - }, - "AuthNMappingsSort": { - "description": "Sorting options for AuthN Mappings.", - "enum": [ - "created_at", - "-created_at", - "role_id", - "-role_id", - "saml_assertion_attribute_id", - "-saml_assertion_attribute_id", - "role.name", - "-role.name", - "saml_assertion_attribute.attribute_key", - "-saml_assertion_attribute.attribute_key", - "saml_assertion_attribute.attribute_value", - "-saml_assertion_attribute.attribute_value" - ], - "type": "string", - "x-enum-varnames": [ - "CREATED_AT_ASCENDING", - "CREATED_AT_DESCENDING", - "ROLE_ID_ASCENDING", - "ROLE_ID_DESCENDING", - "SAML_ASSERTION_ATTRIBUTE_ID_ASCENDING", - "SAML_ASSERTION_ATTRIBUTE_ID_DESCENDING", - "ROLE_NAME_ASCENDING", - "ROLE_NAME_DESCENDING", - "SAML_ASSERTION_ATTRIBUTE_KEY_ASCENDING", - "SAML_ASSERTION_ATTRIBUTE_KEY_DESCENDING", - "SAML_ASSERTION_ATTRIBUTE_VALUE_ASCENDING", - "SAML_ASSERTION_ATTRIBUTE_VALUE_DESCENDING" - ] - }, - "AuthNMappingsType": { - "default": "authn_mappings", - "description": "AuthN Mappings resource type.", - "enum": [ - "authn_mappings" + "required": [ + "namespaces" ], - "example": "authn_mappings", - "type": "string", - "x-enum-varnames": [ - "AUTHN_MAPPINGS" - ] + "type": "object" }, - "AwsCURConfig": { - "description": "AWS CUR config.", + "AWSNamespacesResponseData": { + "description": "AWS Namespaces response body", "properties": { "attributes": { - "description": "Attributes for An AWS CUR config.", + "description": "AWS Namespaces response body", "properties": { - "account_id": { - "description": "The AWS account ID.", - "example": "123456789123", - "type": "string" - }, - "bucket_name": { - "description": "The AWS bucket name used to store the Cost and Usage Report.", - "example": "dd-cost-bucket", - "type": "string" - }, - "bucket_region": { - "description": "The region the bucket is located in.", - "example": "us-east-1", - "type": "string" - }, - "created_at": { - "description": "The timestamp when the AWS CUR config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "error_messages": { - "description": "The error messages for the AWS CUR config.", + "namespaces": { + "description": "AWS CloudWatch namespace", + "example": [ + "AWS/ApiGateway" + ], "items": { + "example": "AWS/ApiGateway", "type": "string" }, "type": "array" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "report_name": { - "description": "The name of the Cost and Usage Report.", - "example": "dd-report-name", - "type": "string" - }, - "report_prefix": { - "description": "The report prefix used for the Cost and Usage Report.", - "example": "dd-report-prefix", - "type": "string" - }, - "status": { - "description": "The status of the AWS CUR.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the AWS CUR config status was updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "updated_at": { - "description": "The timestamp when the AWS CUR config status was updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } } }, "required": [ - "account_id", - "bucket_name", - "bucket_region", - "report_name", - "report_prefix", - "status" + "namespaces" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, "id": { - "description": "The ID of the AWS CUR config.", - "format": "int64", - "type": "integer" + "default": "namespaces", + "description": "The `AWSNamespacesResponseData` `id`.", + "example": "namespaces", + "type": "string" }, "type": { - "default": "aws_cur_config", - "description": "Type of AWS CUR config.", + "default": "namespaces", + "description": "The `AWSNamespacesResponseData` `type`.", "enum": [ - "aws_cur_config" + "namespaces" ], - "example": "aws_cur_config", + "example": "namespaces", "type": "string", "x-enum-varnames": [ - "AWS_CUR_CONFIG" + "NAMESPACES" ] } }, "required": [ - "attributes", + "id", "type" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, - "AwsCURConfigAttributes": { - "description": "Attributes for An AWS CUR config.", - "properties": { - "account_id": { - "description": "The AWS account ID.", - "example": "123456789123", - "type": "string" - }, - "bucket_name": { - "description": "The AWS bucket name used to store the Cost and Usage Report.", - "example": "dd-cost-bucket", - "type": "string" - }, - "bucket_region": { - "description": "The region the bucket is located in.", - "example": "us-east-1", - "type": "string" - }, - "created_at": { - "description": "The timestamp when the AWS CUR config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "error_messages": { - "description": "The error messages for the AWS CUR config.", - "items": { - "type": "string" - }, - "type": "array" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "report_name": { - "description": "The name of the Cost and Usage Report.", - "example": "dd-report-name", - "type": "string" - }, - "report_prefix": { - "description": "The report prefix used for the Cost and Usage Report.", - "example": "dd-report-prefix", - "type": "string" - }, - "status": { - "description": "The status of the AWS CUR.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the AWS CUR config status was updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "updated_at": { - "description": "The timestamp when the AWS CUR config status was updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - } - }, - "required": [ - "account_id", - "bucket_name", - "bucket_region", - "report_name", - "report_prefix", - "status" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "AwsCURConfigPatchData": { - "description": "AWS CUR config Patch data.", - "properties": { - "attributes": { - "description": "Attributes for AWS CUR config Patch Request.", - "properties": { - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "example": true, - "type": "boolean" - } - }, - "required": [ - "is_enabled" - ], - "type": "object" - }, - "type": { - "default": "aws_cur_config_patch_request", - "description": "Type of AWS CUR config Patch Request.", - "enum": [ - "aws_cur_config_patch_request" - ], - "example": "aws_cur_config_patch_request", - "type": "string", - "x-enum-varnames": [ - "AWS_CUR_CONFIG_PATCH_REQUEST" - ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "AwsCURConfigPatchRequest": { - "description": "AWS CUR config Patch Request.", + "AWSNamespacesResponseDataType": { + "default": "namespaces", + "description": "The `AWSNamespacesResponseData` `type`.", + "enum": [ + "namespaces" + ], + "example": "namespaces", + "type": "string", + "x-enum-varnames": [ + "NAMESPACES" + ] + }, + "AWSNewExternalIDResponse": { + "description": "AWS External ID response body", "properties": { "data": { - "description": "AWS CUR config Patch data.", + "description": "AWS External ID response body", "properties": { "attributes": { - "description": "Attributes for AWS CUR config Patch Request.", + "description": "AWS External ID response body", "properties": { - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "example": true, - "type": "boolean" + "external_id": { + "description": "AWS IAM External ID for associated role", + "example": "acb8f6b8a844443dbb726d07dcb1a870", + "type": "string" } }, "required": [ - "is_enabled" + "external_id" ], "type": "object" }, + "id": { + "default": "external_id", + "description": "The `AWSNewExternalIDResponseData` `id`.", + "example": "external_id", + "type": "string" + }, "type": { - "default": "aws_cur_config_patch_request", - "description": "Type of AWS CUR config Patch Request.", + "default": "external_id", + "description": "The `AWSNewExternalIDResponseData` `type`.", "enum": [ - "aws_cur_config_patch_request" + "external_id" ], - "example": "aws_cur_config_patch_request", + "example": "external_id", "type": "string", "x-enum-varnames": [ - "AWS_CUR_CONFIG_PATCH_REQUEST" + "EXTERNAL_ID" ] } }, "required": [ - "attributes", + "id", "type" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, "required": [ @@ -8141,751 +7739,415 @@ ], "type": "object" }, - "AwsCURConfigPatchRequestAttributes": { - "description": "Attributes for AWS CUR config Patch Request.", + "AWSNewExternalIDResponseAttributes": { + "description": "AWS External ID response body", "properties": { - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "example": true, - "type": "boolean" + "external_id": { + "description": "AWS IAM External ID for associated role", + "example": "acb8f6b8a844443dbb726d07dcb1a870", + "type": "string" } }, "required": [ - "is_enabled" + "external_id" ], "type": "object" }, - "AwsCURConfigPatchRequestType": { - "default": "aws_cur_config_patch_request", - "description": "Type of AWS CUR config Patch Request.", - "enum": [ - "aws_cur_config_patch_request" - ], - "example": "aws_cur_config_patch_request", - "type": "string", - "x-enum-varnames": [ - "AWS_CUR_CONFIG_PATCH_REQUEST" - ] - }, - "AwsCURConfigPostData": { - "description": "AWS CUR config Post data.", + "AWSNewExternalIDResponseData": { + "description": "AWS External ID response body", "properties": { "attributes": { - "description": "Attributes for AWS CUR config Post Request.", + "description": "AWS External ID response body", "properties": { - "account_id": { - "description": "The AWS account ID.", - "example": "123456789123", - "type": "string" - }, - "bucket_name": { - "description": "The AWS bucket name used to store the Cost and Usage Report.", - "example": "dd-cost-bucket", - "type": "string" - }, - "bucket_region": { - "description": "The region the bucket is located in.", - "example": "us-east-1", - "type": "string" - }, - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "type": "boolean" - }, - "months": { - "description": "The month of the report.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "report_name": { - "description": "The name of the Cost and Usage Report.", - "example": "dd-report-name", - "type": "string" - }, - "report_prefix": { - "description": "The report prefix used for the Cost and Usage Report.", - "example": "dd-report-prefix", + "external_id": { + "description": "AWS IAM External ID for associated role", + "example": "acb8f6b8a844443dbb726d07dcb1a870", "type": "string" } }, "required": [ - "account_id", - "bucket_name", - "report_name", - "report_prefix" + "external_id" ], "type": "object" }, + "id": { + "default": "external_id", + "description": "The `AWSNewExternalIDResponseData` `id`.", + "example": "external_id", + "type": "string" + }, "type": { - "default": "aws_cur_config_post_request", - "description": "Type of AWS CUR config Post Request.", + "default": "external_id", + "description": "The `AWSNewExternalIDResponseData` `type`.", "enum": [ - "aws_cur_config_post_request" + "external_id" ], - "example": "aws_cur_config_post_request", + "example": "external_id", "type": "string", "x-enum-varnames": [ - "AWS_CUR_CONFIG_POST_REQUEST" + "EXTERNAL_ID" ] } }, "required": [ - "attributes", + "id", "type" ], "type": "object" }, - "AwsCURConfigPostRequest": { - "description": "AWS CUR config Post Request.", - "properties": { - "data": { - "description": "AWS CUR config Post data.", + "AWSNewExternalIDResponseDataType": { + "default": "external_id", + "description": "The `AWSNewExternalIDResponseData` `type`.", + "enum": [ + "external_id" + ], + "example": "external_id", + "type": "string", + "x-enum-varnames": [ + "EXTERNAL_ID" + ] + }, + "AWSRegions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", "properties": { - "attributes": { - "description": "Attributes for AWS CUR config Post Request.", + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "AWSRegionsIncludeAll": { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + "AWSRegionsIncludeOnly": { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + }, + "AWSResourcesConfig": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "AWSTracesConfig": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", "properties": { - "account_id": { - "description": "The AWS account ID.", - "example": "123456789123", - "type": "string" - }, - "bucket_name": { - "description": "The AWS bucket name used to store the Cost and Usage Report.", - "example": "dd-cost-bucket", - "type": "string" - }, - "bucket_region": { - "description": "The region the bucket is located in.", - "example": "us-east-1", - "type": "string" - }, - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", + "include_all": { + "description": "Include all services", + "example": false, "type": "boolean" - }, - "months": { - "description": "The month of the report.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "report_name": { - "description": "The name of the Cost and Usage Report.", - "example": "dd-report-name", - "type": "string" - }, - "report_prefix": { - "description": "The report prefix used for the Cost and Usage Report.", - "example": "dd-report-prefix", - "type": "string" } }, "required": [ - "account_id", - "bucket_name", - "report_name", - "report_prefix" - ], - "type": "object" + "include_all" + ] }, - "type": { - "default": "aws_cur_config_post_request", - "description": "Type of AWS CUR config Post Request.", - "enum": [ - "aws_cur_config_post_request" - ], - "example": "aws_cur_config_post_request", - "type": "string", - "x-enum-varnames": [ - "AWS_CUR_CONFIG_POST_REQUEST" + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" ] } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" + ] } }, - "required": [ - "data" - ], "type": "object" }, - "AwsCURConfigPostRequestAttributes": { - "description": "Attributes for AWS CUR config Post Request.", + "ActiveBillingDimensionsAttributes": { + "description": "List of active billing dimensions.", "properties": { - "account_id": { - "description": "The AWS account ID.", - "example": "123456789123", - "type": "string" - }, - "bucket_name": { - "description": "The AWS bucket name used to store the Cost and Usage Report.", - "example": "dd-cost-bucket", - "type": "string" - }, - "bucket_region": { - "description": "The region the bucket is located in.", - "example": "us-east-1", + "month": { + "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.", + "format": "date-time", "type": "string" }, - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "type": "boolean" - }, - "months": { - "description": "The month of the report.", - "format": "int32", - "maximum": 36, - "type": "integer" + "values": { + "description": "List of active billing dimensions. Example: `[infra_host, apm_host, serverless_infra]`.", + "items": { + "description": "A given billing dimension in a list.", + "example": "infra_host", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ActiveBillingDimensionsBody": { + "description": "Active billing dimensions data.", + "properties": { + "attributes": { + "description": "List of active billing dimensions.", + "properties": { + "month": { + "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.", + "format": "date-time", + "type": "string" + }, + "values": { + "description": "List of active billing dimensions. Example: `[infra_host, apm_host, serverless_infra]`.", + "items": { + "description": "A given billing dimension in a list.", + "example": "infra_host", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" }, - "report_name": { - "description": "The name of the Cost and Usage Report.", - "example": "dd-report-name", + "id": { + "description": "Unique ID of the response.", "type": "string" }, - "report_prefix": { - "description": "The report prefix used for the Cost and Usage Report.", - "example": "dd-report-prefix", - "type": "string" + "type": { + "default": "billing_dimensions", + "description": "Type of active billing dimensions data.", + "enum": [ + "billing_dimensions" + ], + "type": "string", + "x-enum-varnames": [ + "BILLING_DIMENSIONS" + ] } }, - "required": [ - "account_id", - "bucket_name", - "report_name", - "report_prefix" - ], "type": "object" }, - "AwsCURConfigPostRequestType": { - "default": "aws_cur_config_post_request", - "description": "Type of AWS CUR config Post Request.", - "enum": [ - "aws_cur_config_post_request" - ], - "example": "aws_cur_config_post_request", - "type": "string", - "x-enum-varnames": [ - "AWS_CUR_CONFIG_POST_REQUEST" - ] - }, - "AwsCURConfigResponse": { - "description": "Response of AWS CUR config.", + "ActiveBillingDimensionsResponse": { + "description": "Active billing dimensions response.", "properties": { "data": { - "description": "AWS CUR config.", + "description": "Active billing dimensions data.", "properties": { "attributes": { - "description": "Attributes for An AWS CUR config.", + "description": "List of active billing dimensions.", "properties": { - "account_id": { - "description": "The AWS account ID.", - "example": "123456789123", - "type": "string" - }, - "bucket_name": { - "description": "The AWS bucket name used to store the Cost and Usage Report.", - "example": "dd-cost-bucket", - "type": "string" - }, - "bucket_region": { - "description": "The region the bucket is located in.", - "example": "us-east-1", + "month": { + "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.", + "format": "date-time", "type": "string" }, - "created_at": { - "description": "The timestamp when the AWS CUR config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "error_messages": { - "description": "The error messages for the AWS CUR config.", + "values": { + "description": "List of active billing dimensions. Example: `[infra_host, apm_host, serverless_infra]`.", "items": { + "description": "A given billing dimension in a list.", + "example": "infra_host", "type": "string" }, "type": "array" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "report_name": { - "description": "The name of the Cost and Usage Report.", - "example": "dd-report-name", - "type": "string" - }, - "report_prefix": { - "description": "The report prefix used for the Cost and Usage Report.", - "example": "dd-report-prefix", - "type": "string" - }, - "status": { - "description": "The status of the AWS CUR.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the AWS CUR config status was updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "updated_at": { - "description": "The timestamp when the AWS CUR config status was updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } } }, - "required": [ - "account_id", - "bucket_name", - "bucket_region", - "report_name", - "report_prefix", - "status" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, "id": { - "description": "The ID of the AWS CUR config.", - "format": "int64", - "type": "integer" + "description": "Unique ID of the response.", + "type": "string" }, "type": { - "default": "aws_cur_config", - "description": "Type of AWS CUR config.", + "default": "billing_dimensions", + "description": "Type of active billing dimensions data.", "enum": [ - "aws_cur_config" + "billing_dimensions" ], - "example": "aws_cur_config", "type": "string", "x-enum-varnames": [ - "AWS_CUR_CONFIG" + "BILLING_DIMENSIONS" ] } }, - "required": [ - "attributes", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, "type": "object" }, - "AwsCURConfigType": { - "default": "aws_cur_config", - "description": "Type of AWS CUR config.", + "ActiveBillingDimensionsType": { + "default": "billing_dimensions", + "description": "Type of active billing dimensions data.", "enum": [ - "aws_cur_config" + "billing_dimensions" ], - "example": "aws_cur_config", "type": "string", "x-enum-varnames": [ - "AWS_CUR_CONFIG" + "BILLING_DIMENSIONS" ] }, - "AwsCURConfigsResponse": { - "description": "List of AWS CUR configs.", - "properties": { - "data": { - "description": "An AWS CUR config.", - "items": { - "description": "AWS CUR config.", - "properties": { - "attributes": { - "description": "Attributes for An AWS CUR config.", - "properties": { - "account_id": { - "description": "The AWS account ID.", - "example": "123456789123", - "type": "string" - }, - "bucket_name": { - "description": "The AWS bucket name used to store the Cost and Usage Report.", - "example": "dd-cost-bucket", - "type": "string" - }, - "bucket_region": { - "description": "The region the bucket is located in.", - "example": "us-east-1", - "type": "string" - }, - "created_at": { - "description": "The timestamp when the AWS CUR config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "error_messages": { - "description": "The error messages for the AWS CUR config.", - "items": { - "type": "string" - }, - "type": "array" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "report_name": { - "description": "The name of the Cost and Usage Report.", - "example": "dd-report-name", - "type": "string" - }, - "report_prefix": { - "description": "The report prefix used for the Cost and Usage Report.", - "example": "dd-report-prefix", - "type": "string" - }, - "status": { - "description": "The status of the AWS CUR.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the AWS CUR config status was updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "updated_at": { - "description": "The timestamp when the AWS CUR config status was updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - } - }, - "required": [ - "account_id", - "bucket_name", - "bucket_region", - "report_name", - "report_prefix", - "status" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "id": { - "description": "The ID of the AWS CUR config.", - "format": "int64", - "type": "integer" - }, - "type": { - "default": "aws_cur_config", - "description": "Type of AWS CUR config.", - "enum": [ - "aws_cur_config" - ], - "example": "aws_cur_config", - "type": "string", - "x-enum-varnames": [ - "AWS_CUR_CONFIG" - ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "type": "object" + "ApiID": { + "description": "API identifier.", + "example": "90646597-5fdb-4a17-a240-647003f8c028", + "format": "uuid", + "type": "string" }, - "AzureUCConfig": { - "description": "Azure config.", + "ApmRetentionFilterType": { + "default": "apm_retention_filter", + "description": "The type of the resource.", + "enum": [ + "apm_retention_filter" + ], + "example": "apm_retention_filter", + "type": "string", + "x-enum-varnames": [ + "apm_retention_filter" + ] + }, + "ApplicationKeyCreateAttributes": { + "description": "Attributes used to create an application Key.", "properties": { - "account_id": { - "description": "The tenant ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "client_id": { - "description": "The client ID of the Azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "created_at": { - "description": "The timestamp when the Azure config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "dataset_type": { - "description": "The dataset type of the Azure config.", - "example": "actual", + "name": { + "description": "Name of the application key.", + "example": "Application Key for managing dashboards", "type": "string" }, - "error_messages": { - "description": "The error messages for the Azure config.", + "scopes": { + "description": "Array of scopes to grant the application key.", + "example": [ + "dashboards_read", + "dashboards_write", + "dashboards_public_share" + ], "items": { + "description": "Name of scope.", "type": "string" }, + "nullable": true, "type": "array" - }, - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "id": { - "description": "The ID of the Azure config.", - "format": "int64", - "type": "integer" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "scope": { - "description": "The scope of your observed subscription.", - "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "status": { - "description": "The status of the Azure config.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the Azure config status was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - }, - "updated_at": { - "description": "The timestamp when the Azure config was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } } }, "required": [ - "account_id", - "client_id", - "dataset_type", - "export_name", - "export_path", - "scope", - "status", - "storage_account", - "storage_container" + "name" ], "type": "object", "x-merge-override": { - "required": false + "properties": false } }, - "AzureUCConfigPair": { - "description": "Azure config pair.", + "ApplicationKeyCreateData": { + "description": "Object used to create an application key.", "properties": { "attributes": { - "description": "Attributes for Azure config pair.", + "description": "Attributes used to create an application Key.", "properties": { - "configs": { - "description": "An Azure config.", + "name": { + "description": "Name of the application key.", + "example": "Application Key for managing dashboards", + "type": "string" + }, + "scopes": { + "description": "Array of scopes to grant the application key.", + "example": [ + "dashboards_read", + "dashboards_write", + "dashboards_public_share" + ], "items": { - "description": "Azure config.", - "properties": { - "account_id": { - "description": "The tenant ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "client_id": { - "description": "The client ID of the Azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "created_at": { - "description": "The timestamp when the Azure config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "dataset_type": { - "description": "The dataset type of the Azure config.", - "example": "actual", - "type": "string" - }, - "error_messages": { - "description": "The error messages for the Azure config.", - "items": { - "type": "string" - }, - "type": "array" - }, - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "id": { - "description": "The ID of the Azure config.", - "format": "int64", - "type": "integer" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "scope": { - "description": "The scope of your observed subscription.", - "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "status": { - "description": "The status of the Azure config.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the Azure config status was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - }, - "updated_at": { - "description": "The timestamp when the Azure config was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - } - }, - "required": [ - "account_id", - "client_id", - "dataset_type", - "export_name", - "export_path", - "scope", - "status", - "storage_account", - "storage_container" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "description": "Name of scope.", + "type": "string" }, + "nullable": true, "type": "array" - }, - "id": { - "description": "The ID of the Azure config pair.", - "format": "int64", - "type": "integer" } }, "required": [ - "configs" + "name" ], "type": "object", "x-merge-override": { "properties": false } }, - "id": { - "description": "The ID of Cloud Cost Management account.", - "format": "int64", - "type": "integer" - }, "type": { - "default": "azure_uc_configs", - "description": "Type of Azure config pair.", + "default": "application_keys", + "description": "Application Keys resource type.", "enum": [ - "azure_uc_configs" + "application_keys" ], - "example": "azure_uc_configs", + "example": "application_keys", "type": "string", "x-enum-varnames": [ - "AZURE_UC_CONFIGS" + "APPLICATION_KEYS" ] } }, @@ -8898,297 +8160,53 @@ "required": false } }, - "AzureUCConfigPairAttributes": { - "description": "Attributes for Azure config pair.", + "ApplicationKeyCreateRequest": { + "description": "Request used to create an application key.", "properties": { - "configs": { - "description": "An Azure config.", - "items": { - "description": "Azure config.", - "properties": { - "account_id": { - "description": "The tenant ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "client_id": { - "description": "The client ID of the Azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "created_at": { - "description": "The timestamp when the Azure config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "dataset_type": { - "description": "The dataset type of the Azure config.", - "example": "actual", - "type": "string" - }, - "error_messages": { - "description": "The error messages for the Azure config.", - "items": { + "data": { + "description": "Object used to create an application key.", + "properties": { + "attributes": { + "description": "Attributes used to create an application Key.", + "properties": { + "name": { + "description": "Name of the application key.", + "example": "Application Key for managing dashboards", "type": "string" }, - "type": "array" - }, - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "id": { - "description": "The ID of the Azure config.", - "format": "int64", - "type": "integer" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "scope": { - "description": "The scope of your observed subscription.", - "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "status": { - "description": "The status of the Azure config.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the Azure config status was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - }, - "updated_at": { - "description": "The timestamp when the Azure config was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - } - }, - "required": [ - "account_id", - "client_id", - "dataset_type", - "export_name", - "export_path", - "scope", - "status", - "storage_account", - "storage_container" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - }, - "id": { - "description": "The ID of the Azure config pair.", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "configs" - ], - "type": "object", - "x-merge-override": { - "properties": false - } - }, - "AzureUCConfigPairType": { - "default": "azure_uc_configs", - "description": "Type of Azure config pair.", - "enum": [ - "azure_uc_configs" - ], - "example": "azure_uc_configs", - "type": "string", - "x-enum-varnames": [ - "AZURE_UC_CONFIGS" - ] - }, - "AzureUCConfigPairsResponse": { - "description": "Response of Azure config pair.", - "properties": { - "data": { - "description": "Azure config pair.", - "properties": { - "attributes": { - "description": "Attributes for Azure config pair.", - "properties": { - "configs": { - "description": "An Azure config.", - "items": { - "description": "Azure config.", - "properties": { - "account_id": { - "description": "The tenant ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "client_id": { - "description": "The client ID of the Azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "created_at": { - "description": "The timestamp when the Azure config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "dataset_type": { - "description": "The dataset type of the Azure config.", - "example": "actual", - "type": "string" - }, - "error_messages": { - "description": "The error messages for the Azure config.", - "items": { - "type": "string" - }, - "type": "array" - }, - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "id": { - "description": "The ID of the Azure config.", - "format": "int64", - "type": "integer" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "scope": { - "description": "The scope of your observed subscription.", - "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "status": { - "description": "The status of the Azure config.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the Azure config status was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - }, - "updated_at": { - "description": "The timestamp when the Azure config was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - } - }, - "required": [ - "account_id", - "client_id", - "dataset_type", - "export_name", - "export_path", - "scope", - "status", - "storage_account", - "storage_container" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - }, - "id": { - "description": "The ID of the Azure config pair.", - "format": "int64", - "type": "integer" - } + "scopes": { + "description": "Array of scopes to grant the application key.", + "example": [ + "dashboards_read", + "dashboards_write", + "dashboards_public_share" + ], + "items": { + "description": "Name of scope.", + "type": "string" + }, + "nullable": true, + "type": "array" + } }, "required": [ - "configs" + "name" ], "type": "object", "x-merge-override": { "properties": false } }, - "id": { - "description": "The ID of Cloud Cost Management account.", - "format": "int64", - "type": "integer" - }, "type": { - "default": "azure_uc_configs", - "description": "Type of Azure config pair.", + "default": "application_keys", + "description": "Application Keys resource type.", "enum": [ - "azure_uc_configs" + "application_keys" ], - "example": "azure_uc_configs", + "example": "application_keys", "type": "string", "x-enum-varnames": [ - "AZURE_UC_CONFIGS" + "APPLICATION_KEYS" ] } }, @@ -9202,1405 +8220,1183 @@ } } }, - "type": "object" - }, - "AzureUCConfigPatchData": { - "description": "Azure config Patch data.", - "properties": { - "attributes": { - "description": "Attributes for Azure config Patch Request.", - "properties": { - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "example": true, - "type": "boolean" - } - }, - "required": [ - "is_enabled" - ], - "type": "object" - }, - "type": { - "default": "azure_uc_config_patch_request", - "description": "Type of Azure config Patch Request.", - "enum": [ - "azure_uc_config_patch_request" - ], - "example": "azure_uc_config_patch_request", - "type": "string", - "x-enum-varnames": [ - "AZURE_UC_CONFIG_PATCH_REQUEST" - ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - }, - "AzureUCConfigPatchRequest": { - "description": "Azure config Patch Request.", - "properties": { - "data": { - "description": "Azure config Patch data.", - "properties": { - "attributes": { - "description": "Attributes for Azure config Patch Request.", - "properties": { - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "example": true, - "type": "boolean" - } - }, - "required": [ - "is_enabled" - ], - "type": "object" - }, - "type": { - "default": "azure_uc_config_patch_request", - "description": "Type of Azure config Patch Request.", - "enum": [ - "azure_uc_config_patch_request" - ], - "example": "azure_uc_config_patch_request", - "type": "string", - "x-enum-varnames": [ - "AZURE_UC_CONFIG_PATCH_REQUEST" - ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - } - }, "required": [ "data" ], "type": "object" }, - "AzureUCConfigPatchRequestAttributes": { - "description": "Attributes for Azure config Patch Request.", - "properties": { - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "example": true, - "type": "boolean" - } - }, - "required": [ - "is_enabled" - ], - "type": "object" - }, - "AzureUCConfigPatchRequestType": { - "default": "azure_uc_config_patch_request", - "description": "Type of Azure config Patch Request.", - "enum": [ - "azure_uc_config_patch_request" - ], - "example": "azure_uc_config_patch_request", - "type": "string", - "x-enum-varnames": [ - "AZURE_UC_CONFIG_PATCH_REQUEST" - ] - }, - "AzureUCConfigPostData": { - "description": "Azure config Post data.", + "ApplicationKeyRelationships": { + "description": "Resources related to the application key.", "properties": { - "attributes": { - "description": "Attributes for Azure config Post Request.", + "owned_by": { + "description": "Relationship to user.", "properties": { - "account_id": { - "description": "The tenant ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "actual_bill_config": { - "description": "Bill config.", - "properties": { - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - } - }, - "required": [ - "export_name", - "export_path", - "storage_account", - "storage_container" - ], - "type": "object" - }, - "amortized_bill_config": { - "description": "Bill config.", + "data": { + "description": "Relationship to user object.", "properties": { - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", "type": "string" }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] } }, "required": [ - "export_name", - "export_path", - "storage_account", - "storage_container" + "id", + "type" ], - "type": "object" - }, - "client_id": { - "description": "The client ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "type": "boolean" - }, - "scope": { - "description": "The scope of your observed subscription.", - "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" + "type": "object", + "x-merge-override": { + "required": false + } } }, "required": [ - "account_id", - "actual_bill_config", - "amortized_bill_config", - "client_id", - "scope" + "data" ], "type": "object" - }, - "type": { - "default": "azure_uc_config_post_request", - "description": "Type of Azure config Post Request.", - "enum": [ - "azure_uc_config_post_request" - ], - "example": "azure_uc_config_post_request", - "type": "string", - "x-enum-varnames": [ - "AZURE_UC_CONFIG_POST_REQUEST" - ] } }, - "required": [ - "attributes", - "type" - ], - "type": "object" + "type": "object", + "x-merge-override": { + "properties": false + } }, - "AzureUCConfigPostRequest": { - "description": "Azure config Post Request.", + "ApplicationKeyResponse": { + "description": "Response for retrieving an application key.", "properties": { "data": { - "description": "Azure config Post data.", + "description": "Datadog application key.", "properties": { "attributes": { - "description": "Attributes for Azure config Post Request.", + "description": "Attributes of a full application key.", "properties": { - "account_id": { - "description": "The tenant ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "created_at": { + "description": "Creation date of the application key.", + "example": "2020-11-23T10:00:00.000Z", + "format": "date-time", + "readOnly": true, "type": "string" }, - "actual_bill_config": { - "description": "Bill config.", - "properties": { - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - } - }, - "required": [ - "export_name", - "export_path", - "storage_account", - "storage_container" - ], - "type": "object" + "key": { + "description": "The application key.", + "readOnly": true, + "type": "string", + "x-secret": true }, - "amortized_bill_config": { - "description": "Bill config.", - "properties": { - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - } - }, - "required": [ - "export_name", - "export_path", - "storage_account", - "storage_container" - ], - "type": "object" + "last4": { + "description": "The last four characters of the application key.", + "example": "abcd", + "maxLength": 4, + "minLength": 4, + "readOnly": true, + "type": "string", + "x-secret": true }, - "client_id": { - "description": "The client ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "name": { + "description": "Name of the application key.", + "example": "Application Key for managing dashboards", "type": "string" }, - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "type": "boolean" - }, - "scope": { - "description": "The scope of your observed subscription.", - "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" + "scopes": { + "description": "Array of scopes to grant the application key.", + "example": [ + "dashboards_read", + "dashboards_write", + "dashboards_public_share" + ], + "items": { + "description": "Name of scope.", + "type": "string" + }, + "nullable": true, + "type": "array" } }, - "required": [ - "account_id", - "actual_bill_config", - "amortized_bill_config", - "client_id", - "scope" - ], - "type": "object" - }, - "type": { - "default": "azure_uc_config_post_request", - "description": "Type of Azure config Post Request.", - "enum": [ - "azure_uc_config_post_request" - ], - "example": "azure_uc_config_post_request", - "type": "string", - "x-enum-varnames": [ - "AZURE_UC_CONFIG_POST_REQUEST" - ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "AzureUCConfigPostRequestAttributes": { - "description": "Attributes for Azure config Post Request.", - "properties": { - "account_id": { - "description": "The tenant ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "actual_bill_config": { - "description": "Bill config.", - "properties": { - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - } - }, - "required": [ - "export_name", - "export_path", - "storage_account", - "storage_container" - ], - "type": "object" - }, - "amortized_bill_config": { - "description": "Bill config.", - "properties": { - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" + "type": "object", + "x-merge-override": { + "properties": false + } }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", + "id": { + "description": "ID of the application key.", "type": "string" }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - } - }, - "required": [ - "export_name", - "export_path", - "storage_account", - "storage_container" - ], - "type": "object" - }, - "client_id": { - "description": "The client ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "type": "boolean" - }, - "scope": { - "description": "The scope of your observed subscription.", - "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - } - }, - "required": [ - "account_id", - "actual_bill_config", - "amortized_bill_config", - "client_id", - "scope" - ], - "type": "object" - }, - "AzureUCConfigPostRequestType": { - "default": "azure_uc_config_post_request", - "description": "Type of Azure config Post Request.", - "enum": [ - "azure_uc_config_post_request" - ], - "example": "azure_uc_config_post_request", - "type": "string", - "x-enum-varnames": [ - "AZURE_UC_CONFIG_POST_REQUEST" - ] - }, - "AzureUCConfigsResponse": { - "description": "List of Azure accounts with configs.", - "properties": { - "data": { - "description": "An Azure config pair.", - "items": { - "description": "Azure config pair.", - "properties": { - "attributes": { - "description": "Attributes for Azure config pair.", - "properties": { - "configs": { - "description": "An Azure config.", - "items": { - "description": "Azure config.", + "relationships": { + "description": "Resources related to the application key.", + "properties": { + "owned_by": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", "properties": { - "account_id": { - "description": "The tenant ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "client_id": { - "description": "The client ID of the Azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "created_at": { - "description": "The timestamp when the Azure config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "dataset_type": { - "description": "The dataset type of the Azure config.", - "example": "actual", - "type": "string" - }, - "error_messages": { - "description": "The error messages for the Azure config.", - "items": { - "type": "string" - }, - "type": "array" - }, - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, "id": { - "description": "The ID of the Azure config.", - "format": "int64", - "type": "integer" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "scope": { - "description": "The scope of your observed subscription.", - "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "status": { - "description": "The status of the Azure config.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the Azure config status was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", "type": "string" }, - "updated_at": { - "description": "The timestamp when the Azure config was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", "type": "string", - "x-merge-override": { - "format": false - } + "x-enum-varnames": [ + "USERS" + ] } }, "required": [ - "account_id", - "client_id", - "dataset_type", - "export_name", - "export_path", - "scope", - "status", - "storage_account", - "storage_container" + "id", + "type" ], "type": "object", "x-merge-override": { "required": false } - }, - "type": "array" + } }, - "id": { - "description": "The ID of the Azure config pair.", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "configs" - ], - "type": "object", - "x-merge-override": { - "properties": false + "required": [ + "data" + ], + "type": "object" } }, - "id": { - "description": "The ID of Cloud Cost Management account.", - "format": "int64", - "type": "integer" - }, - "type": { - "default": "azure_uc_configs", - "description": "Type of Azure config pair.", - "enum": [ - "azure_uc_configs" - ], - "example": "azure_uc_configs", - "type": "string", - "x-enum-varnames": [ - "AZURE_UC_CONFIGS" - ] + "type": "object", + "x-merge-override": { + "properties": false } }, - "required": [ - "attributes", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "type": { + "default": "application_keys", + "description": "Application Keys resource type.", + "enum": [ + "application_keys" + ], + "example": "application_keys", + "type": "string", + "x-enum-varnames": [ + "APPLICATION_KEYS" + ] } }, - "type": "array" - } - }, - "type": "object" - }, - "BillConfig": { - "description": "Bill config.", - "properties": { - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" + "type": "object", + "x-merge-override": { + "required": false + } }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - } - }, - "required": [ - "export_name", - "export_path", - "storage_account", - "storage_container" - ], - "type": "object" - }, - "BillingDimensionsMappingBody": { - "description": "Billing dimensions mapping data.", - "items": { - "description": "The mapping data for each billing dimension.", - "properties": { - "attributes": { - "description": "Mapping of billing dimensions to endpoint keys.", - "properties": { - "endpoints": { - "description": "List of supported endpoints with their keys mapped to the billing_dimension.", - "items": { - "description": "An endpoint's keys mapped to the billing_dimension.", - "properties": { - "id": { - "description": "The URL for the endpoint.", - "example": "api/v1/usage/billable-summary", - "type": "string" - }, - "keys": { - "description": "The billing dimension.", - "example": [ - "apm_host_top99p", - "apm_host_sum" - ], - "items": { - "example": "apm_host_top99p", + "included": { + "description": "Array of objects related to the application key.", + "items": { + "description": "An object related to an application key.", + "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" }, - "type": "array" - }, - "status": { - "description": "Denotes whether mapping keys were available for this endpoint.", - "enum": [ - "OK", - "NOT_FOUND" - ], - "type": "string", - "x-enum-varnames": [ - "OK", - "NOT_FOUND" - ] - } - }, - "type": "object" - }, - "type": "array" - }, - "in_app_label": { - "description": "Label used for the billing dimension in the Plan & Usage charts.", - "example": "APM Hosts", - "type": "string" - }, - "timestamp": { - "description": "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`.", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "ID of the billing dimension.", - "type": "string" - }, - "type": { - "default": "billing_dimensions", - "description": "Type of active billing dimensions data.", - "enum": [ - "billing_dimensions" - ], - "type": "string", - "x-enum-varnames": [ - "BILLING_DIMENSIONS" - ] - } - }, - "type": "object" - }, - "type": "array" - }, - "BillingDimensionsMappingBodyItem": { - "description": "The mapping data for each billing dimension.", - "properties": { - "attributes": { - "description": "Mapping of billing dimensions to endpoint keys.", - "properties": { - "endpoints": { - "description": "List of supported endpoints with their keys mapped to the billing_dimension.", - "items": { - "description": "An endpoint's keys mapped to the billing_dimension.", + "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": "Role object returned by the API.", "properties": { + "attributes": { + "description": "Attributes of the role.", + "properties": { + "created_at": { + "description": "Creation time of the role.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_at": { + "description": "Time of last role modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", + "type": "string" + }, + "user_count": { + "description": "Number of users with that role.", + "format": "int64", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, "id": { - "description": "The URL for the endpoint.", - "example": "api/v1/usage/billable-summary", + "description": "The unique identifier of the role.", "type": "string" }, - "keys": { - "description": "The billing dimension.", - "example": [ - "apm_host_top99p", - "apm_host_sum" + "relationships": { + "description": "Relationships of the role object returned by the API.", + "properties": { + "permissions": { + "description": "Relationship to multiple permissions objects.", + "properties": { + "data": { + "description": "Relationships to permission objects.", + "items": { + "description": "Relationship to permission object.", + "properties": { + "id": { + "description": "ID of the permission.", + "type": "string" + }, + "type": { + "default": "permissions", + "description": "Permissions resource type.", + "enum": [ + "permissions" + ], + "example": "permissions", + "type": "string", + "x-enum-varnames": [ + "PERMISSIONS" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" + }, + "type": { + "default": "roles", + "description": "Roles type.", + "enum": [ + "roles" ], - "items": { - "example": "apm_host_top99p", - "type": "string" + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } + }, + "required": [ + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + { + "description": "The definition of LeakedKey object.", + "properties": { + "attributes": { + "description": "The definition of LeakedKeyAttributes object.", + "properties": { + "date": { + "description": "The LeakedKeyAttributes date.", + "example": "2017-07-21T17:32:28Z", + "format": "date-time", + "type": "string" + }, + "leak_source": { + "description": "The LeakedKeyAttributes leak_source.", + "type": "string" + } }, - "type": "array" + "required": [ + "date" + ], + "type": "object" }, - "status": { - "description": "Denotes whether mapping keys were available for this endpoint.", + "id": { + "description": "The LeakedKey id.", + "example": "id", + "type": "string" + }, + "type": { + "default": "leaked_keys", + "description": "The definition of LeakedKeyType object.", "enum": [ - "OK", - "NOT_FOUND" + "leaked_keys" ], + "example": "leaked_keys", "type": "string", "x-enum-varnames": [ - "OK", - "NOT_FOUND" + "LEAKED_KEYS" ] } }, + "required": [ + "attributes", + "id", + "type" + ], "type": "object" - }, - "type": "array" - }, - "in_app_label": { - "description": "Label used for the billing dimension in the Plan & Usage charts.", - "example": "APM Hosts", - "type": "string" - }, - "timestamp": { - "description": "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`.", - "format": "date-time", - "type": "string" - } + } + ] }, - "type": "object" - }, - "id": { - "description": "ID of the billing dimension.", - "type": "string" - }, - "type": { - "default": "billing_dimensions", - "description": "Type of active billing dimensions data.", - "enum": [ - "billing_dimensions" - ], - "type": "string", - "x-enum-varnames": [ - "BILLING_DIMENSIONS" - ] + "type": "array" } }, "type": "object" }, - "BillingDimensionsMappingBodyItemAttributes": { - "description": "Mapping of billing dimensions to endpoint keys.", - "properties": { - "endpoints": { - "description": "List of supported endpoints with their keys mapped to the billing_dimension.", - "items": { - "description": "An endpoint's keys mapped to the billing_dimension.", - "properties": { - "id": { - "description": "The URL for the endpoint.", - "example": "api/v1/usage/billable-summary", - "type": "string" - }, - "keys": { - "description": "The billing dimension.", - "example": [ - "apm_host_top99p", - "apm_host_sum" - ], - "items": { - "example": "apm_host_top99p", + "ApplicationKeyResponseIncludedItem": { + "description": "An object related to an application key.", + "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" }, - "type": "array" + "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" + } }, - "status": { - "description": "Denotes whether mapping keys were available for this endpoint.", - "enum": [ - "OK", - "NOT_FOUND" - ], - "type": "string", - "x-enum-varnames": [ - "OK", - "NOT_FOUND" - ] - } + "type": "object" }, - "type": "object" - }, - "type": "array" - }, - "in_app_label": { - "description": "Label used for the billing dimension in the Plan & Usage charts.", - "example": "APM Hosts", - "type": "string" - }, - "timestamp": { - "description": "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`.", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "BillingDimensionsMappingBodyItemAttributesEndpointsItems": { - "description": "An endpoint's keys mapped to the billing_dimension.", - "properties": { - "id": { - "description": "The URL for the endpoint.", - "example": "api/v1/usage/billable-summary", - "type": "string" - }, - "keys": { - "description": "The billing dimension.", - "example": [ - "apm_host_top99p", - "apm_host_sum" - ], - "items": { - "example": "apm_host_top99p", - "type": "string" - }, - "type": "array" - }, - "status": { - "description": "Denotes whether mapping keys were available for this endpoint.", - "enum": [ - "OK", - "NOT_FOUND" - ], - "type": "string", - "x-enum-varnames": [ - "OK", - "NOT_FOUND" - ] - } - }, - "type": "object" - }, - "BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus": { - "description": "Denotes whether mapping keys were available for this endpoint.", - "enum": [ - "OK", - "NOT_FOUND" - ], - "type": "string", - "x-enum-varnames": [ - "OK", - "NOT_FOUND" - ] - }, - "BillingDimensionsMappingResponse": { - "description": "Billing dimensions mapping response.", - "properties": { - "data": { - "description": "Billing dimensions mapping data.", - "items": { - "description": "The mapping data for each billing dimension.", - "properties": { - "attributes": { - "description": "Mapping of billing dimensions to endpoint keys.", - "properties": { - "endpoints": { - "description": "List of supported endpoints with their keys mapped to the billing_dimension.", - "items": { - "description": "An endpoint's keys mapped to the billing_dimension.", + "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": "The URL for the endpoint.", - "example": "api/v1/usage/billable-summary", + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", "type": "string" }, - "keys": { - "description": "The billing dimension.", - "example": [ - "apm_host_top99p", - "apm_host_sum" - ], - "items": { - "example": "apm_host_top99p", - "type": "string" - }, - "type": "array" - }, - "status": { - "description": "Denotes whether mapping keys were available for this endpoint.", + "type": { + "default": "orgs", + "description": "Organizations resource type.", "enum": [ - "OK", - "NOT_FOUND" + "orgs" ], + "example": "orgs", "type": "string", "x-enum-varnames": [ - "OK", - "NOT_FOUND" + "ORGS" ] } }, + "required": [ + "id", + "type" + ], "type": "object" - }, - "type": "array" + } }, - "in_app_label": { - "description": "Label used for the billing dimension in the Plan & Usage charts.", - "example": "APM Hosts", - "type": "string" + "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" + } }, - "timestamp": { - "description": "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`.", - "format": "date-time", - "type": "string" - } + "required": [ + "data" + ], + "type": "object" }, - "type": "object" - }, - "id": { - "description": "ID of the billing dimension.", - "type": "string" - }, - "type": { - "default": "billing_dimensions", - "description": "Type of active billing dimensions data.", - "enum": [ - "billing_dimensions" - ], - "type": "string", - "x-enum-varnames": [ - "BILLING_DIMENSIONS" - ] - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - }, - "BulkMuteFindingsRequest": { - "description": "The new bulk mute finding request.", - "properties": { - "data": { - "description": "Data object containing the new bulk mute properties of the finding.", - "properties": { - "attributes": { - "additionalProperties": false, - "description": "The mute properties to be updated.", - "properties": { - "mute": { - "additionalProperties": false, - "description": "Object containing the new mute properties of the findings.", + "other_users": { + "description": "Relationship to users.", "properties": { - "description": { - "description": "Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.", - "type": "string" - }, - "expiration_date": { - "description": "The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.\nIf this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.\n", - "example": 1778721573794, - "format": "int64", - "type": "integer" - }, - "muted": { - "description": "Whether those findings should be muted or unmuted.", - "example": true, - "type": "boolean" - }, - "reason": { - "description": "The reason why this finding is muted or unmuted.", - "enum": [ - "PENDING_FIX", - "FALSE_POSITIVE", - "ACCEPTED_RISK", - "NO_PENDING_FIX", - "HUMAN_ERROR", - "NO_LONGER_ACCEPTED_RISK", - "OTHER" - ], - "example": "ACCEPTED_RISK", - "type": "string", - "x-enum-varnames": [ - "PENDING_FIX", - "FALSE_POSITIVE", - "ACCEPTED_RISK", - "NO_PENDING_FIX", - "HUMAN_ERROR", - "NO_LONGER_ACCEPTED_RISK", - "OTHER" - ] + "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": [ - "muted", - "reason" + "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 + } } }, - "required": [ - "mute" + "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": "Role object returned by the API.", + "properties": { + "attributes": { + "description": "Attributes of the role.", + "properties": { + "created_at": { + "description": "Creation time of the role.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_at": { + "description": "Time of last role modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", + "type": "string" + }, + "user_count": { + "description": "Number of users with that role.", + "format": "int64", + "readOnly": true, + "type": "integer" + } + }, "type": "object" }, "id": { - "description": "UUID to identify the request", - "example": "dbe5f567-192b-4404-b908-29b70e1c9f76", + "description": "The unique identifier of the role.", "type": "string" }, - "meta": { - "description": "Meta object containing the findings to be updated.", + "relationships": { + "description": "Relationships of the role object returned by the API.", "properties": { - "findings": { - "description": "Array of findings.", - "items": { - "description": "Finding object containing the finding information.", - "properties": { - "finding_id": { - "description": "The unique ID for this finding.", - "example": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", - "type": "string" - } - }, - "type": "object" + "permissions": { + "description": "Relationship to multiple permissions objects.", + "properties": { + "data": { + "description": "Relationships to permission objects.", + "items": { + "description": "Relationship to permission object.", + "properties": { + "id": { + "description": "ID of the permission.", + "type": "string" + }, + "type": { + "default": "permissions", + "description": "Permissions resource type.", + "enum": [ + "permissions" + ], + "example": "permissions", + "type": "string", + "x-enum-varnames": [ + "PERMISSIONS" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } }, - "type": "array" + "type": "object", + "x-merge-override": { + "required": false + } } }, "type": "object" }, "type": { - "default": "finding", - "description": "The JSON:API type for findings.", + "default": "roles", + "description": "Roles type.", "enum": [ - "finding" + "roles" ], - "example": "finding", + "example": "roles", "type": "string", "x-enum-varnames": [ - "FINDING" + "ROLES" ] } }, "required": [ - "id", - "type", - "attributes", - "meta" + "type" ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "BulkMuteFindingsRequestAttributes": { - "additionalProperties": false, - "description": "The mute properties to be updated.", - "properties": { - "mute": { - "additionalProperties": false, - "description": "Object containing the new mute properties of the findings.", - "properties": { - "description": { - "description": "Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.", - "type": "string" - }, - "expiration_date": { - "description": "The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.\nIf this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.\n", - "example": 1778721573794, - "format": "int64", - "type": "integer" + "type": "object", + "x-merge-override": { + "required": false + } + }, + { + "description": "The definition of LeakedKey object.", + "properties": { + "attributes": { + "description": "The definition of LeakedKeyAttributes object.", + "properties": { + "date": { + "description": "The LeakedKeyAttributes date.", + "example": "2017-07-21T17:32:28Z", + "format": "date-time", + "type": "string" + }, + "leak_source": { + "description": "The LeakedKeyAttributes leak_source.", + "type": "string" + } + }, + "required": [ + "date" + ], + "type": "object" }, - "muted": { - "description": "Whether those findings should be muted or unmuted.", - "example": true, - "type": "boolean" + "id": { + "description": "The LeakedKey id.", + "example": "id", + "type": "string" }, - "reason": { - "description": "The reason why this finding is muted or unmuted.", + "type": { + "default": "leaked_keys", + "description": "The definition of LeakedKeyType object.", "enum": [ - "PENDING_FIX", - "FALSE_POSITIVE", - "ACCEPTED_RISK", - "NO_PENDING_FIX", - "HUMAN_ERROR", - "NO_LONGER_ACCEPTED_RISK", - "OTHER" + "leaked_keys" ], - "example": "ACCEPTED_RISK", + "example": "leaked_keys", "type": "string", "x-enum-varnames": [ - "PENDING_FIX", - "FALSE_POSITIVE", - "ACCEPTED_RISK", - "NO_PENDING_FIX", - "HUMAN_ERROR", - "NO_LONGER_ACCEPTED_RISK", - "OTHER" + "LEAKED_KEYS" ] } }, "required": [ - "muted", - "reason" + "attributes", + "id", + "type" ], "type": "object" } - }, - "required": [ - "mute" - ], - "type": "object" + ] }, - "BulkMuteFindingsRequestData": { - "description": "Data object containing the new bulk mute properties of the finding.", + "ApplicationKeyResponseMeta": { + "description": "Additional information related to the application key response.", "properties": { - "attributes": { - "additionalProperties": false, - "description": "The mute properties to be updated.", - "properties": { - "mute": { - "additionalProperties": false, - "description": "Object containing the new mute properties of the findings.", - "properties": { - "description": { - "description": "Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.", - "type": "string" - }, - "expiration_date": { - "description": "The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.\nIf this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.\n", - "example": 1778721573794, - "format": "int64", - "type": "integer" - }, - "muted": { - "description": "Whether those findings should be muted or unmuted.", - "example": true, - "type": "boolean" - }, - "reason": { - "description": "The reason why this finding is muted or unmuted.", - "enum": [ - "PENDING_FIX", - "FALSE_POSITIVE", - "ACCEPTED_RISK", - "NO_PENDING_FIX", - "HUMAN_ERROR", - "NO_LONGER_ACCEPTED_RISK", - "OTHER" - ], - "example": "ACCEPTED_RISK", - "type": "string", - "x-enum-varnames": [ - "PENDING_FIX", - "FALSE_POSITIVE", - "ACCEPTED_RISK", - "NO_PENDING_FIX", - "HUMAN_ERROR", - "NO_LONGER_ACCEPTED_RISK", - "OTHER" - ] - } - }, - "required": [ - "muted", - "reason" - ], - "type": "object" - } - }, - "required": [ - "mute" - ], - "type": "object" - }, - "id": { - "description": "UUID to identify the request", - "example": "dbe5f567-192b-4404-b908-29b70e1c9f76", - "type": "string" + "max_allowed_per_user": { + "description": "Max allowed number of application keys per user.", + "format": "int64", + "type": "integer" }, - "meta": { - "description": "Meta object containing the findings to be updated.", + "page": { + "description": "Additional information related to the application key response.", "properties": { - "findings": { - "description": "Array of findings.", - "items": { - "description": "Finding object containing the finding information.", - "properties": { - "finding_id": { - "description": "The unique ID for this finding.", - "example": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" + "total_filtered_count": { + "description": "Total filtered application key count.", + "format": "int64", + "type": "integer" } }, "type": "object" - }, - "type": { - "default": "finding", - "description": "The JSON:API type for findings.", - "enum": [ - "finding" - ], - "example": "finding", - "type": "string", - "x-enum-varnames": [ - "FINDING" - ] } }, - "required": [ - "id", - "type", - "attributes", - "meta" - ], "type": "object" }, - "BulkMuteFindingsRequestMeta": { - "description": "Meta object containing the findings to be updated.", + "ApplicationKeyResponseMetaPage": { + "description": "Additional information related to the application key response.", "properties": { - "findings": { - "description": "Array of findings.", - "items": { - "description": "Finding object containing the finding information.", - "properties": { - "finding_id": { - "description": "The unique ID for this finding.", - "example": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" + "total_filtered_count": { + "description": "Total filtered application key count.", + "format": "int64", + "type": "integer" } }, "type": "object" }, - "BulkMuteFindingsRequestMetaFindings": { - "description": "Finding object containing the finding information.", + "ApplicationKeyUpdateAttributes": { + "description": "Attributes used to update an application Key.", "properties": { - "finding_id": { - "description": "The unique ID for this finding.", - "example": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", + "name": { + "description": "Name of the application key.", + "example": "Application Key for managing dashboards", "type": "string" + }, + "scopes": { + "description": "Array of scopes to grant the application key.", + "example": [ + "dashboards_read", + "dashboards_write", + "dashboards_public_share" + ], + "items": { + "description": "Name of scope.", + "type": "string" + }, + "nullable": true, + "type": "array" } }, - "type": "object" + "type": "object", + "x-merge-override": { + "properties": false + } }, - "BulkMuteFindingsRequestProperties": { - "additionalProperties": false, - "description": "Object containing the new mute properties of the findings.", + "ApplicationKeyUpdateData": { + "description": "Object used to update an application key.", "properties": { - "description": { - "description": "Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.", - "type": "string" - }, - "expiration_date": { - "description": "The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.\nIf this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.\n", - "example": 1778721573794, - "format": "int64", - "type": "integer" + "attributes": { + "description": "Attributes used to update an application Key.", + "properties": { + "name": { + "description": "Name of the application key.", + "example": "Application Key for managing dashboards", + "type": "string" + }, + "scopes": { + "description": "Array of scopes to grant the application key.", + "example": [ + "dashboards_read", + "dashboards_write", + "dashboards_public_share" + ], + "items": { + "description": "Name of scope.", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object", + "x-merge-override": { + "properties": false + } }, - "muted": { - "description": "Whether those findings should be muted or unmuted.", - "example": true, - "type": "boolean" + "id": { + "description": "ID of the application key.", + "example": "00112233-4455-6677-8899-aabbccddeeff", + "type": "string" }, - "reason": { - "description": "The reason why this finding is muted or unmuted.", + "type": { + "default": "application_keys", + "description": "Application Keys resource type.", "enum": [ - "PENDING_FIX", - "FALSE_POSITIVE", - "ACCEPTED_RISK", - "NO_PENDING_FIX", - "HUMAN_ERROR", - "NO_LONGER_ACCEPTED_RISK", - "OTHER" + "application_keys" ], - "example": "ACCEPTED_RISK", + "example": "application_keys", "type": "string", "x-enum-varnames": [ - "PENDING_FIX", - "FALSE_POSITIVE", - "ACCEPTED_RISK", - "NO_PENDING_FIX", - "HUMAN_ERROR", - "NO_LONGER_ACCEPTED_RISK", - "OTHER" + "APPLICATION_KEYS" ] } }, "required": [ - "muted", - "reason" + "attributes", + "id", + "type" ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } }, - "BulkMuteFindingsResponse": { - "description": "The expected response schema.", + "ApplicationKeyUpdateRequest": { + "description": "Request used to update an application key.", "properties": { "data": { - "description": "Data object containing the ID of the request that was updated.", + "description": "Object used to update an application key.", "properties": { + "attributes": { + "description": "Attributes used to update an application Key.", + "properties": { + "name": { + "description": "Name of the application key.", + "example": "Application Key for managing dashboards", + "type": "string" + }, + "scopes": { + "description": "Array of scopes to grant the application key.", + "example": [ + "dashboards_read", + "dashboards_write", + "dashboards_public_share" + ], + "items": { + "description": "Name of scope.", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object", + "x-merge-override": { + "properties": false + } + }, "id": { - "description": "UUID used to identify the request", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "description": "ID of the application key.", + "example": "00112233-4455-6677-8899-aabbccddeeff", "type": "string" }, "type": { - "default": "finding", - "description": "The JSON:API type for findings.", + "default": "application_keys", + "description": "Application Keys resource type.", "enum": [ - "finding" + "application_keys" ], - "example": "finding", + "example": "application_keys", "type": "string", "x-enum-varnames": [ - "FINDING" + "APPLICATION_KEYS" ] } }, - "type": "object" + "required": [ + "attributes", + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } } }, "required": [ @@ -10608,6081 +9404,11846 @@ ], "type": "object" }, - "BulkMuteFindingsResponseData": { - "description": "Data object containing the ID of the request that was updated.", + "ApplicationKeysSort": { + "default": "name", + "description": "Sorting options", + "enum": [ + "created_at", + "-created_at", + "last4", + "-last4", + "name", + "-name" + ], + "type": "string", + "x-enum-varnames": [ + "CREATED_AT_ASCENDING", + "CREATED_AT_DESCENDING", + "LAST4_ASCENDING", + "LAST4_DESCENDING", + "NAME_ASCENDING", + "NAME_DESCENDING" + ] + }, + "ApplicationKeysType": { + "default": "application_keys", + "description": "Application Keys resource type.", + "enum": [ + "application_keys" + ], + "example": "application_keys", + "type": "string", + "x-enum-varnames": [ + "APPLICATION_KEYS" + ] + }, + "AuditLogsEvent": { + "description": "Object description of an Audit Logs event after it is processed and stored by Datadog.", "properties": { + "attributes": { + "description": "JSON object containing all event attributes and their associated values.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "JSON object of attributes from Audit Logs events.", + "example": { + "customAttribute": 123, + "duration": 2345 + }, + "type": "object" + }, + "message": { + "description": "Message of the event.", + "type": "string" + }, + "service": { + "description": "Name of the application or service generating Audit Logs events.\nThis name is used to correlate Audit Logs to APM, so make sure you specify the same\nvalue when you use both products.", + "example": "web-app", + "type": "string" + }, + "tags": { + "description": "Array of tags associated with your event.", + "example": [ + "team:A" + ], + "items": { + "description": "Tag associated with your event.", + "type": "string" + }, + "type": "array" + }, + "timestamp": { + "description": "Timestamp of your event.", + "example": "2019-01-02T09:42:36.320Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, "id": { - "description": "UUID used to identify the request", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "description": "Unique ID of the event.", + "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", "type": "string" }, "type": { - "default": "finding", - "description": "The JSON:API type for findings.", + "default": "audit", + "description": "Type of the event.", "enum": [ - "finding" + "audit" ], - "example": "finding", + "example": "audit", "type": "string", "x-enum-varnames": [ - "FINDING" + "Audit" ] } }, "type": "object" }, - "CIAppAggregateBucketValue": { - "description": "A bucket value, can either be a timeseries or a single value.", - "oneOf": [ - { - "description": "A single string value.", + "AuditLogsEventAttributes": { + "description": "JSON object containing all event attributes and their associated values.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "JSON object of attributes from Audit Logs events.", + "example": { + "customAttribute": 123, + "duration": 2345 + }, + "type": "object" + }, + "message": { + "description": "Message of the event.", "type": "string" }, - { - "description": "A single number value.", - "format": "double", - "type": "number" + "service": { + "description": "Name of the application or service generating Audit Logs events.\nThis name is used to correlate Audit Logs to APM, so make sure you specify the same\nvalue when you use both products.", + "example": "web-app", + "type": "string" }, - { - "description": "A timeseries array.", + "tags": { + "description": "Array of tags associated with your event.", + "example": [ + "team:A" + ], "items": { - "description": "A timeseries point.", + "description": "Tag associated with your event.", + "type": "string" + }, + "type": "array" + }, + "timestamp": { + "description": "Timestamp of your event.", + "example": "2019-01-02T09:42:36.320Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "AuditLogsEventType": { + "default": "audit", + "description": "Type of the event.", + "enum": [ + "audit" + ], + "example": "audit", + "type": "string", + "x-enum-varnames": [ + "Audit" + ] + }, + "AuditLogsEventsResponse": { + "description": "Response object with all events matching the request and pagination information.", + "properties": { + "data": { + "description": "Array of events matching the request.", + "items": { + "description": "Object description of an Audit Logs event after it is processed and stored by Datadog.", "properties": { - "time": { - "description": "The time value for this point.", - "example": "2020-06-08T11:55:00.123Z", - "format": "date-time", + "attributes": { + "description": "JSON object containing all event attributes and their associated values.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "JSON object of attributes from Audit Logs events.", + "example": { + "customAttribute": 123, + "duration": 2345 + }, + "type": "object" + }, + "message": { + "description": "Message of the event.", + "type": "string" + }, + "service": { + "description": "Name of the application or service generating Audit Logs events.\nThis name is used to correlate Audit Logs to APM, so make sure you specify the same\nvalue when you use both products.", + "example": "web-app", + "type": "string" + }, + "tags": { + "description": "Array of tags associated with your event.", + "example": [ + "team:A" + ], + "items": { + "description": "Tag associated with your event.", + "type": "string" + }, + "type": "array" + }, + "timestamp": { + "description": "Timestamp of your event.", + "example": "2019-01-02T09:42:36.320Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Unique ID of the event.", + "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", "type": "string" }, - "value": { - "description": "The value for this point.", - "example": 19, - "format": "double", - "type": "number" + "type": { + "default": "audit", + "description": "Type of the event.", + "enum": [ + "audit" + ], + "example": "audit", + "type": "string", + "x-enum-varnames": [ + "Audit" + ] } }, "type": "object" }, - "type": "array", - "x-generate-alias-as-model": true + "type": "array" + }, + "links": { + "description": "Links attributes.", + "properties": { + "next": { + "description": "Link for the next set of results. Note that the request can also be made using the\nPOST endpoint.", + "example": "https://app.datadoghq.com/api/v2/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "description": "The metadata associated with a request.", + "properties": { + "elapsed": { + "description": "Time elapsed in milliseconds.", + "example": 132, + "format": "int64", + "type": "integer" + }, + "page": { + "description": "Paging attributes.", + "properties": { + "after": { + "description": "The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + } + }, + "type": "object" + }, + "request_id": { + "description": "The identifier of the request.", + "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", + "type": "string" + }, + "status": { + "description": "The status of the response.", + "enum": [ + "done", + "timeout" + ], + "example": "done", + "type": "string", + "x-enum-varnames": [ + "DONE", + "TIMEOUT" + ] + }, + "warnings": { + "description": "A list of warnings (non-fatal errors) encountered. Partial results may return if\nwarnings are present in the response.", + "items": { + "description": "Warning message indicating something that went wrong with the query.", + "properties": { + "code": { + "description": "Unique code for this type of warning.", + "example": "unknown_index", + "type": "string" + }, + "detail": { + "description": "Detailed explanation of this specific warning.", + "example": "indexes: foo, bar", + "type": "string" + }, + "title": { + "description": "Short human-readable summary of the warning.", + "example": "One or several indexes are missing or invalid, results hold data from the other indexes", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" } - ] - }, - "CIAppAggregateBucketValueSingleNumber": { - "description": "A single number value.", - "format": "double", - "type": "number" + }, + "type": "object" }, - "CIAppAggregateBucketValueSingleString": { - "description": "A single string value.", - "type": "string" + "AuditLogsQueryFilter": { + "description": "Search and filter query settings.", + "properties": { + "from": { + "default": "now-15m", + "description": "Minimum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).", + "example": "now-15m", + "type": "string" + }, + "query": { + "default": "*", + "description": "Search query following the Audit Logs search syntax.", + "example": "@type:session AND @session.type:user", + "type": "string" + }, + "to": { + "default": "now", + "description": "Maximum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).", + "example": "now", + "type": "string" + } + }, + "type": "object" }, - "CIAppAggregateBucketValueTimeseries": { - "description": "A timeseries array.", - "items": { - "description": "A timeseries point.", - "properties": { - "time": { - "description": "The time value for this point.", - "example": "2020-06-08T11:55:00.123Z", - "format": "date-time", - "type": "string" - }, - "value": { - "description": "The value for this point.", - "example": 19, - "format": "double", - "type": "number" - } + "AuditLogsQueryOptions": { + "description": "Global query options that are used during the query.\nNote: Specify either timezone or time offset, not both. Otherwise, the query fails.", + "properties": { + "time_offset": { + "description": "Time offset (in seconds) to apply to the query.", + "format": "int64", + "type": "integer" }, - "type": "object" + "timezone": { + "default": "UTC", + "description": "The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).", + "example": "GMT", + "type": "string" + } }, - "type": "array", - "x-generate-alias-as-model": true + "type": "object" }, - "CIAppAggregateBucketValueTimeseriesPoint": { - "description": "A timeseries point.", + "AuditLogsQueryPageOptions": { + "description": "Paging attributes for listing events.", "properties": { - "time": { - "description": "The time value for this point.", - "example": "2020-06-08T11:55:00.123Z", - "format": "date-time", + "cursor": { + "description": "List following results with a cursor provided in the previous query.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "string" }, - "value": { - "description": "The value for this point.", - "example": 19, - "format": "double", - "type": "number" + "limit": { + "default": 10, + "description": "Maximum number of events in the response.", + "example": 25, + "format": "int32", + "maximum": 1000, + "type": "integer" } }, "type": "object" }, - "CIAppAggregateSort": { - "description": "A sort rule. The `aggregation` field is required when `type` is `measure`.", - "example": { - "aggregation": "count", - "order": "asc" + "AuditLogsResponseLinks": { + "description": "Links attributes.", + "properties": { + "next": { + "description": "Link for the next set of results. Note that the request can also be made using the\nPOST endpoint.", + "example": "https://app.datadoghq.com/api/v2/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + } }, + "type": "object" + }, + "AuditLogsResponseMetadata": { + "description": "The metadata associated with a request.", "properties": { - "aggregation": { - "description": "An aggregation function.", - "enum": [ - "count", - "cardinality", - "pc75", - "pc90", - "pc95", - "pc98", - "pc99", - "sum", - "min", - "max", - "avg", - "median", - "latest", - "earliest", - "most_frequent", - "delta" - ], - "example": "pc90", - "type": "string", - "x-enum-varnames": [ - "COUNT", - "CARDINALITY", - "PERCENTILE_75", - "PERCENTILE_90", - "PERCENTILE_95", - "PERCENTILE_98", - "PERCENTILE_99", - "SUM", - "MIN", - "MAX", - "AVG", - "MEDIAN", - "LATEST", - "EARLIEST", - "MOST_FREQUENT", - "DELTA" - ] + "elapsed": { + "description": "Time elapsed in milliseconds.", + "example": 132, + "format": "int64", + "type": "integer" }, - "metric": { - "description": "The metric to sort by (only used for `type=measure`).", - "example": "@duration", + "page": { + "description": "Paging attributes.", + "properties": { + "after": { + "description": "The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + } + }, + "type": "object" + }, + "request_id": { + "description": "The identifier of the request.", + "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", "type": "string" }, - "order": { - "description": "The order to use, ascending or descending.", + "status": { + "description": "The status of the response.", "enum": [ - "asc", - "desc" + "done", + "timeout" ], - "example": "asc", + "example": "done", "type": "string", "x-enum-varnames": [ - "ASCENDING", - "DESCENDING" + "DONE", + "TIMEOUT" ] }, - "type": { - "default": "alphabetical", - "description": "The type of sorting algorithm.", - "enum": [ - "alphabetical", - "measure" - ], - "type": "string", - "x-enum-varnames": [ - "ALPHABETICAL", - "MEASURE" - ] + "warnings": { + "description": "A list of warnings (non-fatal errors) encountered. Partial results may return if\nwarnings are present in the response.", + "items": { + "description": "Warning message indicating something that went wrong with the query.", + "properties": { + "code": { + "description": "Unique code for this type of warning.", + "example": "unknown_index", + "type": "string" + }, + "detail": { + "description": "Detailed explanation of this specific warning.", + "example": "indexes: foo, bar", + "type": "string" + }, + "title": { + "description": "Short human-readable summary of the warning.", + "example": "One or several indexes are missing or invalid, results hold data from the other indexes", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" } }, "type": "object" }, - "CIAppAggregateSortType": { - "default": "alphabetical", - "description": "The type of sorting algorithm.", - "enum": [ - "alphabetical", - "measure" - ], - "type": "string", - "x-enum-varnames": [ - "ALPHABETICAL", - "MEASURE" - ] - }, - "CIAppAggregationFunction": { - "description": "An aggregation function.", - "enum": [ - "count", - "cardinality", - "pc75", - "pc90", - "pc95", - "pc98", - "pc99", - "sum", - "min", - "max", - "avg", - "median", - "latest", - "earliest", - "most_frequent", - "delta" - ], - "example": "pc90", - "type": "string", - "x-enum-varnames": [ - "COUNT", - "CARDINALITY", - "PERCENTILE_75", - "PERCENTILE_90", - "PERCENTILE_95", - "PERCENTILE_98", - "PERCENTILE_99", - "SUM", - "MIN", - "MAX", - "AVG", - "MEDIAN", - "LATEST", - "EARLIEST", - "MOST_FREQUENT", - "DELTA" - ] - }, - "CIAppCIError": { - "description": "Contains information of the CI error.", - "nullable": true, + "AuditLogsResponsePage": { + "description": "Paging attributes.", "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, + "after": { + "description": "The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "string" } }, "type": "object" }, - "CIAppCIErrorDomain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "AuditLogsResponseStatus": { + "description": "The status of the response.", "enum": [ - "provider", - "user", - "unknown" + "done", + "timeout" ], + "example": "done", "type": "string", "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" + "DONE", + "TIMEOUT" ] }, - "CIAppCompute": { - "description": "A compute rule to compute metrics or timeseries.", + "AuditLogsSearchEventsRequest": { + "description": "The request for a Audit Logs events list.", "properties": { - "aggregation": { - "description": "An aggregation function.", - "enum": [ - "count", - "cardinality", - "pc75", - "pc90", - "pc95", - "pc98", - "pc99", - "sum", - "min", - "max", - "avg", - "median", - "latest", - "earliest", - "most_frequent", - "delta" - ], - "example": "pc90", - "type": "string", - "x-enum-varnames": [ - "COUNT", - "CARDINALITY", - "PERCENTILE_75", - "PERCENTILE_90", - "PERCENTILE_95", - "PERCENTILE_98", - "PERCENTILE_99", - "SUM", - "MIN", - "MAX", - "AVG", - "MEDIAN", - "LATEST", - "EARLIEST", - "MOST_FREQUENT", - "DELTA" - ] + "filter": { + "description": "Search and filter query settings.", + "properties": { + "from": { + "default": "now-15m", + "description": "Minimum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).", + "example": "now-15m", + "type": "string" + }, + "query": { + "default": "*", + "description": "Search query following the Audit Logs search syntax.", + "example": "@type:session AND @session.type:user", + "type": "string" + }, + "to": { + "default": "now", + "description": "Maximum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).", + "example": "now", + "type": "string" + } + }, + "type": "object" }, - "interval": { - "description": "The time buckets' size (only used for type=timeseries)\nDefaults to a resolution of 150 points.", - "example": "5m", - "type": "string" + "options": { + "description": "Global query options that are used during the query.\nNote: Specify either timezone or time offset, not both. Otherwise, the query fails.", + "properties": { + "time_offset": { + "description": "Time offset (in seconds) to apply to the query.", + "format": "int64", + "type": "integer" + }, + "timezone": { + "default": "UTC", + "description": "The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).", + "example": "GMT", + "type": "string" + } + }, + "type": "object" }, - "metric": { - "description": "The metric to use.", - "example": "@duration", - "type": "string" + "page": { + "description": "Paging attributes for listing events.", + "properties": { + "cursor": { + "description": "List following results with a cursor provided in the previous query.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + }, + "limit": { + "default": 10, + "description": "Maximum number of events in the response.", + "example": 25, + "format": "int32", + "maximum": 1000, + "type": "integer" + } + }, + "type": "object" }, - "type": { - "default": "total", - "description": "The type of compute.", + "sort": { + "description": "Sort parameters when querying events.", "enum": [ - "timeseries", - "total" + "timestamp", + "-timestamp" ], "type": "string", "x-enum-varnames": [ - "TIMESERIES", - "TOTAL" + "TIMESTAMP_ASCENDING", + "TIMESTAMP_DESCENDING" ] } }, - "required": [ - "aggregation" - ], "type": "object" }, - "CIAppComputeType": { - "default": "total", - "description": "The type of compute.", + "AuditLogsSort": { + "description": "Sort parameters when querying events.", "enum": [ - "timeseries", - "total" + "timestamp", + "-timestamp" ], "type": "string", "x-enum-varnames": [ - "TIMESERIES", - "TOTAL" + "TIMESTAMP_ASCENDING", + "TIMESTAMP_DESCENDING" ] }, - "CIAppComputes": { - "additionalProperties": { - "description": "A bucket value, can either be a timeseries or a single value.", - "oneOf": [ - { - "description": "A single string value.", - "type": "string" - }, - { - "description": "A single number value.", - "format": "double", - "type": "number" + "AuditLogsWarning": { + "description": "Warning message indicating something that went wrong with the query.", + "properties": { + "code": { + "description": "Unique code for this type of warning.", + "example": "unknown_index", + "type": "string" + }, + "detail": { + "description": "Detailed explanation of this specific warning.", + "example": "indexes: foo, bar", + "type": "string" + }, + "title": { + "description": "Short human-readable summary of the warning.", + "example": "One or several indexes are missing or invalid, results hold data from the other indexes", + "type": "string" + } + }, + "type": "object" + }, + "AuthNMapping": { + "description": "The AuthN Mapping object returned by API.", + "properties": { + "attributes": { + "description": "Attributes of AuthN Mapping.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + }, + "created_at": { + "description": "Creation time of the AuthN Mapping.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_at": { + "description": "Time of last AuthN Mapping modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "saml_assertion_attribute_id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + } }, - { - "description": "A timeseries array.", - "items": { - "description": "A timeseries point.", + "type": "object" + }, + "id": { + "description": "ID of the AuthN Mapping.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" + }, + "relationships": { + "description": "All relationships associated with AuthN Mapping.", + "properties": { + "role": { + "description": "Relationship to role.", "properties": { - "time": { - "description": "The time value for this point.", - "example": "2020-06-08T11:55:00.123Z", - "format": "date-time", - "type": "string" - }, - "value": { - "description": "The value for this point.", - "example": 19, - "format": "double", - "type": "number" + "data": { + "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": "object", + "x-merge-override": { + "required": false + } + }, + "saml_assertion_attribute": { + "description": "AuthN Mapping relationship to SAML Assertion Attribute.", + "properties": { + "data": { + "description": "Data of AuthN Mapping relationship to SAML Assertion Attribute.", + "properties": { + "id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + }, + "type": { + "default": "saml_assertion_attributes", + "description": "SAML assertion attributes resource type.", + "enum": [ + "saml_assertion_attributes" + ], + "example": "saml_assertion_attributes", + "type": "string", + "x-enum-varnames": [ + "SAML_ASSERTION_ATTRIBUTES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } } }, + "required": [ + "data" + ], "type": "object" }, - "type": "array", - "x-generate-alias-as-model": true - } - ] + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", + "properties": { + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" + }, + "type": { + "default": "authn_mappings", + "description": "AuthN Mappings resource type.", + "enum": [ + "authn_mappings" + ], + "example": "authn_mappings", + "type": "string", + "x-enum-varnames": [ + "AUTHN_MAPPINGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "AuthNMappingAttributes": { + "description": "Attributes of AuthN Mapping.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + }, + "created_at": { + "description": "Creation time of the AuthN Mapping.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_at": { + "description": "Time of last AuthN Mapping modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "saml_assertion_attribute_id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + } }, - "description": "A map of the metric name to value for regular compute, or a list of values for a timeseries.", "type": "object" }, - "CIAppCreatePipelineEventRequest": { - "description": "Request object.", + "AuthNMappingCreateAttributes": { + "description": "Key/Value pair of attributes used for create request.", "properties": { - "data": { - "description": "Data of the pipeline event to create.", + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + } + }, + "type": "object" + }, + "AuthNMappingCreateData": { + "description": "Data for creating an AuthN Mapping.", + "properties": { + "attributes": { + "description": "Key/Value pair of attributes used for create request.", "properties": { - "attributes": { - "description": "Attributes of the pipeline event to create.", + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "description": "Relationship of AuthN Mapping create object to a Role or Team.", + "oneOf": [ + { + "description": "Relationship of AuthN Mapping to a Role.", "properties": { - "env": { - "description": "The Datadog environment.", - "type": "string" - }, - "resource": { - "description": "Details of the CI pipeline event.", - "example": "Details TBD", - "oneOf": [ - { - "description": "Details of the top level pipeline, build, or workflow of your CI.", + "role": { + "description": "Relationship to role.", + "properties": { + "data": { + "description": "Relationship to role object.", "properties": { - "end": { - "description": "Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + "id": { + "description": "The unique identifier of the role.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", "type": "string" }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "is_manual": { - "description": "Whether or not the pipeline was triggered manually by the user.", - "example": false, - "nullable": true, - "type": "boolean" - }, - "is_resumed": { - "description": "Whether or not the pipeline was resumed after being blocked.", - "example": false, - "nullable": true, - "type": "boolean" - }, - "level": { - "default": "pipeline", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "type": { + "default": "roles", + "description": "Roles type.", "enum": [ - "pipeline" + "roles" ], - "example": "pipeline", + "example": "roles", "type": "string", "x-enum-varnames": [ - "PIPELINE" + "ROLES" ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "Name of the pipeline. All pipeline runs for the builds should have the same name.", - "example": "Deploy to AWS", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "parent_pipeline": { - "description": "If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.", - "nullable": true, - "properties": { - "id": { - "description": "UUID of a pipeline.", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", - "type": "string" - }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://ci-platform.com/pipelines/123456789", - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "partial_retry": { - "description": "Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one\nwhich only runs a subset of the original jobs.", - "example": false, - "type": "boolean" - }, - "pipeline_id": { - "description": "Any ID used in the provider to identify the pipeline run even if it is not unique across retries.\nIf the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.", - "example": "#023", - "type": "string" - }, - "previous_attempt": { - "description": "If the pipeline is a retry, this should contain the details of the previous attempt.", - "nullable": true, - "properties": { - "id": { - "description": "UUID of a pipeline.", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", - "type": "string" - }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://ci-platform.com/pipelines/123456789", - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "start": { - "description": "Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "role" + ], + "type": "object" + }, + { + "description": "Relationship of AuthN Mapping to a Team.", + "properties": { + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", + "properties": { + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", "type": "string" }, - "status": { - "description": "The final status of the pipeline.", + "type": { + "default": "team", + "description": "Team type", "enum": [ - "success", - "error", - "canceled", - "skipped", - "blocked" + "team" ], - "example": "success", + "example": "team", "type": "string", "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED", - "BLOCKED" + "TEAM" ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "unique_id": { - "description": "UUID of the pipeline run. The ID has to be unique across retries and pipelines,\nincluding partial retries.", - "example": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", - "type": "string" - }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://my-ci-provider.example/pipelines/my-pipeline/run/1", - "type": "string" } }, - "required": [ - "level", - "unique_id", - "name", - "url", - "start", - "end", - "status", - "partial_retry" + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "team" + ], + "type": "object" + } + ] + }, + "type": { + "default": "authn_mappings", + "description": "AuthN Mappings resource type.", + "enum": [ + "authn_mappings" + ], + "example": "authn_mappings", + "type": "string", + "x-enum-varnames": [ + "AUTHN_MAPPINGS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "AuthNMappingCreateRelationships": { + "description": "Relationship of AuthN Mapping create object to a Role or Team.", + "oneOf": [ + { + "description": "Relationship of AuthN Mapping to a Role.", + "properties": { + "role": { + "description": "Relationship to role.", + "properties": { + "data": { + "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" ], - "type": "object" + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "role" + ], + "type": "object" + }, + { + "description": "Relationship of AuthN Mapping to a Team.", + "properties": { + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", + "properties": { + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" }, - { - "description": "Details of a CI stage.", + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "team" + ], + "type": "object" + } + ] + }, + "AuthNMappingCreateRequest": { + "description": "Request for creating an AuthN Mapping.", + "properties": { + "data": { + "description": "Data for creating an AuthN Mapping.", + "properties": { + "attributes": { + "description": "Key/Value pair of attributes used for create request.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "description": "Relationship of AuthN Mapping create object to a Role or Team.", + "oneOf": [ + { + "description": "Relationship of AuthN Mapping to a Role.", + "properties": { + "role": { + "description": "Relationship to role.", "properties": { - "dependencies": { - "description": "A list of stage IDs that this stage depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" - ], - "items": { - "description": "A list of stage IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "end": { - "description": "Time when the stage run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, + "data": { + "description": "Relationship to role object.", "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "id": { + "description": "The unique identifier of the role.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" + }, + "type": { + "default": "roles", + "description": "Roles type.", "enum": [ - "provider", - "user", - "unknown" + "roles" ], + "example": "roles", "type": "string", "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" + "ROLES" ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" } }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "id": { - "description": "UUID for the stage. It has to be unique at least in the pipeline scope.", - "example": "562bdbbb-7cab-48c8-851c-b24ca14628bf", - "type": "string" - }, - "level": { - "default": "stage", - "description": "Used to distinguish between pipelines, stages, jobs and steps.", - "enum": [ - "stage" - ], - "example": "stage", - "type": "string", - "x-enum-varnames": [ - "STAGE" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the stage.", - "example": "build", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "start": { - "description": "Time when the stage run started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the stage.", - "enum": [ - "success", - "error", - "canceled", - "skipped" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" - ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" + "type": "object", + "x-merge-override": { + "required": false + } } }, - "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status" - ], - "type": "object" - }, - { - "description": "Details of a CI job.", + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "role" + ], + "type": "object" + }, + { + "description": "Relationship of AuthN Mapping to a Team.", + "properties": { + "team": { + "description": "Relationship to team.", "properties": { - "dependencies": { - "description": "A list of job IDs that this job depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" - ], - "items": { - "description": "A list of job IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "end": { - "description": "Time when the job run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, + "data": { + "description": "Relationship to Team object.", "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", "type": "string" }, "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "id": { - "description": "The UUID for the job. It has to be unique within each pipeline execution.", - "example": "c865bad4-de82-44b8-ade7-2c987528eb54", - "type": "string" - }, - "level": { - "default": "job", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", - "enum": [ - "job" - ], - "example": "job", - "type": "string", - "x-enum-varnames": [ - "JOB" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the job.", - "example": "test", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, - "type": "string" - }, - "start": { - "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the job.", - "enum": [ - "success", - "error", - "canceled", - "skipped" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" - ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "url": { - "description": "The URL to look at the job in the CI provider UI.", - "example": "https://ci-platform.com/job/your-job-name/build/123", - "type": "string" - } - }, - "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status", - "url" - ], - "type": "object" - }, - { - "description": "Details of a CI step.", - "properties": { - "end": { - "description": "Time when the step run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "default": "team", + "description": "Team type", "enum": [ - "provider", - "user", - "unknown" + "team" ], + "example": "team", "type": "string", "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" + "TEAM" ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "id": { - "description": "UUID for the step. It has to be unique within each pipeline execution.", - "example": "c2d517a8-4f3a-4b41-b4ae-69df0c864c79", - "type": "string" - }, - "job_id": { - "description": "The parent job UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "job_name": { - "description": "The parent job name (if applicable).", - "nullable": true, - "type": "string" - }, - "level": { - "default": "step", - "description": "Used to distinguish between pipelines, stages, jobs and steps.", - "enum": [ - "step" - ], - "example": "step", - "type": "string", - "x-enum-varnames": [ - "STEP" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the step.", - "example": "test-server", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" } }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, - "type": "string" - }, - "start": { - "description": "Time when the step run started. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the step.", - "enum": [ - "success", - "error" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR" - ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "url": { - "description": "The URL to look at the step in the CI provider UI.", - "nullable": true, - "type": "string" + "type": "object", + "x-merge-override": { + "required": false + } } }, - "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status" - ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } } - ] - }, - "service": { - "description": "If the CI provider is SaaS, use this to differentiate between instances.", - "type": "string" + }, + "required": [ + "team" + ], + "type": "object" } - }, - "required": [ - "resource" - ], - "type": "object" + ] }, "type": { - "default": "cipipeline_resource_request", - "description": "Type of the event.", + "default": "authn_mappings", + "description": "AuthN Mappings resource type.", "enum": [ - "cipipeline_resource_request" + "authn_mappings" ], - "example": "cipipeline_resource_request", + "example": "authn_mappings", "type": "string", "x-enum-varnames": [ - "CIPIPELINE_RESOURCE_REQUEST" + "AUTHN_MAPPINGS" ] } }, + "required": [ + "type" + ], "type": "object" } }, + "required": [ + "data" + ], "type": "object" }, - "CIAppCreatePipelineEventRequestAttributes": { - "description": "Attributes of the pipeline event to create.", - "properties": { - "env": { - "description": "The Datadog environment.", - "type": "string" + "AuthNMappingIncluded": { + "description": "Included data in the AuthN Mapping response.", + "oneOf": [ + { + "description": "SAML assertion attribute.", + "properties": { + "attributes": { + "description": "Key/Value pair of attributes used in SAML assertion attributes.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + }, + "type": { + "default": "saml_assertion_attributes", + "description": "SAML assertion attributes resource type.", + "enum": [ + "saml_assertion_attributes" + ], + "example": "saml_assertion_attributes", + "type": "string", + "x-enum-varnames": [ + "SAML_ASSERTION_ATTRIBUTES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } }, - "resource": { - "description": "Details of the CI pipeline event.", - "example": "Details TBD", - "oneOf": [ - { - "description": "Details of the top level pipeline, build, or workflow of your CI.", + { + "description": "Role object returned by the API.", + "properties": { + "attributes": { + "description": "Attributes of the role.", "properties": { - "end": { - "description": "Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", + "created_at": { + "description": "Creation time of the role.", "format": "date-time", + "readOnly": true, "type": "string" }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, + "modified_at": { + "description": "Time of last role modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", + "type": "string" + }, + "user_count": { + "description": "Number of users with that role.", + "format": "int64", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the role.", + "type": "string" + }, + "relationships": { + "description": "Relationships of the role object returned by the API.", + "properties": { + "permissions": { + "description": "Relationship to multiple permissions objects.", "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" + "data": { + "description": "Relationships to permission objects.", + "items": { + "description": "Relationship to permission object.", + "properties": { + "id": { + "description": "ID of the permission.", + "type": "string" + }, + "type": { + "default": "permissions", + "description": "Permissions resource type.", + "enum": [ + "permissions" + ], + "example": "permissions", + "type": "string", + "x-enum-varnames": [ + "PERMISSIONS" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" } }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "is_manual": { - "description": "Whether or not the pipeline was triggered manually by the user.", - "example": false, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" + }, + "type": { + "default": "roles", + "description": "Roles type.", + "enum": [ + "roles" + ], + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } + }, + "required": [ + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + { + "description": "Team.", + "properties": { + "attributes": { + "description": "Team attributes.", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", "nullable": true, - "type": "boolean" + "type": "string" }, - "is_resumed": { - "description": "Whether or not the pipeline was resumed after being blocked.", - "example": false, + "banner": { + "description": "Banner selection for the team", + "format": "int64", "nullable": true, - "type": "boolean" + "type": "integer" }, - "level": { - "default": "pipeline", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", - "enum": [ - "pipeline" - ], - "example": "pipeline", - "type": "string", - "x-enum-varnames": [ - "PIPELINE" - ] + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" + "link_count": { + "description": "The number of links belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" }, "name": { - "description": "Name of the pipeline. All pipeline runs for the builds should have the same name.", - "example": "Deploy to AWS", + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, "type": "string" }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "parent_pipeline": { - "description": "If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.", + "summary": { + "description": "A brief summary of the team, derived from the `description`", + "maxLength": 120, "nullable": true, - "properties": { - "id": { - "description": "UUID of a pipeline.", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", - "type": "string" - }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://ci-platform.com/pipelines/123456789", - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "partial_retry": { - "description": "Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one\nwhich only runs a subset of the original jobs.", - "example": false, - "type": "boolean" - }, - "pipeline_id": { - "description": "Any ID used in the provider to identify the pipeline run even if it is not unique across retries.\nIf the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.", - "example": "#023", "type": "string" }, - "previous_attempt": { - "description": "If the pipeline is a retry, this should contain the details of the previous attempt.", - "nullable": true, - "properties": { - "id": { - "description": "UUID of a pipeline.", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", - "type": "string" - }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://ci-platform.com/pipelines/123456789", - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, + "user_count": { + "description": "The number of users belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, "type": "integer" - }, - "start": { - "description": "Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the Team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object" + } + ] + }, + "AuthNMappingRelationshipToRole": { + "description": "Relationship of AuthN Mapping to a Role.", + "properties": { + "role": { + "description": "Relationship to role.", + "properties": { + "data": { + "description": "Relationship to role object.", + "properties": { + "id": { + "description": "The unique identifier of the role.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", "type": "string" }, - "status": { - "description": "The final status of the pipeline.", + "type": { + "default": "roles", + "description": "Roles type.", "enum": [ - "success", - "error", - "canceled", - "skipped", - "blocked" + "roles" ], - "example": "success", + "example": "roles", "type": "string", "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED", - "BLOCKED" + "ROLES" ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "unique_id": { - "description": "UUID of the pipeline run. The ID has to be unique across retries and pipelines,\nincluding partial retries.", - "example": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", - "type": "string" - }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://my-ci-provider.example/pipelines/my-pipeline/run/1", - "type": "string" } }, - "required": [ - "level", - "unique_id", - "name", - "url", - "start", - "end", - "status", - "partial_retry" - ], - "type": "object" - }, - { - "description": "Details of a CI stage.", + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "role" + ], + "type": "object" + }, + "AuthNMappingRelationshipToTeam": { + "description": "Relationship of AuthN Mapping to a Team.", + "properties": { + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", "properties": { - "dependencies": { - "description": "A list of stage IDs that this stage depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" - ], - "items": { - "description": "A list of stage IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "end": { - "description": "Time when the stage run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", "type": "string" }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" ], - "type": "object" - }, + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "team" + ], + "type": "object" + }, + "AuthNMappingRelationships": { + "description": "All relationships associated with AuthN Mapping.", + "properties": { + "role": { + "description": "Relationship to role.", + "properties": { + "data": { + "description": "Relationship to role object.", + "properties": { "id": { - "description": "UUID for the stage. It has to be unique at least in the pipeline scope.", - "example": "562bdbbb-7cab-48c8-851c-b24ca14628bf", + "description": "The unique identifier of the role.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", "type": "string" }, - "level": { - "default": "stage", - "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "type": { + "default": "roles", + "description": "Roles type.", "enum": [ - "stage" + "roles" ], - "example": "stage", + "example": "roles", "type": "string", "x-enum-varnames": [ - "STAGE" + "ROLES" ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the stage.", - "example": "build", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "start": { - "description": "Time when the stage run started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "saml_assertion_attribute": { + "description": "AuthN Mapping relationship to SAML Assertion Attribute.", + "properties": { + "data": { + "description": "Data of AuthN Mapping relationship to SAML Assertion Attribute.", + "properties": { + "id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", "type": "string" }, - "status": { - "description": "The final status of the stage.", + "type": { + "default": "saml_assertion_attributes", + "description": "SAML assertion attributes resource type.", "enum": [ - "success", - "error", - "canceled", - "skipped" + "saml_assertion_attributes" ], - "example": "success", + "example": "saml_assertion_attributes", "type": "string", "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" + "SAML_ASSERTION_ATTRIBUTES" ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" } }, "required": [ - "level", "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status" + "type" ], - "type": "object" - }, - { - "description": "Details of a CI job.", + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", "properties": { - "dependencies": { - "description": "A list of job IDs that this job depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" ], - "items": { - "description": "A list of job IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" + }, + "AuthNMappingResourceType": { + "description": "The type of resource being mapped to.", + "enum": [ + "role", + "team" + ], + "type": "string", + "x-enum-varnames": [ + "ROLE", + "TEAM" + ] + }, + "AuthNMappingResponse": { + "description": "AuthN Mapping response from the API.", + "properties": { + "data": { + "description": "The AuthN Mapping object returned by API.", + "properties": { + "attributes": { + "description": "Attributes of AuthN Mapping.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" }, - "end": { - "description": "Time when the job run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + }, + "created_at": { + "description": "Creation time of the AuthN Mapping.", "format": "date-time", + "readOnly": true, "type": "string" }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, + "modified_at": { + "description": "Time of last AuthN Mapping modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "saml_assertion_attribute_id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the AuthN Mapping.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" + }, + "relationships": { + "description": "All relationships associated with AuthN Mapping.", + "properties": { + "role": { + "description": "Relationship to role.", "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" + "data": { + "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": "object" + "type": "object", + "x-merge-override": { + "required": false + } }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, + "saml_assertion_attribute": { + "description": "AuthN Mapping relationship to SAML Assertion Attribute.", "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" + "data": { + "description": "Data of AuthN Mapping relationship to SAML Assertion Attribute.", + "properties": { + "id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + }, + "type": { + "default": "saml_assertion_attributes", + "description": "SAML assertion attributes resource type.", + "enum": [ + "saml_assertion_attributes" + ], + "example": "saml_assertion_attributes", + "type": "string", + "x-enum-varnames": [ + "SAML_ASSERTION_ATTRIBUTES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } } }, "required": [ - "repository_url", - "sha", - "author_email" + "data" ], "type": "object" }, - "id": { - "description": "The UUID for the job. It has to be unique within each pipeline execution.", - "example": "c865bad4-de82-44b8-ade7-2c987528eb54", - "type": "string" - }, - "level": { - "default": "job", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", - "enum": [ - "job" - ], - "example": "job", - "type": "string", - "x-enum-varnames": [ - "JOB" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", + "properties": { + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" + }, + "type": { + "default": "authn_mappings", + "description": "AuthN Mappings resource type.", + "enum": [ + "authn_mappings" + ], + "example": "authn_mappings", + "type": "string", + "x-enum-varnames": [ + "AUTHN_MAPPINGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "included": { + "description": "Included data in the AuthN Mapping response.", + "items": { + "description": "Included data in the AuthN Mapping response.", + "oneOf": [ + { + "description": "SAML assertion attribute.", + "properties": { + "attributes": { + "description": "Key/Value pair of attributes used in SAML assertion attributes.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", "type": "string" }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the job.", - "example": "test", - "type": "string" + "type": { + "default": "saml_assertion_attributes", + "description": "SAML assertion attributes resource type.", + "enum": [ + "saml_assertion_attributes" + ], + "example": "saml_assertion_attributes", + "type": "string", + "x-enum-varnames": [ + "SAML_ASSERTION_ATTRIBUTES" + ] + } }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + { + "description": "Role object returned by the API.", + "properties": { + "attributes": { + "description": "Attributes of the role.", + "properties": { + "created_at": { + "description": "Creation time of the role.", + "format": "date-time", + "readOnly": true, "type": "string" }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" + "modified_at": { + "description": "Time of last role modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", + "type": "string" + }, + "user_count": { + "description": "Number of users with that role.", + "format": "int64", + "readOnly": true, + "type": "integer" + } }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } + "type": "object" }, - "type": "object" - }, - "parameters": { - "additionalProperties": { + "id": { + "description": "The unique identifier of the role.", "type": "string" }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" + "relationships": { + "description": "Relationships of the role object returned by the API.", + "properties": { + "permissions": { + "description": "Relationship to multiple permissions objects.", + "properties": { + "data": { + "description": "Relationships to permission objects.", + "items": { + "description": "Relationship to permission object.", + "properties": { + "id": { + "description": "ID of the permission.", + "type": "string" + }, + "type": { + "default": "permissions", + "description": "Permissions resource type.", + "enum": [ + "permissions" + ], + "example": "permissions", + "type": "string", + "x-enum-varnames": [ + "PERMISSIONS" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, - "type": "string" - }, - "start": { - "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the job.", - "enum": [ - "success", - "error", - "canceled", - "skipped" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" - ] + "type": { + "default": "roles", + "description": "Roles type.", + "enum": [ + "roles" + ], + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", + "required": [ + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + { + "description": "Team.", + "properties": { + "attributes": { + "description": "Team attributes.", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", + "nullable": true, + "type": "string" + }, + "banner": { + "description": "Banner selection for the team", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" + }, + "link_count": { + "description": "The number of links belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + }, + "name": { + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from the `description`", + "maxLength": 120, + "nullable": true, + "type": "string" + }, + "user_count": { + "description": "The number of users belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the Team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", "type": "string" }, - "nullable": true, - "type": "array" + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } }, - "url": { - "description": "The URL to look at the job in the CI provider UI.", - "example": "https://ci-platform.com/job/your-job-name/build/123", - "type": "string" + "type": "object" + } + ] + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthNMappingTeam": { + "description": "Team.", + "properties": { + "attributes": { + "description": "Team attributes.", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", + "nullable": true, + "type": "string" + }, + "banner": { + "description": "Banner selection for the team", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" + }, + "link_count": { + "description": "The number of links belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + }, + "name": { + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from the `description`", + "maxLength": 120, + "nullable": true, + "type": "string" + }, + "user_count": { + "description": "The number of users belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the Team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object" + }, + "AuthNMappingTeamAttributes": { + "description": "Team attributes.", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", + "nullable": true, + "type": "string" + }, + "banner": { + "description": "Banner selection for the team", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" + }, + "link_count": { + "description": "The number of links belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + }, + "name": { + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from the `description`", + "maxLength": 120, + "nullable": true, + "type": "string" + }, + "user_count": { + "description": "The number of users belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "AuthNMappingUpdateAttributes": { + "description": "Key/Value pair of attributes used for update request.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + } + }, + "type": "object" + }, + "AuthNMappingUpdateData": { + "description": "Data for updating an AuthN Mapping.", + "properties": { + "attributes": { + "description": "Key/Value pair of attributes used for update request.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the AuthN Mapping.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" + }, + "relationships": { + "description": "Relationship of AuthN Mapping update object to a Role or Team.", + "oneOf": [ + { + "description": "Relationship of AuthN Mapping to a Role.", + "properties": { + "role": { + "description": "Relationship to role.", + "properties": { + "data": { + "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": "object", + "x-merge-override": { + "required": false + } } }, "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status", - "url" + "role" ], "type": "object" }, { - "description": "Details of a CI step.", + "description": "Relationship of AuthN Mapping to a Team.", "properties": { - "end": { - "description": "Time when the step run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "id": { - "description": "UUID for the step. It has to be unique within each pipeline execution.", - "example": "c2d517a8-4f3a-4b41-b4ae-69df0c864c79", - "type": "string" - }, - "job_id": { - "description": "The parent job UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "job_name": { - "description": "The parent job name (if applicable).", - "nullable": true, - "type": "string" - }, - "level": { - "default": "step", - "description": "Used to distinguish between pipelines, stages, jobs and steps.", - "enum": [ - "step" - ], - "example": "step", - "type": "string", - "x-enum-varnames": [ - "STEP" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the step.", - "example": "test-server", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, + "team": { + "description": "Relationship to team.", "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" + "data": { + "description": "Relationship to Team object.", + "properties": { + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" + "type": "object", + "x-merge-override": { + "required": false + } } }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, - "type": "string" - }, - "start": { - "description": "Time when the step run started. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the step.", - "enum": [ - "success", - "error" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR" - ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "url": { - "description": "The URL to look at the step in the CI provider UI.", - "nullable": true, - "type": "string" + "type": "object", + "x-merge-override": { + "required": false + } } }, "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status" + "team" ], "type": "object" } ] }, - "service": { - "description": "If the CI provider is SaaS, use this to differentiate between instances.", - "type": "string" + "type": { + "default": "authn_mappings", + "description": "AuthN Mappings resource type.", + "enum": [ + "authn_mappings" + ], + "example": "authn_mappings", + "type": "string", + "x-enum-varnames": [ + "AUTHN_MAPPINGS" + ] } }, "required": [ - "resource" + "id", + "type" ], "type": "object" }, - "CIAppCreatePipelineEventRequestAttributesResource": { - "description": "Details of the CI pipeline event.", - "example": "Details TBD", + "AuthNMappingUpdateRelationships": { + "description": "Relationship of AuthN Mapping update object to a Role or Team.", "oneOf": [ { - "description": "Details of the top level pipeline, build, or workflow of your CI.", + "description": "Relationship of AuthN Mapping to a Role.", "properties": { - "end": { - "description": "Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, + "role": { + "description": "Relationship to role.", "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" + "data": { + "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": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "role" + ], + "type": "object" + }, + { + "description": "Relationship of AuthN Mapping to a Team.", + "properties": { + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", + "properties": { + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "team" + ], + "type": "object" + } + ] + }, + "AuthNMappingUpdateRequest": { + "description": "Request to update an AuthN Mapping.", + "properties": { + "data": { + "description": "Data for updating an AuthN Mapping.", + "properties": { + "attributes": { + "description": "Key/Value pair of attributes used for update request.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", "type": "string" }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", "type": "string" } }, - "required": [ - "repository_url", - "sha", - "author_email" - ], "type": "object" }, - "is_manual": { - "description": "Whether or not the pipeline was triggered manually by the user.", - "example": false, - "nullable": true, - "type": "boolean" + "id": { + "description": "ID of the AuthN Mapping.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" }, - "is_resumed": { - "description": "Whether or not the pipeline was resumed after being blocked.", - "example": false, - "nullable": true, - "type": "boolean" + "relationships": { + "description": "Relationship of AuthN Mapping update object to a Role or Team.", + "oneOf": [ + { + "description": "Relationship of AuthN Mapping to a Role.", + "properties": { + "role": { + "description": "Relationship to role.", + "properties": { + "data": { + "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": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "role" + ], + "type": "object" + }, + { + "description": "Relationship of AuthN Mapping to a Team.", + "properties": { + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", + "properties": { + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "team" + ], + "type": "object" + } + ] }, - "level": { - "default": "pipeline", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "type": { + "default": "authn_mappings", + "description": "AuthN Mappings resource type.", "enum": [ - "pipeline" + "authn_mappings" ], - "example": "pipeline", + "example": "authn_mappings", "type": "string", "x-enum-varnames": [ - "PIPELINE" + "AUTHN_MAPPINGS" ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "Name of the pipeline. All pipeline runs for the builds should have the same name.", - "example": "Deploy to AWS", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "AuthNMappingsResponse": { + "description": "Array of AuthN Mappings response.", + "properties": { + "data": { + "description": "Array of returned AuthN Mappings.", + "items": { + "description": "The AuthN Mapping object returned by API.", + "properties": { + "attributes": { + "description": "Attributes of AuthN Mapping.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", "type": "string" }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + }, + "created_at": { + "description": "Creation time of the AuthN Mapping.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_at": { + "description": "Time of last AuthN Mapping modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "saml_assertion_attribute_id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + } }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } + "type": "object" }, - "type": "object" - }, - "parameters": { - "additionalProperties": { + "id": { + "description": "ID of the AuthN Mapping.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", "type": "string" }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" + "relationships": { + "description": "All relationships associated with AuthN Mapping.", + "properties": { + "role": { + "description": "Relationship to role.", + "properties": { + "data": { + "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": "object", + "x-merge-override": { + "required": false + } + }, + "saml_assertion_attribute": { + "description": "AuthN Mapping relationship to SAML Assertion Attribute.", + "properties": { + "data": { + "description": "Data of AuthN Mapping relationship to SAML Assertion Attribute.", + "properties": { + "id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + }, + "type": { + "default": "saml_assertion_attributes", + "description": "SAML assertion attributes resource type.", + "enum": [ + "saml_assertion_attributes" + ], + "example": "saml_assertion_attributes", + "type": "string", + "x-enum-varnames": [ + "SAML_ASSERTION_ATTRIBUTES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", + "properties": { + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" }, - "nullable": true, - "type": "object" + "type": { + "default": "authn_mappings", + "description": "AuthN Mappings resource type.", + "enum": [ + "authn_mappings" + ], + "example": "authn_mappings", + "type": "string", + "x-enum-varnames": [ + "AUTHN_MAPPINGS" + ] + } }, - "parent_pipeline": { - "description": "If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.", - "nullable": true, - "properties": { - "id": { - "description": "UUID of a pipeline.", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", - "type": "string" + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + }, + "included": { + "description": "Included data in the AuthN Mapping response.", + "items": { + "description": "Included data in the AuthN Mapping response.", + "oneOf": [ + { + "description": "SAML assertion attribute.", + "properties": { + "attributes": { + "description": "Key/Value pair of attributes used in SAML assertion attributes.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + }, + "type": { + "default": "saml_assertion_attributes", + "description": "SAML assertion attributes resource type.", + "enum": [ + "saml_assertion_attributes" + ], + "example": "saml_assertion_attributes", + "type": "string", + "x-enum-varnames": [ + "SAML_ASSERTION_ATTRIBUTES" + ] + } }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://ci-platform.com/pipelines/123456789", - "type": "string" + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false } }, - "required": [ - "id" - ], - "type": "object" - }, - "partial_retry": { - "description": "Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one\nwhich only runs a subset of the original jobs.", - "example": false, - "type": "boolean" - }, - "pipeline_id": { - "description": "Any ID used in the provider to identify the pipeline run even if it is not unique across retries.\nIf the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.", - "example": "#023", - "type": "string" - }, - "previous_attempt": { - "description": "If the pipeline is a retry, this should contain the details of the previous attempt.", - "nullable": true, + { + "description": "Role object returned by the API.", + "properties": { + "attributes": { + "description": "Attributes of the role.", + "properties": { + "created_at": { + "description": "Creation time of the role.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_at": { + "description": "Time of last role modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", + "type": "string" + }, + "user_count": { + "description": "Number of users with that role.", + "format": "int64", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the role.", + "type": "string" + }, + "relationships": { + "description": "Relationships of the role object returned by the API.", + "properties": { + "permissions": { + "description": "Relationship to multiple permissions objects.", + "properties": { + "data": { + "description": "Relationships to permission objects.", + "items": { + "description": "Relationship to permission object.", + "properties": { + "id": { + "description": "ID of the permission.", + "type": "string" + }, + "type": { + "default": "permissions", + "description": "Permissions resource type.", + "enum": [ + "permissions" + ], + "example": "permissions", + "type": "string", + "x-enum-varnames": [ + "PERMISSIONS" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" + }, + "type": { + "default": "roles", + "description": "Roles type.", + "enum": [ + "roles" + ], + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } + }, + "required": [ + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + { + "description": "Team.", + "properties": { + "attributes": { + "description": "Team attributes.", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", + "nullable": true, + "type": "string" + }, + "banner": { + "description": "Banner selection for the team", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" + }, + "link_count": { + "description": "The number of links belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + }, + "name": { + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from the `description`", + "maxLength": 120, + "nullable": true, + "type": "string" + }, + "user_count": { + "description": "The number of users belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the Team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object" + } + ] + }, + "type": "array" + }, + "meta": { + "description": "Object describing meta attributes of response.", + "properties": { + "page": { + "description": "Pagination object.", "properties": { - "id": { - "description": "UUID of a pipeline.", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", - "type": "string" + "total_count": { + "description": "Total count.", + "format": "int64", + "type": "integer" }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://ci-platform.com/pipelines/123456789", - "type": "string" + "total_filtered_count": { + "description": "Total count of elements matched by the filter.", + "format": "int64", + "type": "integer" } }, - "required": [ - "id" - ], "type": "object" + } + }, + "type": "object", + "x-merge-override": { + "properties": false + } + } + }, + "type": "object" + }, + "AuthNMappingsSort": { + "description": "Sorting options for AuthN Mappings.", + "enum": [ + "created_at", + "-created_at", + "role_id", + "-role_id", + "saml_assertion_attribute_id", + "-saml_assertion_attribute_id", + "role.name", + "-role.name", + "saml_assertion_attribute.attribute_key", + "-saml_assertion_attribute.attribute_key", + "saml_assertion_attribute.attribute_value", + "-saml_assertion_attribute.attribute_value" + ], + "type": "string", + "x-enum-varnames": [ + "CREATED_AT_ASCENDING", + "CREATED_AT_DESCENDING", + "ROLE_ID_ASCENDING", + "ROLE_ID_DESCENDING", + "SAML_ASSERTION_ATTRIBUTE_ID_ASCENDING", + "SAML_ASSERTION_ATTRIBUTE_ID_DESCENDING", + "ROLE_NAME_ASCENDING", + "ROLE_NAME_DESCENDING", + "SAML_ASSERTION_ATTRIBUTE_KEY_ASCENDING", + "SAML_ASSERTION_ATTRIBUTE_KEY_DESCENDING", + "SAML_ASSERTION_ATTRIBUTE_VALUE_ASCENDING", + "SAML_ASSERTION_ATTRIBUTE_VALUE_DESCENDING" + ] + }, + "AuthNMappingsType": { + "default": "authn_mappings", + "description": "AuthN Mappings resource type.", + "enum": [ + "authn_mappings" + ], + "example": "authn_mappings", + "type": "string", + "x-enum-varnames": [ + "AUTHN_MAPPINGS" + ] + }, + "AwsCURConfig": { + "description": "AWS CUR config.", + "properties": { + "attributes": { + "description": "Attributes for An AWS CUR config.", + "properties": { + "account_id": { + "description": "The AWS account ID.", + "example": "123456789123", + "type": "string" }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" + "bucket_name": { + "description": "The AWS bucket name used to store the Cost and Usage Report.", + "example": "dd-cost-bucket", + "type": "string" }, - "start": { - "description": "Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + "bucket_region": { + "description": "The region the bucket is located in.", + "example": "us-east-1", "type": "string" }, - "status": { - "description": "The final status of the pipeline.", - "enum": [ - "success", - "error", - "canceled", - "skipped", - "blocked" - ], - "example": "success", + "created_at": { + "description": "The timestamp when the AWS CUR config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED", - "BLOCKED" - ] + "x-merge-override": { + "format": false + } }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], + "error_messages": { + "description": "The error messages for the AWS CUR config.", "items": { - "description": "Tags in the form of `key:value`.", "type": "string" }, - "nullable": true, "type": "array" }, - "unique_id": { - "description": "UUID of the pipeline run. The ID has to be unique across retries and pipelines,\nincluding partial retries.", - "example": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" + }, + "report_name": { + "description": "The name of the Cost and Usage Report.", + "example": "dd-report-name", "type": "string" }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://my-ci-provider.example/pipelines/my-pipeline/run/1", + "report_prefix": { + "description": "The report prefix used for the Cost and Usage Report.", + "example": "dd-report-prefix", + "type": "string" + }, + "status": { + "description": "The status of the AWS CUR.", + "example": "active", "type": "string" + }, + "status_updated_at": { + "description": "The timestamp when the AWS CUR config status was updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "updated_at": { + "description": "The timestamp when the AWS CUR config status was updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } } }, "required": [ - "level", - "unique_id", - "name", - "url", - "start", - "end", - "status", - "partial_retry" + "account_id", + "bucket_name", + "bucket_region", + "report_name", + "report_prefix", + "status" ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } }, - { - "description": "Details of a CI stage.", - "properties": { - "dependencies": { - "description": "A list of stage IDs that this stage depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" - ], - "items": { - "description": "A list of stage IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "end": { - "description": "Time when the stage run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" + "id": { + "description": "The ID of the AWS CUR config.", + "format": "int64", + "type": "integer" + }, + "type": { + "default": "aws_cur_config", + "description": "Type of AWS CUR config.", + "enum": [ + "aws_cur_config" + ], + "example": "aws_cur_config", + "type": "string", + "x-enum-varnames": [ + "AWS_CUR_CONFIG" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "AwsCURConfigAttributes": { + "description": "Attributes for An AWS CUR config.", + "properties": { + "account_id": { + "description": "The AWS account ID.", + "example": "123456789123", + "type": "string" + }, + "bucket_name": { + "description": "The AWS bucket name used to store the Cost and Usage Report.", + "example": "dd-cost-bucket", + "type": "string" + }, + "bucket_region": { + "description": "The region the bucket is located in.", + "example": "us-east-1", + "type": "string" + }, + "created_at": { + "description": "The timestamp when the AWS CUR config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "error_messages": { + "description": "The error messages for the AWS CUR config.", + "items": { + "type": "string" + }, + "type": "array" + }, + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" + }, + "report_name": { + "description": "The name of the Cost and Usage Report.", + "example": "dd-report-name", + "type": "string" + }, + "report_prefix": { + "description": "The report prefix used for the Cost and Usage Report.", + "example": "dd-report-prefix", + "type": "string" + }, + "status": { + "description": "The status of the AWS CUR.", + "example": "active", + "type": "string" + }, + "status_updated_at": { + "description": "The timestamp when the AWS CUR config status was updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "updated_at": { + "description": "The timestamp when the AWS CUR config status was updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + } + }, + "required": [ + "account_id", + "bucket_name", + "bucket_region", + "report_name", + "report_prefix", + "status" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "AwsCURConfigPatchData": { + "description": "AWS CUR config Patch data.", + "properties": { + "attributes": { + "description": "Attributes for AWS CUR config Patch Request.", + "properties": { + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "example": true, + "type": "boolean" + } + }, + "required": [ + "is_enabled" + ], + "type": "object" + }, + "type": { + "default": "aws_cur_config_patch_request", + "description": "Type of AWS CUR config Patch Request.", + "enum": [ + "aws_cur_config_patch_request" + ], + "example": "aws_cur_config_patch_request", + "type": "string", + "x-enum-varnames": [ + "AWS_CUR_CONFIG_PATCH_REQUEST" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "AwsCURConfigPatchRequest": { + "description": "AWS CUR config Patch Request.", + "properties": { + "data": { + "description": "AWS CUR config Patch data.", + "properties": { + "attributes": { + "description": "Attributes for AWS CUR config Patch Request.", + "properties": { + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "example": true, + "type": "boolean" } }, "required": [ - "repository_url", - "sha", - "author_email" + "is_enabled" ], "type": "object" }, - "id": { - "description": "UUID for the stage. It has to be unique at least in the pipeline scope.", - "example": "562bdbbb-7cab-48c8-851c-b24ca14628bf", - "type": "string" - }, - "level": { - "default": "stage", - "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "type": { + "default": "aws_cur_config_patch_request", + "description": "Type of AWS CUR config Patch Request.", "enum": [ - "stage" + "aws_cur_config_patch_request" ], - "example": "stage", + "example": "aws_cur_config_patch_request", "type": "string", "x-enum-varnames": [ - "STAGE" + "AWS_CUR_CONFIG_PATCH_REQUEST" ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the stage.", - "example": "build", + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "AwsCURConfigPatchRequestAttributes": { + "description": "Attributes for AWS CUR config Patch Request.", + "properties": { + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "example": true, + "type": "boolean" + } + }, + "required": [ + "is_enabled" + ], + "type": "object" + }, + "AwsCURConfigPatchRequestType": { + "default": "aws_cur_config_patch_request", + "description": "Type of AWS CUR config Patch Request.", + "enum": [ + "aws_cur_config_patch_request" + ], + "example": "aws_cur_config_patch_request", + "type": "string", + "x-enum-varnames": [ + "AWS_CUR_CONFIG_PATCH_REQUEST" + ] + }, + "AwsCURConfigPostData": { + "description": "AWS CUR config Post data.", + "properties": { + "attributes": { + "description": "Attributes for AWS CUR config Post Request.", + "properties": { + "account_id": { + "description": "The AWS account ID.", + "example": "123456789123", "type": "string" }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", + "bucket_name": { + "description": "The AWS bucket name used to store the Cost and Usage Report.", + "example": "dd-cost-bucket", "type": "string" }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "bucket_region": { + "description": "The region the bucket is located in.", + "example": "us-east-1", "type": "string" }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "type": "boolean" + }, + "months": { + "description": "The month of the report.", + "format": "int32", + "maximum": 36, "type": "integer" }, - "start": { - "description": "Time when the stage run started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + "report_name": { + "description": "The name of the Cost and Usage Report.", + "example": "dd-report-name", "type": "string" }, - "status": { - "description": "The final status of the stage.", - "enum": [ - "success", - "error", - "canceled", - "skipped" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" - ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" + "report_prefix": { + "description": "The report prefix used for the Cost and Usage Report.", + "example": "dd-report-prefix", + "type": "string" } }, "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status" + "account_id", + "bucket_name", + "report_name", + "report_prefix" ], "type": "object" }, - { - "description": "Details of a CI job.", + "type": { + "default": "aws_cur_config_post_request", + "description": "Type of AWS CUR config Post Request.", + "enum": [ + "aws_cur_config_post_request" + ], + "example": "aws_cur_config_post_request", + "type": "string", + "x-enum-varnames": [ + "AWS_CUR_CONFIG_POST_REQUEST" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "AwsCURConfigPostRequest": { + "description": "AWS CUR config Post Request.", + "properties": { + "data": { + "description": "AWS CUR config Post data.", "properties": { - "dependencies": { - "description": "A list of job IDs that this job depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" - ], - "items": { - "description": "A list of job IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "end": { - "description": "Time when the job run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, + "attributes": { + "description": "Attributes for AWS CUR config Post Request.", "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, + "account_id": { + "description": "The AWS account ID.", + "example": "123456789123", "type": "string" }, - "committer_name": { - "description": "The committer name.", - "nullable": true, + "bucket_name": { + "description": "The AWS bucket name used to store the Cost and Usage Report.", + "example": "dd-cost-bucket", "type": "string" }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, + "bucket_region": { + "description": "The region the bucket is located in.", + "example": "us-east-1", "type": "string" }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "type": "boolean" }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" + "months": { + "description": "The month of the report.", + "format": "int32", + "maximum": 36, + "type": "integer" }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", + "report_name": { + "description": "The name of the Cost and Usage Report.", + "example": "dd-report-name", "type": "string" }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, + "report_prefix": { + "description": "The report prefix used for the Cost and Usage Report.", + "example": "dd-report-prefix", "type": "string" } }, "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "id": { - "description": "The UUID for the job. It has to be unique within each pipeline execution.", - "example": "c865bad4-de82-44b8-ade7-2c987528eb54", - "type": "string" - }, - "level": { - "default": "job", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", - "enum": [ - "job" - ], - "example": "job", - "type": "string", - "x-enum-varnames": [ - "JOB" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" + "account_id", + "bucket_name", + "report_name", + "report_prefix" ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the job.", - "example": "test", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, "type": "object" }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, - "type": "string" - }, - "start": { - "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the job.", + "type": { + "default": "aws_cur_config_post_request", + "description": "Type of AWS CUR config Post Request.", "enum": [ - "success", - "error", - "canceled", - "skipped" + "aws_cur_config_post_request" ], - "example": "success", + "example": "aws_cur_config_post_request", "type": "string", "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" + "AWS_CUR_CONFIG_POST_REQUEST" ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "url": { - "description": "The URL to look at the job in the CI provider UI.", - "example": "https://ci-platform.com/job/your-job-name/build/123", - "type": "string" } }, "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status", - "url" + "attributes", + "type" ], "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "AwsCURConfigPostRequestAttributes": { + "description": "Attributes for AWS CUR config Post Request.", + "properties": { + "account_id": { + "description": "The AWS account ID.", + "example": "123456789123", + "type": "string" }, - { - "description": "Details of a CI step.", + "bucket_name": { + "description": "The AWS bucket name used to store the Cost and Usage Report.", + "example": "dd-cost-bucket", + "type": "string" + }, + "bucket_region": { + "description": "The region the bucket is located in.", + "example": "us-east-1", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "type": "boolean" + }, + "months": { + "description": "The month of the report.", + "format": "int32", + "maximum": 36, + "type": "integer" + }, + "report_name": { + "description": "The name of the Cost and Usage Report.", + "example": "dd-report-name", + "type": "string" + }, + "report_prefix": { + "description": "The report prefix used for the Cost and Usage Report.", + "example": "dd-report-prefix", + "type": "string" + } + }, + "required": [ + "account_id", + "bucket_name", + "report_name", + "report_prefix" + ], + "type": "object" + }, + "AwsCURConfigPostRequestType": { + "default": "aws_cur_config_post_request", + "description": "Type of AWS CUR config Post Request.", + "enum": [ + "aws_cur_config_post_request" + ], + "example": "aws_cur_config_post_request", + "type": "string", + "x-enum-varnames": [ + "AWS_CUR_CONFIG_POST_REQUEST" + ] + }, + "AwsCURConfigResponse": { + "description": "Response of AWS CUR config.", + "properties": { + "data": { + "description": "AWS CUR config.", "properties": { - "end": { - "description": "Time when the step run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, + "attributes": { + "description": "Attributes for An AWS CUR config.", "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, + "account_id": { + "description": "The AWS account ID.", + "example": "123456789123", "type": "string" }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, + "bucket_name": { + "description": "The AWS bucket name used to store the Cost and Usage Report.", + "example": "dd-cost-bucket", "type": "string" }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, + "bucket_region": { + "description": "The region the bucket is located in.", + "example": "us-east-1", "type": "string" }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" + "created_at": { + "description": "The timestamp when the AWS CUR config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" + "error_messages": { + "description": "The error messages for the AWS CUR config.", + "items": { + "type": "string" + }, + "type": "array" }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, + "report_name": { + "description": "The name of the Cost and Usage Report.", + "example": "dd-report-name", "type": "string" }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, + "report_prefix": { + "description": "The report prefix used for the Cost and Usage Report.", + "example": "dd-report-prefix", "type": "string" }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", + "status": { + "description": "The status of the AWS CUR.", + "example": "active", "type": "string" }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" + "status_updated_at": { + "description": "The timestamp when the AWS CUR config status was updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" + "updated_at": { + "description": "The timestamp when the AWS CUR config status was updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } } }, "required": [ - "repository_url", - "sha", - "author_email" + "account_id", + "bucket_name", + "bucket_region", + "report_name", + "report_prefix", + "status" ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } }, "id": { - "description": "UUID for the step. It has to be unique within each pipeline execution.", - "example": "c2d517a8-4f3a-4b41-b4ae-69df0c864c79", - "type": "string" - }, - "job_id": { - "description": "The parent job UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "job_name": { - "description": "The parent job name (if applicable).", - "nullable": true, - "type": "string" + "description": "The ID of the AWS CUR config.", + "format": "int64", + "type": "integer" }, - "level": { - "default": "step", - "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "type": { + "default": "aws_cur_config", + "description": "Type of AWS CUR config.", "enum": [ - "step" + "aws_cur_config" ], - "example": "step", + "example": "aws_cur_config", "type": "string", "x-enum-varnames": [ - "STEP" + "AWS_CUR_CONFIG" ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" + }, + "AwsCURConfigType": { + "default": "aws_cur_config", + "description": "Type of AWS CUR config.", + "enum": [ + "aws_cur_config" + ], + "example": "aws_cur_config", + "type": "string", + "x-enum-varnames": [ + "AWS_CUR_CONFIG" + ] + }, + "AwsCURConfigsResponse": { + "description": "List of AWS CUR configs.", + "properties": { + "data": { + "description": "An AWS CUR config.", + "items": { + "description": "AWS CUR config.", + "properties": { + "attributes": { + "description": "Attributes for An AWS CUR config.", + "properties": { + "account_id": { + "description": "The AWS account ID.", + "example": "123456789123", + "type": "string" + }, + "bucket_name": { + "description": "The AWS bucket name used to store the Cost and Usage Report.", + "example": "dd-cost-bucket", + "type": "string" + }, + "bucket_region": { + "description": "The region the bucket is located in.", + "example": "us-east-1", + "type": "string" + }, + "created_at": { + "description": "The timestamp when the AWS CUR config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "error_messages": { + "description": "The error messages for the AWS CUR config.", + "items": { + "type": "string" + }, + "type": "array" + }, + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" + }, + "report_name": { + "description": "The name of the Cost and Usage Report.", + "example": "dd-report-name", + "type": "string" + }, + "report_prefix": { + "description": "The report prefix used for the Cost and Usage Report.", + "example": "dd-report-prefix", + "type": "string" + }, + "status": { + "description": "The status of the AWS CUR.", + "example": "active", + "type": "string" + }, + "status_updated_at": { + "description": "The timestamp when the AWS CUR config status was updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "updated_at": { + "description": "The timestamp when the AWS CUR config status was updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + } + }, + "required": [ + "account_id", + "bucket_name", + "bucket_region", + "report_name", + "report_prefix", + "status" + ], + "type": "object", + "x-merge-override": { + "required": false + } }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the step.", - "example": "test-server", - "type": "string" + "id": { + "description": "The ID of the AWS CUR config.", + "format": "int64", + "type": "integer" + }, + "type": { + "default": "aws_cur_config", + "description": "Type of AWS CUR config.", + "enum": [ + "aws_cur_config" + ], + "example": "aws_cur_config", + "type": "string", + "x-enum-varnames": [ + "AWS_CUR_CONFIG" + ] + } }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { + "required": [ + "attributes", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "type": "object" + }, + "AzureUCConfig": { + "description": "Azure config.", + "properties": { + "account_id": { + "description": "The tenant ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "client_id": { + "description": "The client ID of the Azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "created_at": { + "description": "The timestamp when the Azure config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "dataset_type": { + "description": "The dataset type of the Azure config.", + "example": "actual", + "type": "string" + }, + "error_messages": { + "description": "The error messages for the Azure config.", + "items": { + "type": "string" + }, + "type": "array" + }, + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" + }, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "id": { + "description": "The ID of the Azure config.", + "format": "int64", + "type": "integer" + }, + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" + }, + "scope": { + "description": "The scope of your observed subscription.", + "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "status": { + "description": "The status of the Azure config.", + "example": "active", + "type": "string" + }, + "status_updated_at": { + "description": "The timestamp when the Azure config status was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + }, + "updated_at": { + "description": "The timestamp when the Azure config was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + } + }, + "required": [ + "account_id", + "client_id", + "dataset_type", + "export_name", + "export_path", + "scope", + "status", + "storage_account", + "storage_container" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "AzureUCConfigPair": { + "description": "Azure config pair.", + "properties": { + "attributes": { + "description": "Attributes for Azure config pair.", + "properties": { + "configs": { + "description": "An Azure config.", + "items": { + "description": "Azure config.", + "properties": { + "account_id": { + "description": "The tenant ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", "type": "string" }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" + "client_id": { + "description": "The client ID of the Azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "created_at": { + "description": "The timestamp when the Azure config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "dataset_type": { + "description": "The dataset type of the Azure config.", + "example": "actual", + "type": "string" + }, + "error_messages": { + "description": "The error messages for the Azure config.", + "items": { + "type": "string" + }, + "type": "array" + }, + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" + }, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "id": { + "description": "The ID of the Azure config.", + "format": "int64", + "type": "integer" + }, + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" + }, + "scope": { + "description": "The scope of your observed subscription.", + "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "status": { + "description": "The status of the Azure config.", + "example": "active", + "type": "string" + }, + "status_updated_at": { + "description": "The timestamp when the Azure config status was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + }, + "updated_at": { + "description": "The timestamp when the Azure config was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + } }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" + "required": [ + "account_id", + "client_id", + "dataset_type", + "export_name", + "export_path", + "scope", + "status", + "storage_account", + "storage_container" + ], + "type": "object", + "x-merge-override": { + "required": false } }, - "type": "object" + "type": "array" }, - "parameters": { - "additionalProperties": { + "id": { + "description": "The ID of the Azure config pair.", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "configs" + ], + "type": "object", + "x-merge-override": { + "properties": false + } + }, + "id": { + "description": "The ID of Cloud Cost Management account.", + "format": "int64", + "type": "integer" + }, + "type": { + "default": "azure_uc_configs", + "description": "Type of Azure config pair.", + "enum": [ + "azure_uc_configs" + ], + "example": "azure_uc_configs", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIGS" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "AzureUCConfigPairAttributes": { + "description": "Attributes for Azure config pair.", + "properties": { + "configs": { + "description": "An Azure config.", + "items": { + "description": "Azure config.", + "properties": { + "account_id": { + "description": "The tenant ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", "type": "string" }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" + "client_id": { + "description": "The client ID of the Azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, - "type": "string" - }, - "start": { - "description": "Time when the step run started. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the step.", - "enum": [ - "success", - "error" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR" - ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", + "created_at": { + "description": "The timestamp when the Azure config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "dataset_type": { + "description": "The dataset type of the Azure config.", + "example": "actual", "type": "string" }, - "nullable": true, - "type": "array" + "error_messages": { + "description": "The error messages for the Azure config.", + "items": { + "type": "string" + }, + "type": "array" + }, + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" + }, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "id": { + "description": "The ID of the Azure config.", + "format": "int64", + "type": "integer" + }, + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" + }, + "scope": { + "description": "The scope of your observed subscription.", + "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "status": { + "description": "The status of the Azure config.", + "example": "active", + "type": "string" + }, + "status_updated_at": { + "description": "The timestamp when the Azure config status was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + }, + "updated_at": { + "description": "The timestamp when the Azure config was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + } }, - "url": { - "description": "The URL to look at the step in the CI provider UI.", - "nullable": true, - "type": "string" + "required": [ + "account_id", + "client_id", + "dataset_type", + "export_name", + "export_path", + "scope", + "status", + "storage_account", + "storage_container" + ], + "type": "object", + "x-merge-override": { + "required": false } }, - "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status" - ], - "type": "object" + "type": "array" + }, + "id": { + "description": "The ID of the Azure config pair.", + "format": "int64", + "type": "integer" } + }, + "required": [ + "configs" + ], + "type": "object", + "x-merge-override": { + "properties": false + } + }, + "AzureUCConfigPairType": { + "default": "azure_uc_configs", + "description": "Type of Azure config pair.", + "enum": [ + "azure_uc_configs" + ], + "example": "azure_uc_configs", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIGS" ] }, - "CIAppCreatePipelineEventRequestData": { - "description": "Data of the pipeline event to create.", + "AzureUCConfigPairsResponse": { + "description": "Response of Azure config pair.", "properties": { - "attributes": { - "description": "Attributes of the pipeline event to create.", + "data": { + "description": "Azure config pair.", "properties": { - "env": { - "description": "The Datadog environment.", - "type": "string" - }, - "resource": { - "description": "Details of the CI pipeline event.", - "example": "Details TBD", - "oneOf": [ - { - "description": "Details of the top level pipeline, build, or workflow of your CI.", - "properties": { - "end": { - "description": "Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } + "attributes": { + "description": "Attributes for Azure config pair.", + "properties": { + "configs": { + "description": "An Azure config.", + "items": { + "description": "Azure config.", + "properties": { + "account_id": { + "description": "The tenant ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" + "client_id": { + "description": "The client ID of the Azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "created_at": { + "description": "The timestamp when the Azure config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false } }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "is_manual": { - "description": "Whether or not the pipeline was triggered manually by the user.", - "example": false, - "nullable": true, - "type": "boolean" - }, - "is_resumed": { - "description": "Whether or not the pipeline was resumed after being blocked.", - "example": false, - "nullable": true, - "type": "boolean" - }, - "level": { - "default": "pipeline", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", - "enum": [ - "pipeline" - ], - "example": "pipeline", - "type": "string", - "x-enum-varnames": [ - "PIPELINE" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "dataset_type": { + "description": "The dataset type of the Azure config.", + "example": "actual", "type": "string" }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "Name of the pipeline. All pipeline runs for the builds should have the same name.", - "example": "Deploy to AWS", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", + "error_messages": { + "description": "The error messages for the Azure config.", + "items": { "type": "string" }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } + "type": "array" }, - "type": "object" - }, - "parameters": { - "additionalProperties": { + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", "type": "string" }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" }, - "nullable": true, - "type": "object" - }, - "parent_pipeline": { - "description": "If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.", - "nullable": true, - "properties": { - "id": { - "description": "UUID of a pipeline.", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", - "type": "string" - }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://ci-platform.com/pipelines/123456789", - "type": "string" - } + "id": { + "description": "The ID of the Azure config.", + "format": "int64", + "type": "integer" }, - "required": [ - "id" - ], - "type": "object" - }, - "partial_retry": { - "description": "Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one\nwhich only runs a subset of the original jobs.", - "example": false, - "type": "boolean" - }, - "pipeline_id": { - "description": "Any ID used in the provider to identify the pipeline run even if it is not unique across retries.\nIf the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.", - "example": "#023", - "type": "string" - }, - "previous_attempt": { - "description": "If the pipeline is a retry, this should contain the details of the previous attempt.", - "nullable": true, - "properties": { - "id": { - "description": "UUID of a pipeline.", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", - "type": "string" - }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://ci-platform.com/pipelines/123456789", - "type": "string" - } + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" }, - "required": [ - "id" - ], - "type": "object" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "start": { - "description": "Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the pipeline.", - "enum": [ - "success", - "error", - "canceled", - "skipped", - "blocked" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED", - "BLOCKED" - ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", + "scope": { + "description": "The scope of your observed subscription.", + "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", "type": "string" }, - "nullable": true, - "type": "array" + "status": { + "description": "The status of the Azure config.", + "example": "active", + "type": "string" + }, + "status_updated_at": { + "description": "The timestamp when the Azure config status was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + }, + "updated_at": { + "description": "The timestamp when the Azure config was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + } }, - "unique_id": { - "description": "UUID of the pipeline run. The ID has to be unique across retries and pipelines,\nincluding partial retries.", - "example": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", + "required": [ + "account_id", + "client_id", + "dataset_type", + "export_name", + "export_path", + "scope", + "status", + "storage_account", + "storage_container" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + }, + "id": { + "description": "The ID of the Azure config pair.", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "configs" + ], + "type": "object", + "x-merge-override": { + "properties": false + } + }, + "id": { + "description": "The ID of Cloud Cost Management account.", + "format": "int64", + "type": "integer" + }, + "type": { + "default": "azure_uc_configs", + "description": "Type of Azure config pair.", + "enum": [ + "azure_uc_configs" + ], + "example": "azure_uc_configs", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIGS" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" + }, + "AzureUCConfigPatchData": { + "description": "Azure config Patch data.", + "properties": { + "attributes": { + "description": "Attributes for Azure config Patch Request.", + "properties": { + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "example": true, + "type": "boolean" + } + }, + "required": [ + "is_enabled" + ], + "type": "object" + }, + "type": { + "default": "azure_uc_config_patch_request", + "description": "Type of Azure config Patch Request.", + "enum": [ + "azure_uc_config_patch_request" + ], + "example": "azure_uc_config_patch_request", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIG_PATCH_REQUEST" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "AzureUCConfigPatchRequest": { + "description": "Azure config Patch Request.", + "properties": { + "data": { + "description": "Azure config Patch data.", + "properties": { + "attributes": { + "description": "Attributes for Azure config Patch Request.", + "properties": { + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "example": true, + "type": "boolean" + } + }, + "required": [ + "is_enabled" + ], + "type": "object" + }, + "type": { + "default": "azure_uc_config_patch_request", + "description": "Type of Azure config Patch Request.", + "enum": [ + "azure_uc_config_patch_request" + ], + "example": "azure_uc_config_patch_request", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIG_PATCH_REQUEST" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "AzureUCConfigPatchRequestAttributes": { + "description": "Attributes for Azure config Patch Request.", + "properties": { + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "example": true, + "type": "boolean" + } + }, + "required": [ + "is_enabled" + ], + "type": "object" + }, + "AzureUCConfigPatchRequestType": { + "default": "azure_uc_config_patch_request", + "description": "Type of Azure config Patch Request.", + "enum": [ + "azure_uc_config_patch_request" + ], + "example": "azure_uc_config_patch_request", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIG_PATCH_REQUEST" + ] + }, + "AzureUCConfigPostData": { + "description": "Azure config Post data.", + "properties": { + "attributes": { + "description": "Attributes for Azure config Post Request.", + "properties": { + "account_id": { + "description": "The tenant ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "actual_bill_config": { + "description": "Bill config.", + "properties": { + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" + }, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + } + }, + "required": [ + "export_name", + "export_path", + "storage_account", + "storage_container" + ], + "type": "object" + }, + "amortized_bill_config": { + "description": "Bill config.", + "properties": { + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" + }, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + } + }, + "required": [ + "export_name", + "export_path", + "storage_account", + "storage_container" + ], + "type": "object" + }, + "client_id": { + "description": "The client ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "type": "boolean" + }, + "scope": { + "description": "The scope of your observed subscription.", + "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + } + }, + "required": [ + "account_id", + "actual_bill_config", + "amortized_bill_config", + "client_id", + "scope" + ], + "type": "object" + }, + "type": { + "default": "azure_uc_config_post_request", + "description": "Type of Azure config Post Request.", + "enum": [ + "azure_uc_config_post_request" + ], + "example": "azure_uc_config_post_request", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIG_POST_REQUEST" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "AzureUCConfigPostRequest": { + "description": "Azure config Post Request.", + "properties": { + "data": { + "description": "Azure config Post data.", + "properties": { + "attributes": { + "description": "Attributes for Azure config Post Request.", + "properties": { + "account_id": { + "description": "The tenant ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "actual_bill_config": { + "description": "Bill config.", + "properties": { + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", "type": "string" }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://my-ci-provider.example/pipelines/my-pipeline/run/1", + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", "type": "string" } }, "required": [ - "level", - "unique_id", - "name", - "url", - "start", - "end", - "status", - "partial_retry" + "export_name", + "export_path", + "storage_account", + "storage_container" ], "type": "object" }, - { - "description": "Details of a CI stage.", + "amortized_bill_config": { + "description": "Bill config.", "properties": { - "dependencies": { - "description": "A list of stage IDs that this stage depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" - ], - "items": { - "description": "A list of stage IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" }, - "end": { - "description": "Time when the stage run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", "type": "string" }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + } + }, + "required": [ + "export_name", + "export_path", + "storage_account", + "storage_container" + ], + "type": "object" + }, + "client_id": { + "description": "The client ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "type": "boolean" + }, + "scope": { + "description": "The scope of your observed subscription.", + "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + } + }, + "required": [ + "account_id", + "actual_bill_config", + "amortized_bill_config", + "client_id", + "scope" + ], + "type": "object" + }, + "type": { + "default": "azure_uc_config_post_request", + "description": "Type of Azure config Post Request.", + "enum": [ + "azure_uc_config_post_request" + ], + "example": "azure_uc_config_post_request", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIG_POST_REQUEST" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "AzureUCConfigPostRequestAttributes": { + "description": "Attributes for Azure config Post Request.", + "properties": { + "account_id": { + "description": "The tenant ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "actual_bill_config": { + "description": "Bill config.", + "properties": { + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" + }, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + } + }, + "required": [ + "export_name", + "export_path", + "storage_account", + "storage_container" + ], + "type": "object" + }, + "amortized_bill_config": { + "description": "Bill config.", + "properties": { + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" + }, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + } + }, + "required": [ + "export_name", + "export_path", + "storage_account", + "storage_container" + ], + "type": "object" + }, + "client_id": { + "description": "The client ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "type": "boolean" + }, + "scope": { + "description": "The scope of your observed subscription.", + "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + } + }, + "required": [ + "account_id", + "actual_bill_config", + "amortized_bill_config", + "client_id", + "scope" + ], + "type": "object" + }, + "AzureUCConfigPostRequestType": { + "default": "azure_uc_config_post_request", + "description": "Type of Azure config Post Request.", + "enum": [ + "azure_uc_config_post_request" + ], + "example": "azure_uc_config_post_request", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIG_POST_REQUEST" + ] + }, + "AzureUCConfigsResponse": { + "description": "List of Azure accounts with configs.", + "properties": { + "data": { + "description": "An Azure config pair.", + "items": { + "description": "Azure config pair.", + "properties": { + "attributes": { + "description": "Attributes for Azure config pair.", + "properties": { + "configs": { + "description": "An Azure config.", + "items": { + "description": "Azure config.", "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, + "account_id": { + "description": "The tenant ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", "type": "string" }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, + "client_id": { + "description": "The client ID of the Azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", "type": "string" }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" + "created_at": { + "description": "The timestamp when the Azure config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, + "dataset_type": { + "description": "The dataset type of the Azure config.", + "example": "actual", "type": "string" }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" + "error_messages": { + "description": "The error messages for the Azure config.", + "items": { + "type": "string" + }, + "type": "array" }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", "type": "string" }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", "type": "string" }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" + "id": { + "description": "The ID of the Azure config.", + "format": "int64", + "type": "integer" }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, + "scope": { + "description": "The scope of your observed subscription.", + "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", "type": "string" }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, + "status": { + "description": "The status of the Azure config.", + "example": "active", "type": "string" }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" + "status_updated_at": { + "description": "The timestamp when the Azure config status was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", "type": "string" }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", "type": "string" + }, + "updated_at": { + "description": "The timestamp when the Azure config was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } } }, "required": [ - "repository_url", - "sha", - "author_email" + "account_id", + "client_id", + "dataset_type", + "export_name", + "export_path", + "scope", + "status", + "storage_account", + "storage_container" ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } }, + "type": "array" + }, + "id": { + "description": "The ID of the Azure config pair.", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "configs" + ], + "type": "object", + "x-merge-override": { + "properties": false + } + }, + "id": { + "description": "The ID of Cloud Cost Management account.", + "format": "int64", + "type": "integer" + }, + "type": { + "default": "azure_uc_configs", + "description": "Type of Azure config pair.", + "enum": [ + "azure_uc_configs" + ], + "example": "azure_uc_configs", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIGS" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "type": "object" + }, + "BillConfig": { + "description": "Bill config.", + "properties": { + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" + }, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + } + }, + "required": [ + "export_name", + "export_path", + "storage_account", + "storage_container" + ], + "type": "object" + }, + "BillingDimensionsMappingBody": { + "description": "Billing dimensions mapping data.", + "items": { + "description": "The mapping data for each billing dimension.", + "properties": { + "attributes": { + "description": "Mapping of billing dimensions to endpoint keys.", + "properties": { + "endpoints": { + "description": "List of supported endpoints with their keys mapped to the billing_dimension.", + "items": { + "description": "An endpoint's keys mapped to the billing_dimension.", + "properties": { "id": { - "description": "UUID for the stage. It has to be unique at least in the pipeline scope.", - "example": "562bdbbb-7cab-48c8-851c-b24ca14628bf", + "description": "The URL for the endpoint.", + "example": "api/v1/usage/billable-summary", "type": "string" }, - "level": { - "default": "stage", - "description": "Used to distinguish between pipelines, stages, jobs and steps.", - "enum": [ - "stage" - ], - "example": "stage", - "type": "string", - "x-enum-varnames": [ - "STAGE" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "keys": { + "description": "The billing dimension.", "example": [ - "bundle_size:370", - "build_time:50021" + "apm_host_top99p", + "apm_host_sum" ], "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "example": "apm_host_top99p", "type": "string" }, - "nullable": true, "type": "array" }, - "name": { - "description": "The name for the stage.", - "example": "build", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "start": { - "description": "Time when the stage run started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, "status": { - "description": "The final status of the stage.", + "description": "Denotes whether mapping keys were available for this endpoint.", "enum": [ - "success", - "error", - "canceled", - "skipped" + "OK", + "NOT_FOUND" ], - "example": "success", "type": "string", "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" + "OK", + "NOT_FOUND" ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" } }, - "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status" - ], "type": "object" }, - { - "description": "Details of a CI job.", - "properties": { - "dependencies": { - "description": "A list of job IDs that this job depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" - ], - "items": { - "description": "A list of job IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "end": { - "description": "Time when the job run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "id": { - "description": "The UUID for the job. It has to be unique within each pipeline execution.", - "example": "c865bad4-de82-44b8-ade7-2c987528eb54", - "type": "string" - }, - "level": { - "default": "job", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", - "enum": [ - "job" - ], - "example": "job", - "type": "string", - "x-enum-varnames": [ - "JOB" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the job.", - "example": "test", + "type": "array" + }, + "in_app_label": { + "description": "Label used for the billing dimension in the Plan & Usage charts.", + "example": "APM Hosts", + "type": "string" + }, + "timestamp": { + "description": "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the billing dimension.", + "type": "string" + }, + "type": { + "default": "billing_dimensions", + "description": "Type of active billing dimensions data.", + "enum": [ + "billing_dimensions" + ], + "type": "string", + "x-enum-varnames": [ + "BILLING_DIMENSIONS" + ] + } + }, + "type": "object" + }, + "type": "array" + }, + "BillingDimensionsMappingBodyItem": { + "description": "The mapping data for each billing dimension.", + "properties": { + "attributes": { + "description": "Mapping of billing dimensions to endpoint keys.", + "properties": { + "endpoints": { + "description": "List of supported endpoints with their keys mapped to the billing_dimension.", + "items": { + "description": "An endpoint's keys mapped to the billing_dimension.", + "properties": { + "id": { + "description": "The URL for the endpoint.", + "example": "api/v1/usage/billable-summary", + "type": "string" + }, + "keys": { + "description": "The billing dimension.", + "example": [ + "apm_host_top99p", + "apm_host_sum" + ], + "items": { + "example": "apm_host_top99p", "type": "string" }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, + "type": "array" + }, + "status": { + "description": "Denotes whether mapping keys were available for this endpoint.", + "enum": [ + "OK", + "NOT_FOUND" + ], + "type": "string", + "x-enum-varnames": [ + "OK", + "NOT_FOUND" + ] + } + }, + "type": "object" + }, + "type": "array" + }, + "in_app_label": { + "description": "Label used for the billing dimension in the Plan & Usage charts.", + "example": "APM Hosts", + "type": "string" + }, + "timestamp": { + "description": "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the billing dimension.", + "type": "string" + }, + "type": { + "default": "billing_dimensions", + "description": "Type of active billing dimensions data.", + "enum": [ + "billing_dimensions" + ], + "type": "string", + "x-enum-varnames": [ + "BILLING_DIMENSIONS" + ] + } + }, + "type": "object" + }, + "BillingDimensionsMappingBodyItemAttributes": { + "description": "Mapping of billing dimensions to endpoint keys.", + "properties": { + "endpoints": { + "description": "List of supported endpoints with their keys mapped to the billing_dimension.", + "items": { + "description": "An endpoint's keys mapped to the billing_dimension.", + "properties": { + "id": { + "description": "The URL for the endpoint.", + "example": "api/v1/usage/billable-summary", + "type": "string" + }, + "keys": { + "description": "The billing dimension.", + "example": [ + "apm_host_top99p", + "apm_host_sum" + ], + "items": { + "example": "apm_host_top99p", + "type": "string" + }, + "type": "array" + }, + "status": { + "description": "Denotes whether mapping keys were available for this endpoint.", + "enum": [ + "OK", + "NOT_FOUND" + ], + "type": "string", + "x-enum-varnames": [ + "OK", + "NOT_FOUND" + ] + } + }, + "type": "object" + }, + "type": "array" + }, + "in_app_label": { + "description": "Label used for the billing dimension in the Plan & Usage charts.", + "example": "APM Hosts", + "type": "string" + }, + "timestamp": { + "description": "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "BillingDimensionsMappingBodyItemAttributesEndpointsItems": { + "description": "An endpoint's keys mapped to the billing_dimension.", + "properties": { + "id": { + "description": "The URL for the endpoint.", + "example": "api/v1/usage/billable-summary", + "type": "string" + }, + "keys": { + "description": "The billing dimension.", + "example": [ + "apm_host_top99p", + "apm_host_sum" + ], + "items": { + "example": "apm_host_top99p", + "type": "string" + }, + "type": "array" + }, + "status": { + "description": "Denotes whether mapping keys were available for this endpoint.", + "enum": [ + "OK", + "NOT_FOUND" + ], + "type": "string", + "x-enum-varnames": [ + "OK", + "NOT_FOUND" + ] + } + }, + "type": "object" + }, + "BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus": { + "description": "Denotes whether mapping keys were available for this endpoint.", + "enum": [ + "OK", + "NOT_FOUND" + ], + "type": "string", + "x-enum-varnames": [ + "OK", + "NOT_FOUND" + ] + }, + "BillingDimensionsMappingResponse": { + "description": "Billing dimensions mapping response.", + "properties": { + "data": { + "description": "Billing dimensions mapping data.", + "items": { + "description": "The mapping data for each billing dimension.", + "properties": { + "attributes": { + "description": "Mapping of billing dimensions to endpoint keys.", + "properties": { + "endpoints": { + "description": "List of supported endpoints with their keys mapped to the billing_dimension.", + "items": { + "description": "An endpoint's keys mapped to the billing_dimension.", "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", + "id": { + "description": "The URL for the endpoint.", + "example": "api/v1/usage/billable-summary", "type": "string" }, - "labels": { - "description": "A list of labels used to select or identify the node.", + "keys": { + "description": "The billing dimension.", "example": [ - "ubuntu-18.04", - "n2.large" + "apm_host_top99p", + "apm_host_sum" ], "items": { + "example": "apm_host_top99p", "type": "string" }, "type": "array" }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, - "type": "string" - }, - "start": { - "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the job.", - "enum": [ - "success", - "error", - "canceled", - "skipped" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" - ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "url": { - "description": "The URL to look at the job in the CI provider UI.", - "example": "https://ci-platform.com/job/your-job-name/build/123", - "type": "string" - } - }, - "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status", - "url" - ], - "type": "object" - }, - { - "description": "Details of a CI step.", - "properties": { - "end": { - "description": "Time when the step run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "status": { + "description": "Denotes whether mapping keys were available for this endpoint.", "enum": [ - "provider", - "user", - "unknown" + "OK", + "NOT_FOUND" ], "type": "string", "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" + "OK", + "NOT_FOUND" ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "id": { - "description": "UUID for the step. It has to be unique within each pipeline execution.", - "example": "c2d517a8-4f3a-4b41-b4ae-69df0c864c79", - "type": "string" - }, - "job_id": { - "description": "The parent job UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "job_name": { - "description": "The parent job name (if applicable).", - "nullable": true, - "type": "string" - }, - "level": { - "default": "step", - "description": "Used to distinguish between pipelines, stages, jobs and steps.", - "enum": [ - "step" - ], - "example": "step", - "type": "string", - "x-enum-varnames": [ - "STEP" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the step.", - "example": "test-server", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" } }, "type": "object" }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", - "nullable": true, + "type": "array" + }, + "in_app_label": { + "description": "Label used for the billing dimension in the Plan & Usage charts.", + "example": "APM Hosts", + "type": "string" + }, + "timestamp": { + "description": "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the billing dimension.", + "type": "string" + }, + "type": { + "default": "billing_dimensions", + "description": "Type of active billing dimensions data.", + "enum": [ + "billing_dimensions" + ], + "type": "string", + "x-enum-varnames": [ + "BILLING_DIMENSIONS" + ] + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkMuteFindingsRequest": { + "description": "The new bulk mute finding request.", + "properties": { + "data": { + "description": "Data object containing the new bulk mute properties of the finding.", + "properties": { + "attributes": { + "additionalProperties": false, + "description": "The mute properties to be updated.", + "properties": { + "mute": { + "additionalProperties": false, + "description": "Object containing the new mute properties of the findings.", + "properties": { + "description": { + "description": "Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.", "type": "string" }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, - "type": "string" + "expiration_date": { + "description": "The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.\nIf this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.\n", + "example": 1778721573794, + "format": "int64", + "type": "integer" }, - "start": { - "description": "Time when the step run started. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" + "muted": { + "description": "Whether those findings should be muted or unmuted.", + "example": true, + "type": "boolean" }, - "status": { - "description": "The final status of the step.", + "reason": { + "description": "The reason why this finding is muted or unmuted.", "enum": [ - "success", - "error" + "PENDING_FIX", + "FALSE_POSITIVE", + "ACCEPTED_RISK", + "NO_PENDING_FIX", + "HUMAN_ERROR", + "NO_LONGER_ACCEPTED_RISK", + "OTHER" ], - "example": "success", + "example": "ACCEPTED_RISK", "type": "string", "x-enum-varnames": [ - "SUCCESS", - "ERROR" + "PENDING_FIX", + "FALSE_POSITIVE", + "ACCEPTED_RISK", + "NO_PENDING_FIX", + "HUMAN_ERROR", + "NO_LONGER_ACCEPTED_RISK", + "OTHER" ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "url": { - "description": "The URL to look at the step in the CI provider UI.", - "nullable": true, - "type": "string" } }, "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status" + "muted", + "reason" ], "type": "object" } - ] + }, + "required": [ + "mute" + ], + "type": "object" }, - "service": { - "description": "If the CI provider is SaaS, use this to differentiate between instances.", + "id": { + "description": "UUID to identify the request", + "example": "dbe5f567-192b-4404-b908-29b70e1c9f76", "type": "string" + }, + "meta": { + "description": "Meta object containing the findings to be updated.", + "properties": { + "findings": { + "description": "Array of findings.", + "items": { + "description": "Finding object containing the finding information.", + "properties": { + "finding_id": { + "description": "The unique ID for this finding.", + "example": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": { + "default": "finding", + "description": "The JSON:API type for findings.", + "enum": [ + "finding" + ], + "example": "finding", + "type": "string", + "x-enum-varnames": [ + "FINDING" + ] } }, "required": [ - "resource" + "id", + "type", + "attributes", + "meta" ], "type": "object" - }, - "type": { - "default": "cipipeline_resource_request", - "description": "Type of the event.", - "enum": [ - "cipipeline_resource_request" - ], - "example": "cipipeline_resource_request", - "type": "string", - "x-enum-varnames": [ - "CIPIPELINE_RESOURCE_REQUEST" - ] } }, - "type": "object" - }, - "CIAppCreatePipelineEventRequestDataType": { - "default": "cipipeline_resource_request", - "description": "Type of the event.", - "enum": [ - "cipipeline_resource_request" + "required": [ + "data" ], - "example": "cipipeline_resource_request", - "type": "string", - "x-enum-varnames": [ - "CIPIPELINE_RESOURCE_REQUEST" - ] + "type": "object" }, - "CIAppEventAttributes": { - "description": "JSON object containing all event attributes and their associated values.", + "BulkMuteFindingsRequestAttributes": { + "additionalProperties": false, + "description": "The mute properties to be updated.", "properties": { - "attributes": { - "additionalProperties": {}, - "description": "JSON object of attributes from CI Visibility test events.", - "example": { - "customAttribute": 123, - "duration": 2345 - }, - "type": "object" - }, - "tags": { - "description": "Array of tags associated with your event.", - "example": [ - "team:A" - ], - "items": { - "description": "Tag associated with your event.", - "type": "string" + "mute": { + "additionalProperties": false, + "description": "Object containing the new mute properties of the findings.", + "properties": { + "description": { + "description": "Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.", + "type": "string" + }, + "expiration_date": { + "description": "The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.\nIf this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.\n", + "example": 1778721573794, + "format": "int64", + "type": "integer" + }, + "muted": { + "description": "Whether those findings should be muted or unmuted.", + "example": true, + "type": "boolean" + }, + "reason": { + "description": "The reason why this finding is muted or unmuted.", + "enum": [ + "PENDING_FIX", + "FALSE_POSITIVE", + "ACCEPTED_RISK", + "NO_PENDING_FIX", + "HUMAN_ERROR", + "NO_LONGER_ACCEPTED_RISK", + "OTHER" + ], + "example": "ACCEPTED_RISK", + "type": "string", + "x-enum-varnames": [ + "PENDING_FIX", + "FALSE_POSITIVE", + "ACCEPTED_RISK", + "NO_PENDING_FIX", + "HUMAN_ERROR", + "NO_LONGER_ACCEPTED_RISK", + "OTHER" + ] + } }, - "type": "array" - }, - "test_level": { - "description": "Test run level.", - "enum": [ - "session", - "module", - "suite", - "test" + "required": [ + "muted", + "reason" ], - "example": "test", - "type": "string", - "x-enum-varnames": [ - "SESSION", - "MODULE", - "SUITE", - "TEST" - ] + "type": "object" } }, + "required": [ + "mute" + ], "type": "object" }, - "CIAppGitInfo": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, + "BulkMuteFindingsRequestData": { + "description": "Data object containing the new bulk mute properties of the finding.", "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" + "attributes": { + "additionalProperties": false, + "description": "The mute properties to be updated.", + "properties": { + "mute": { + "additionalProperties": false, + "description": "Object containing the new mute properties of the findings.", + "properties": { + "description": { + "description": "Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.", + "type": "string" + }, + "expiration_date": { + "description": "The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.\nIf this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.\n", + "example": 1778721573794, + "format": "int64", + "type": "integer" + }, + "muted": { + "description": "Whether those findings should be muted or unmuted.", + "example": true, + "type": "boolean" + }, + "reason": { + "description": "The reason why this finding is muted or unmuted.", + "enum": [ + "PENDING_FIX", + "FALSE_POSITIVE", + "ACCEPTED_RISK", + "NO_PENDING_FIX", + "HUMAN_ERROR", + "NO_LONGER_ACCEPTED_RISK", + "OTHER" + ], + "example": "ACCEPTED_RISK", + "type": "string", + "x-enum-varnames": [ + "PENDING_FIX", + "FALSE_POSITIVE", + "ACCEPTED_RISK", + "NO_PENDING_FIX", + "HUMAN_ERROR", + "NO_LONGER_ACCEPTED_RISK", + "OTHER" + ] + } + }, + "required": [ + "muted", + "reason" + ], + "type": "object" + } + }, + "required": [ + "mute" + ], + "type": "object" }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, + "id": { + "description": "UUID to identify the request", + "example": "dbe5f567-192b-4404-b908-29b70e1c9f76", "type": "string" }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" + "meta": { + "description": "Meta object containing the findings to be updated.", + "properties": { + "findings": { + "description": "Array of findings.", + "items": { + "description": "Finding object containing the finding information.", + "properties": { + "finding_id": { + "description": "The unique ID for this finding.", + "example": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, + "type": { + "default": "finding", + "description": "The JSON:API type for findings.", + "enum": [ + "finding" + ], + "example": "finding", + "type": "string", + "x-enum-varnames": [ + "FINDING" + ] + } + }, + "required": [ + "id", + "type", + "attributes", + "meta" + ], + "type": "object" + }, + "BulkMuteFindingsRequestMeta": { + "description": "Meta object containing the findings to be updated.", + "properties": { + "findings": { + "description": "Array of findings.", + "items": { + "description": "Finding object containing the finding information.", + "properties": { + "finding_id": { + "description": "The unique ID for this finding.", + "example": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkMuteFindingsRequestMetaFindings": { + "description": "Finding object containing the finding information.", + "properties": { + "finding_id": { + "description": "The unique ID for this finding.", + "example": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, + } + }, + "type": "object" + }, + "BulkMuteFindingsRequestProperties": { + "additionalProperties": false, + "description": "Object containing the new mute properties of the findings.", + "properties": { + "description": { + "description": "Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.", "type": "string" }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" + "expiration_date": { + "description": "The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.\nIf this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.\n", + "example": 1778721573794, + "format": "int64", + "type": "integer" }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" + "muted": { + "description": "Whether those findings should be muted or unmuted.", + "example": true, + "type": "boolean" }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" + "reason": { + "description": "The reason why this finding is muted or unmuted.", + "enum": [ + "PENDING_FIX", + "FALSE_POSITIVE", + "ACCEPTED_RISK", + "NO_PENDING_FIX", + "HUMAN_ERROR", + "NO_LONGER_ACCEPTED_RISK", + "OTHER" + ], + "example": "ACCEPTED_RISK", + "type": "string", + "x-enum-varnames": [ + "PENDING_FIX", + "FALSE_POSITIVE", + "ACCEPTED_RISK", + "NO_PENDING_FIX", + "HUMAN_ERROR", + "NO_LONGER_ACCEPTED_RISK", + "OTHER" + ] } }, "required": [ - "repository_url", - "sha", - "author_email" + "muted", + "reason" ], "type": "object" }, - "CIAppGroupByHistogram": { - "description": "Used to perform a histogram computation (only for measure facets).\nAt most, 100 buckets are allowed, the number of buckets is `(max - min)/interval`.", + "BulkMuteFindingsResponse": { + "description": "The expected response schema.", "properties": { - "interval": { - "description": "The bin size of the histogram buckets.", - "example": 10, - "format": "double", - "type": "number" - }, - "max": { - "description": "The maximum value for the measure used in the histogram\n(values greater than this one are filtered out).", - "example": 100, - "format": "double", - "type": "number" - }, - "min": { - "description": "The minimum value for the measure used in the histogram\n(values smaller than this one are filtered out).", - "example": 50, - "format": "double", - "type": "number" + "data": { + "description": "Data object containing the ID of the request that was updated.", + "properties": { + "id": { + "description": "UUID used to identify the request", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "type": { + "default": "finding", + "description": "The JSON:API type for findings.", + "enum": [ + "finding" + ], + "example": "finding", + "type": "string", + "x-enum-varnames": [ + "FINDING" + ] + } + }, + "type": "object" } }, "required": [ - "interval", - "min", - "max" + "data" ], "type": "object" }, - "CIAppGroupByMissing": { - "description": "The value to use for logs that don't have the facet used to group-by.", - "oneOf": [ - { - "description": "The missing value to use if there is a string valued facet.", + "BulkMuteFindingsResponseData": { + "description": "Data object containing the ID of the request that was updated.", + "properties": { + "id": { + "description": "UUID used to identify the request", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", "type": "string" }, - { - "description": "The missing value to use if there is a number valued facet.", - "format": "double", - "type": "number" + "type": { + "default": "finding", + "description": "The JSON:API type for findings.", + "enum": [ + "finding" + ], + "example": "finding", + "type": "string", + "x-enum-varnames": [ + "FINDING" + ] } - ] - }, - "CIAppGroupByMissingNumber": { - "description": "The missing value to use if there is a number valued facet.", - "format": "double", - "type": "number" - }, - "CIAppGroupByMissingString": { - "description": "The missing value to use if there is a string valued facet.", - "type": "string" + }, + "type": "object" }, - "CIAppGroupByTotal": { - "default": false, - "description": "A resulting object to put the given computes in over all the matching records.", + "CIAppAggregateBucketValue": { + "description": "A bucket value, can either be a timeseries or a single value.", "oneOf": [ { - "description": "If set to true, creates an additional bucket labeled \"$facet_total\".", - "type": "boolean" - }, - { - "description": "A string to use as the key value for the total bucket.", + "description": "A single string value.", "type": "string" }, { - "description": "A number to use as the key value for the total bucket.", + "description": "A single number value.", "format": "double", "type": "number" + }, + { + "description": "A timeseries array.", + "items": { + "description": "A timeseries point.", + "properties": { + "time": { + "description": "The time value for this point.", + "example": "2020-06-08T11:55:00.123Z", + "format": "date-time", + "type": "string" + }, + "value": { + "description": "The value for this point.", + "example": 19, + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "type": "array", + "x-generate-alias-as-model": true } ] }, - "CIAppGroupByTotalBoolean": { - "description": "If set to true, creates an additional bucket labeled \"$facet_total\".", - "type": "boolean" - }, - "CIAppGroupByTotalNumber": { - "description": "A number to use as the key value for the total bucket.", + "CIAppAggregateBucketValueSingleNumber": { + "description": "A single number value.", "format": "double", "type": "number" }, - "CIAppGroupByTotalString": { - "description": "A string to use as the key value for the total bucket.", + "CIAppAggregateBucketValueSingleString": { + "description": "A single string value.", "type": "string" }, - "CIAppHostInfo": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { + "CIAppAggregateBucketValueTimeseries": { + "description": "A timeseries array.", + "items": { + "description": "A timeseries point.", + "properties": { + "time": { + "description": "The time value for this point.", + "example": "2020-06-08T11:55:00.123Z", + "format": "date-time", "type": "string" }, - "type": "array" + "value": { + "description": "The value for this point.", + "example": 19, + "format": "double", + "type": "number" + } }, - "name": { - "description": "Name for the host.", + "type": "object" + }, + "type": "array", + "x-generate-alias-as-model": true + }, + "CIAppAggregateBucketValueTimeseriesPoint": { + "description": "A timeseries point.", + "properties": { + "time": { + "description": "The time value for this point.", + "example": "2020-06-08T11:55:00.123Z", + "format": "date-time", "type": "string" }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" + "value": { + "description": "The value for this point.", + "example": 19, + "format": "double", + "type": "number" } }, "type": "object" }, - "CIAppPipelineEvent": { - "description": "Object description of a pipeline event after being processed and stored by Datadog.", + "CIAppAggregateSort": { + "description": "A sort rule. The `aggregation` field is required when `type` is `measure`.", + "example": { + "aggregation": "count", + "order": "asc" + }, "properties": { - "attributes": { - "description": "JSON object containing all event attributes and their associated values.", - "properties": { - "attributes": { - "additionalProperties": {}, - "description": "JSON object of attributes from CI Visibility pipeline events.", - "example": { - "customAttribute": 123, - "duration": 2345 - }, - "type": "object" - }, - "ci_level": { - "description": "Pipeline execution level.", - "enum": [ - "pipeline", - "stage", - "job", - "step", - "custom" - ], - "example": "pipeline", - "type": "string", - "x-enum-varnames": [ - "PIPELINE", - "STAGE", - "JOB", - "STEP", - "CUSTOM" - ] - }, - "tags": { - "description": "Array of tags associated with your event.", - "example": [ - "team:A" - ], - "items": { - "description": "Tag associated with your event.", - "type": "string" - }, - "type": "array" - } - }, - "type": "object" + "aggregation": { + "description": "An aggregation function.", + "enum": [ + "count", + "cardinality", + "pc75", + "pc90", + "pc95", + "pc98", + "pc99", + "sum", + "min", + "max", + "avg", + "median", + "latest", + "earliest", + "most_frequent", + "delta" + ], + "example": "pc90", + "type": "string", + "x-enum-varnames": [ + "COUNT", + "CARDINALITY", + "PERCENTILE_75", + "PERCENTILE_90", + "PERCENTILE_95", + "PERCENTILE_98", + "PERCENTILE_99", + "SUM", + "MIN", + "MAX", + "AVG", + "MEDIAN", + "LATEST", + "EARLIEST", + "MOST_FREQUENT", + "DELTA" + ] }, - "id": { - "description": "Unique ID of the event.", - "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", + "metric": { + "description": "The metric to sort by (only used for `type=measure`).", + "example": "@duration", "type": "string" }, - "type": { - "description": "Type of the event.", + "order": { + "description": "The order to use, ascending or descending.", "enum": [ - "cipipeline" + "asc", + "desc" ], - "example": "cipipeline", + "example": "asc", "type": "string", "x-enum-varnames": [ - "CIPIPELINE" + "ASCENDING", + "DESCENDING" ] - } - }, - "type": "object" - }, - "CIAppPipelineEventAttributes": { - "description": "JSON object containing all event attributes and their associated values.", - "properties": { - "attributes": { - "additionalProperties": {}, - "description": "JSON object of attributes from CI Visibility pipeline events.", - "example": { - "customAttribute": 123, - "duration": 2345 - }, - "type": "object" }, - "ci_level": { - "description": "Pipeline execution level.", + "type": { + "default": "alphabetical", + "description": "The type of sorting algorithm.", "enum": [ - "pipeline", - "stage", - "job", - "step", - "custom" + "alphabetical", + "measure" ], - "example": "pipeline", "type": "string", "x-enum-varnames": [ - "PIPELINE", - "STAGE", - "JOB", - "STEP", - "CUSTOM" + "ALPHABETICAL", + "MEASURE" ] - }, - "tags": { - "description": "Array of tags associated with your event.", - "example": [ - "team:A" - ], - "items": { - "description": "Tag associated with your event.", - "type": "string" - }, - "type": "array" } }, "type": "object" }, - "CIAppPipelineEventJob": { - "description": "Details of a CI job.", + "CIAppAggregateSortType": { + "default": "alphabetical", + "description": "The type of sorting algorithm.", + "enum": [ + "alphabetical", + "measure" + ], + "type": "string", + "x-enum-varnames": [ + "ALPHABETICAL", + "MEASURE" + ] + }, + "CIAppAggregationFunction": { + "description": "An aggregation function.", + "enum": [ + "count", + "cardinality", + "pc75", + "pc90", + "pc95", + "pc98", + "pc99", + "sum", + "min", + "max", + "avg", + "median", + "latest", + "earliest", + "most_frequent", + "delta" + ], + "example": "pc90", + "type": "string", + "x-enum-varnames": [ + "COUNT", + "CARDINALITY", + "PERCENTILE_75", + "PERCENTILE_90", + "PERCENTILE_95", + "PERCENTILE_98", + "PERCENTILE_99", + "SUM", + "MIN", + "MAX", + "AVG", + "MEDIAN", + "LATEST", + "EARLIEST", + "MOST_FREQUENT", + "DELTA" + ] + }, + "CIAppCIError": { + "description": "Contains information of the CI error.", + "nullable": true, "properties": { - "dependencies": { - "description": "A list of job IDs that this job depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" - ], - "items": { - "description": "A list of job IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "end": { - "description": "Time when the job run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "id": { - "description": "The UUID for the job. It has to be unique within each pipeline execution.", - "example": "c865bad4-de82-44b8-ade7-2c987528eb54", - "type": "string" - }, - "level": { - "default": "job", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", "enum": [ - "job" + "provider", + "user", + "unknown" ], - "example": "job", "type": "string", "x-enum-varnames": [ - "JOB" + "PROVIDER", + "USER", + "UNKNOWN" ] }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, + "message": { + "description": "Error message.", + "maxLength": 5000, "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the job.", - "example": "test", "type": "string" }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, + "stack": { + "description": "The stack trace of the reported errors.", "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", "type": "string" }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", + "type": { + "description": "Short description of the error type.", + "maxLength": 100, "nullable": true, "type": "string" + } + }, + "type": "object" + }, + "CIAppCIErrorDomain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "CIAppCompute": { + "description": "A compute rule to compute metrics or timeseries.", + "properties": { + "aggregation": { + "description": "An aggregation function.", + "enum": [ + "count", + "cardinality", + "pc75", + "pc90", + "pc95", + "pc98", + "pc99", + "sum", + "min", + "max", + "avg", + "median", + "latest", + "earliest", + "most_frequent", + "delta" + ], + "example": "pc90", + "type": "string", + "x-enum-varnames": [ + "COUNT", + "CARDINALITY", + "PERCENTILE_75", + "PERCENTILE_90", + "PERCENTILE_95", + "PERCENTILE_98", + "PERCENTILE_99", + "SUM", + "MIN", + "MAX", + "AVG", + "MEDIAN", + "LATEST", + "EARLIEST", + "MOST_FREQUENT", + "DELTA" + ] }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, + "interval": { + "description": "The time buckets' size (only used for type=timeseries)\nDefaults to a resolution of 150 points.", + "example": "5m", "type": "string" }, - "start": { - "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + "metric": { + "description": "The metric to use.", + "example": "@duration", "type": "string" }, - "status": { - "description": "The final status of the job.", + "type": { + "default": "total", + "description": "The type of compute.", "enum": [ - "success", - "error", - "canceled", - "skipped" + "timeseries", + "total" ], - "example": "success", "type": "string", "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" + "TIMESERIES", + "TOTAL" ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "url": { - "description": "The URL to look at the job in the CI provider UI.", - "example": "https://ci-platform.com/job/your-job-name/build/123", - "type": "string" } }, "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status", - "url" + "aggregation" ], "type": "object" }, - "CIAppPipelineEventJobLevel": { - "default": "job", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", - "enum": [ - "job" - ], - "example": "job", - "type": "string", - "x-enum-varnames": [ - "JOB" - ] - }, - "CIAppPipelineEventJobStatus": { - "description": "The final status of the job.", + "CIAppComputeType": { + "default": "total", + "description": "The type of compute.", "enum": [ - "success", - "error", - "canceled", - "skipped" + "timeseries", + "total" ], - "example": "success", "type": "string", "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" + "TIMESERIES", + "TOTAL" ] }, - "CIAppPipelineEventMetrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "CIAppPipelineEventParameters": { + "CIAppComputes": { + "additionalProperties": { + "description": "A bucket value, can either be a timeseries or a single value.", + "oneOf": [ + { + "description": "A single string value.", + "type": "string" + }, + { + "description": "A single number value.", + "format": "double", + "type": "number" + }, + { + "description": "A timeseries array.", + "items": { + "description": "A timeseries point.", + "properties": { + "time": { + "description": "The time value for this point.", + "example": "2020-06-08T11:55:00.123Z", + "format": "date-time", + "type": "string" + }, + "value": { + "description": "The value for this point.", + "example": 19, + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "type": "array", + "x-generate-alias-as-model": true + } + ] + }, + "description": "A map of the metric name to value for regular compute, or a list of values for a timeseries.", + "type": "object" + }, + "CIAppCreatePipelineEventRequest": { + "description": "Request object.", + "properties": { + "data": { + "description": "Data of the pipeline event to create.", + "properties": { + "attributes": { + "description": "Attributes of the pipeline event to create.", + "properties": { + "env": { + "description": "The Datadog environment.", + "type": "string" + }, + "resource": { + "description": "Details of the CI pipeline event.", + "example": "Details TBD", + "oneOf": [ + { + "description": "Details of the top level pipeline, build, or workflow of your CI.", + "properties": { + "end": { + "description": "Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "is_manual": { + "description": "Whether or not the pipeline was triggered manually by the user.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "is_resumed": { + "description": "Whether or not the pipeline was resumed after being blocked.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "level": { + "default": "pipeline", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "pipeline" + ], + "example": "pipeline", + "type": "string", + "x-enum-varnames": [ + "PIPELINE" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "Name of the pipeline. All pipeline runs for the builds should have the same name.", + "example": "Deploy to AWS", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "parent_pipeline": { + "description": "If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.", + "nullable": true, + "properties": { + "id": { + "description": "UUID of a pipeline.", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://ci-platform.com/pipelines/123456789", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "partial_retry": { + "description": "Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one\nwhich only runs a subset of the original jobs.", + "example": false, + "type": "boolean" + }, + "pipeline_id": { + "description": "Any ID used in the provider to identify the pipeline run even if it is not unique across retries.\nIf the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.", + "example": "#023", + "type": "string" + }, + "previous_attempt": { + "description": "If the pipeline is a retry, this should contain the details of the previous attempt.", + "nullable": true, + "properties": { + "id": { + "description": "UUID of a pipeline.", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://ci-platform.com/pipelines/123456789", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "start": { + "description": "Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the pipeline.", + "enum": [ + "success", + "error", + "canceled", + "skipped", + "blocked" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED", + "BLOCKED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "unique_id": { + "description": "UUID of the pipeline run. The ID has to be unique across retries and pipelines,\nincluding partial retries.", + "example": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://my-ci-provider.example/pipelines/my-pipeline/run/1", + "type": "string" + } + }, + "required": [ + "level", + "unique_id", + "name", + "url", + "start", + "end", + "status", + "partial_retry" + ], + "type": "object" + }, + { + "description": "Details of a CI stage.", + "properties": { + "dependencies": { + "description": "A list of stage IDs that this stage depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of stage IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the stage run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "UUID for the stage. It has to be unique at least in the pipeline scope.", + "example": "562bdbbb-7cab-48c8-851c-b24ca14628bf", + "type": "string" + }, + "level": { + "default": "stage", + "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "enum": [ + "stage" + ], + "example": "stage", + "type": "string", + "x-enum-varnames": [ + "STAGE" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the stage.", + "example": "build", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "start": { + "description": "Time when the stage run started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the stage.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status" + ], + "type": "object" + }, + { + "description": "Details of a CI job.", + "properties": { + "dependencies": { + "description": "A list of job IDs that this job depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of job IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the job run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "The UUID for the job. It has to be unique within each pipeline execution.", + "example": "c865bad4-de82-44b8-ade7-2c987528eb54", + "type": "string" + }, + "level": { + "default": "job", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "job" + ], + "example": "job", + "type": "string", + "x-enum-varnames": [ + "JOB" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the job.", + "example": "test", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the job.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the job in the CI provider UI.", + "example": "https://ci-platform.com/job/your-job-name/build/123", + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status", + "url" + ], + "type": "object" + }, + { + "description": "Details of a CI step.", + "properties": { + "end": { + "description": "Time when the step run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "UUID for the step. It has to be unique within each pipeline execution.", + "example": "c2d517a8-4f3a-4b41-b4ae-69df0c864c79", + "type": "string" + }, + "job_id": { + "description": "The parent job UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "job_name": { + "description": "The parent job name (if applicable).", + "nullable": true, + "type": "string" + }, + "level": { + "default": "step", + "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "enum": [ + "step" + ], + "example": "step", + "type": "string", + "x-enum-varnames": [ + "STEP" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the step.", + "example": "test-server", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the step run started. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the step.", + "enum": [ + "success", + "error" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the step in the CI provider UI.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status" + ], + "type": "object" + } + ] + }, + "service": { + "description": "If the CI provider is SaaS, use this to differentiate between instances.", + "type": "string" + } + }, + "required": [ + "resource" + ], + "type": "object" + }, + "type": { + "default": "cipipeline_resource_request", + "description": "Type of the event.", + "enum": [ + "cipipeline_resource_request" + ], + "example": "cipipeline_resource_request", + "type": "string", + "x-enum-varnames": [ + "CIPIPELINE_RESOURCE_REQUEST" + ] + } + }, + "type": "object" + } + }, + "type": "object" + }, + "CIAppCreatePipelineEventRequestAttributes": { + "description": "Attributes of the pipeline event to create.", + "properties": { + "env": { + "description": "The Datadog environment.", + "type": "string" + }, + "resource": { + "description": "Details of the CI pipeline event.", + "example": "Details TBD", + "oneOf": [ + { + "description": "Details of the top level pipeline, build, or workflow of your CI.", + "properties": { + "end": { + "description": "Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "is_manual": { + "description": "Whether or not the pipeline was triggered manually by the user.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "is_resumed": { + "description": "Whether or not the pipeline was resumed after being blocked.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "level": { + "default": "pipeline", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "pipeline" + ], + "example": "pipeline", + "type": "string", + "x-enum-varnames": [ + "PIPELINE" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "Name of the pipeline. All pipeline runs for the builds should have the same name.", + "example": "Deploy to AWS", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "parent_pipeline": { + "description": "If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.", + "nullable": true, + "properties": { + "id": { + "description": "UUID of a pipeline.", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://ci-platform.com/pipelines/123456789", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "partial_retry": { + "description": "Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one\nwhich only runs a subset of the original jobs.", + "example": false, + "type": "boolean" + }, + "pipeline_id": { + "description": "Any ID used in the provider to identify the pipeline run even if it is not unique across retries.\nIf the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.", + "example": "#023", + "type": "string" + }, + "previous_attempt": { + "description": "If the pipeline is a retry, this should contain the details of the previous attempt.", + "nullable": true, + "properties": { + "id": { + "description": "UUID of a pipeline.", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://ci-platform.com/pipelines/123456789", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "start": { + "description": "Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the pipeline.", + "enum": [ + "success", + "error", + "canceled", + "skipped", + "blocked" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED", + "BLOCKED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "unique_id": { + "description": "UUID of the pipeline run. The ID has to be unique across retries and pipelines,\nincluding partial retries.", + "example": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://my-ci-provider.example/pipelines/my-pipeline/run/1", + "type": "string" + } + }, + "required": [ + "level", + "unique_id", + "name", + "url", + "start", + "end", + "status", + "partial_retry" + ], + "type": "object" + }, + { + "description": "Details of a CI stage.", + "properties": { + "dependencies": { + "description": "A list of stage IDs that this stage depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of stage IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the stage run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "UUID for the stage. It has to be unique at least in the pipeline scope.", + "example": "562bdbbb-7cab-48c8-851c-b24ca14628bf", + "type": "string" + }, + "level": { + "default": "stage", + "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "enum": [ + "stage" + ], + "example": "stage", + "type": "string", + "x-enum-varnames": [ + "STAGE" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the stage.", + "example": "build", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "start": { + "description": "Time when the stage run started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the stage.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status" + ], + "type": "object" + }, + { + "description": "Details of a CI job.", + "properties": { + "dependencies": { + "description": "A list of job IDs that this job depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of job IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the job run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "The UUID for the job. It has to be unique within each pipeline execution.", + "example": "c865bad4-de82-44b8-ade7-2c987528eb54", + "type": "string" + }, + "level": { + "default": "job", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "job" + ], + "example": "job", + "type": "string", + "x-enum-varnames": [ + "JOB" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the job.", + "example": "test", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the job.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the job in the CI provider UI.", + "example": "https://ci-platform.com/job/your-job-name/build/123", + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status", + "url" + ], + "type": "object" + }, + { + "description": "Details of a CI step.", + "properties": { + "end": { + "description": "Time when the step run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "UUID for the step. It has to be unique within each pipeline execution.", + "example": "c2d517a8-4f3a-4b41-b4ae-69df0c864c79", + "type": "string" + }, + "job_id": { + "description": "The parent job UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "job_name": { + "description": "The parent job name (if applicable).", + "nullable": true, + "type": "string" + }, + "level": { + "default": "step", + "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "enum": [ + "step" + ], + "example": "step", + "type": "string", + "x-enum-varnames": [ + "STEP" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the step.", + "example": "test-server", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the step run started. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the step.", + "enum": [ + "success", + "error" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the step in the CI provider UI.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status" + ], + "type": "object" + } + ] + }, + "service": { + "description": "If the CI provider is SaaS, use this to differentiate between instances.", + "type": "string" + } + }, + "required": [ + "resource" + ], + "type": "object" + }, + "CIAppCreatePipelineEventRequestAttributesResource": { + "description": "Details of the CI pipeline event.", + "example": "Details TBD", + "oneOf": [ + { + "description": "Details of the top level pipeline, build, or workflow of your CI.", + "properties": { + "end": { + "description": "Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "is_manual": { + "description": "Whether or not the pipeline was triggered manually by the user.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "is_resumed": { + "description": "Whether or not the pipeline was resumed after being blocked.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "level": { + "default": "pipeline", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "pipeline" + ], + "example": "pipeline", + "type": "string", + "x-enum-varnames": [ + "PIPELINE" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "Name of the pipeline. All pipeline runs for the builds should have the same name.", + "example": "Deploy to AWS", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "parent_pipeline": { + "description": "If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.", + "nullable": true, + "properties": { + "id": { + "description": "UUID of a pipeline.", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://ci-platform.com/pipelines/123456789", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "partial_retry": { + "description": "Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one\nwhich only runs a subset of the original jobs.", + "example": false, + "type": "boolean" + }, + "pipeline_id": { + "description": "Any ID used in the provider to identify the pipeline run even if it is not unique across retries.\nIf the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.", + "example": "#023", + "type": "string" + }, + "previous_attempt": { + "description": "If the pipeline is a retry, this should contain the details of the previous attempt.", + "nullable": true, + "properties": { + "id": { + "description": "UUID of a pipeline.", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://ci-platform.com/pipelines/123456789", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "start": { + "description": "Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the pipeline.", + "enum": [ + "success", + "error", + "canceled", + "skipped", + "blocked" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED", + "BLOCKED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "unique_id": { + "description": "UUID of the pipeline run. The ID has to be unique across retries and pipelines,\nincluding partial retries.", + "example": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://my-ci-provider.example/pipelines/my-pipeline/run/1", + "type": "string" + } + }, + "required": [ + "level", + "unique_id", + "name", + "url", + "start", + "end", + "status", + "partial_retry" + ], + "type": "object" + }, + { + "description": "Details of a CI stage.", + "properties": { + "dependencies": { + "description": "A list of stage IDs that this stage depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of stage IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the stage run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "UUID for the stage. It has to be unique at least in the pipeline scope.", + "example": "562bdbbb-7cab-48c8-851c-b24ca14628bf", + "type": "string" + }, + "level": { + "default": "stage", + "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "enum": [ + "stage" + ], + "example": "stage", + "type": "string", + "x-enum-varnames": [ + "STAGE" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the stage.", + "example": "build", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "start": { + "description": "Time when the stage run started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the stage.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status" + ], + "type": "object" + }, + { + "description": "Details of a CI job.", + "properties": { + "dependencies": { + "description": "A list of job IDs that this job depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of job IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the job run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "The UUID for the job. It has to be unique within each pipeline execution.", + "example": "c865bad4-de82-44b8-ade7-2c987528eb54", + "type": "string" + }, + "level": { + "default": "job", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "job" + ], + "example": "job", + "type": "string", + "x-enum-varnames": [ + "JOB" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the job.", + "example": "test", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the job.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the job in the CI provider UI.", + "example": "https://ci-platform.com/job/your-job-name/build/123", + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status", + "url" + ], + "type": "object" + }, + { + "description": "Details of a CI step.", + "properties": { + "end": { + "description": "Time when the step run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "UUID for the step. It has to be unique within each pipeline execution.", + "example": "c2d517a8-4f3a-4b41-b4ae-69df0c864c79", + "type": "string" + }, + "job_id": { + "description": "The parent job UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "job_name": { + "description": "The parent job name (if applicable).", + "nullable": true, + "type": "string" + }, + "level": { + "default": "step", + "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "enum": [ + "step" + ], + "example": "step", + "type": "string", + "x-enum-varnames": [ + "STEP" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the step.", + "example": "test-server", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the step run started. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the step.", + "enum": [ + "success", + "error" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the step in the CI provider UI.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status" + ], + "type": "object" + } + ] + }, + "CIAppCreatePipelineEventRequestData": { + "description": "Data of the pipeline event to create.", + "properties": { + "attributes": { + "description": "Attributes of the pipeline event to create.", + "properties": { + "env": { + "description": "The Datadog environment.", + "type": "string" + }, + "resource": { + "description": "Details of the CI pipeline event.", + "example": "Details TBD", + "oneOf": [ + { + "description": "Details of the top level pipeline, build, or workflow of your CI.", + "properties": { + "end": { + "description": "Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "is_manual": { + "description": "Whether or not the pipeline was triggered manually by the user.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "is_resumed": { + "description": "Whether or not the pipeline was resumed after being blocked.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "level": { + "default": "pipeline", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "pipeline" + ], + "example": "pipeline", + "type": "string", + "x-enum-varnames": [ + "PIPELINE" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "Name of the pipeline. All pipeline runs for the builds should have the same name.", + "example": "Deploy to AWS", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "parent_pipeline": { + "description": "If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.", + "nullable": true, + "properties": { + "id": { + "description": "UUID of a pipeline.", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://ci-platform.com/pipelines/123456789", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "partial_retry": { + "description": "Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one\nwhich only runs a subset of the original jobs.", + "example": false, + "type": "boolean" + }, + "pipeline_id": { + "description": "Any ID used in the provider to identify the pipeline run even if it is not unique across retries.\nIf the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.", + "example": "#023", + "type": "string" + }, + "previous_attempt": { + "description": "If the pipeline is a retry, this should contain the details of the previous attempt.", + "nullable": true, + "properties": { + "id": { + "description": "UUID of a pipeline.", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://ci-platform.com/pipelines/123456789", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "start": { + "description": "Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the pipeline.", + "enum": [ + "success", + "error", + "canceled", + "skipped", + "blocked" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED", + "BLOCKED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "unique_id": { + "description": "UUID of the pipeline run. The ID has to be unique across retries and pipelines,\nincluding partial retries.", + "example": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://my-ci-provider.example/pipelines/my-pipeline/run/1", + "type": "string" + } + }, + "required": [ + "level", + "unique_id", + "name", + "url", + "start", + "end", + "status", + "partial_retry" + ], + "type": "object" + }, + { + "description": "Details of a CI stage.", + "properties": { + "dependencies": { + "description": "A list of stage IDs that this stage depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of stage IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the stage run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "UUID for the stage. It has to be unique at least in the pipeline scope.", + "example": "562bdbbb-7cab-48c8-851c-b24ca14628bf", + "type": "string" + }, + "level": { + "default": "stage", + "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "enum": [ + "stage" + ], + "example": "stage", + "type": "string", + "x-enum-varnames": [ + "STAGE" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the stage.", + "example": "build", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "start": { + "description": "Time when the stage run started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the stage.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status" + ], + "type": "object" + }, + { + "description": "Details of a CI job.", + "properties": { + "dependencies": { + "description": "A list of job IDs that this job depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of job IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the job run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "The UUID for the job. It has to be unique within each pipeline execution.", + "example": "c865bad4-de82-44b8-ade7-2c987528eb54", + "type": "string" + }, + "level": { + "default": "job", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "job" + ], + "example": "job", + "type": "string", + "x-enum-varnames": [ + "JOB" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the job.", + "example": "test", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the job.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the job in the CI provider UI.", + "example": "https://ci-platform.com/job/your-job-name/build/123", + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status", + "url" + ], + "type": "object" + }, + { + "description": "Details of a CI step.", + "properties": { + "end": { + "description": "Time when the step run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "UUID for the step. It has to be unique within each pipeline execution.", + "example": "c2d517a8-4f3a-4b41-b4ae-69df0c864c79", + "type": "string" + }, + "job_id": { + "description": "The parent job UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "job_name": { + "description": "The parent job name (if applicable).", + "nullable": true, + "type": "string" + }, + "level": { + "default": "step", + "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "enum": [ + "step" + ], + "example": "step", + "type": "string", + "x-enum-varnames": [ + "STEP" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the step.", + "example": "test-server", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the step run started. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the step.", + "enum": [ + "success", + "error" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the step in the CI provider UI.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status" + ], + "type": "object" + } + ] + }, + "service": { + "description": "If the CI provider is SaaS, use this to differentiate between instances.", + "type": "string" + } + }, + "required": [ + "resource" + ], + "type": "object" + }, + "type": { + "default": "cipipeline_resource_request", + "description": "Type of the event.", + "enum": [ + "cipipeline_resource_request" + ], + "example": "cipipeline_resource_request", + "type": "string", + "x-enum-varnames": [ + "CIPIPELINE_RESOURCE_REQUEST" + ] + } + }, + "type": "object" + }, + "CIAppCreatePipelineEventRequestDataType": { + "default": "cipipeline_resource_request", + "description": "Type of the event.", + "enum": [ + "cipipeline_resource_request" + ], + "example": "cipipeline_resource_request", + "type": "string", + "x-enum-varnames": [ + "CIPIPELINE_RESOURCE_REQUEST" + ] + }, + "CIAppEventAttributes": { + "description": "JSON object containing all event attributes and their associated values.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "JSON object of attributes from CI Visibility test events.", + "example": { + "customAttribute": 123, + "duration": 2345 + }, + "type": "object" + }, + "tags": { + "description": "Array of tags associated with your event.", + "example": [ + "team:A" + ], + "items": { + "description": "Tag associated with your event.", + "type": "string" + }, + "type": "array" + }, + "test_level": { + "description": "Test run level.", + "enum": [ + "session", + "module", + "suite", + "test" + ], + "example": "test", + "type": "string", + "x-enum-varnames": [ + "SESSION", + "MODULE", + "SUITE", + "TEST" + ] + } + }, + "type": "object" + }, + "CIAppGitInfo": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "CIAppGroupByHistogram": { + "description": "Used to perform a histogram computation (only for measure facets).\nAt most, 100 buckets are allowed, the number of buckets is `(max - min)/interval`.", + "properties": { + "interval": { + "description": "The bin size of the histogram buckets.", + "example": 10, + "format": "double", + "type": "number" + }, + "max": { + "description": "The maximum value for the measure used in the histogram\n(values greater than this one are filtered out).", + "example": 100, + "format": "double", + "type": "number" + }, + "min": { + "description": "The minimum value for the measure used in the histogram\n(values smaller than this one are filtered out).", + "example": 50, + "format": "double", + "type": "number" + } + }, + "required": [ + "interval", + "min", + "max" + ], + "type": "object" + }, + "CIAppGroupByMissing": { + "description": "The value to use for logs that don't have the facet used to group-by.", + "oneOf": [ + { + "description": "The missing value to use if there is a string valued facet.", + "type": "string" + }, + { + "description": "The missing value to use if there is a number valued facet.", + "format": "double", + "type": "number" + } + ] + }, + "CIAppGroupByMissingNumber": { + "description": "The missing value to use if there is a number valued facet.", + "format": "double", + "type": "number" + }, + "CIAppGroupByMissingString": { + "description": "The missing value to use if there is a string valued facet.", + "type": "string" + }, + "CIAppGroupByTotal": { + "default": false, + "description": "A resulting object to put the given computes in over all the matching records.", + "oneOf": [ + { + "description": "If set to true, creates an additional bucket labeled \"$facet_total\".", + "type": "boolean" + }, + { + "description": "A string to use as the key value for the total bucket.", + "type": "string" + }, + { + "description": "A number to use as the key value for the total bucket.", + "format": "double", + "type": "number" + } + ] + }, + "CIAppGroupByTotalBoolean": { + "description": "If set to true, creates an additional bucket labeled \"$facet_total\".", + "type": "boolean" + }, + "CIAppGroupByTotalNumber": { + "description": "A number to use as the key value for the total bucket.", + "format": "double", + "type": "number" + }, + "CIAppGroupByTotalString": { + "description": "A string to use as the key value for the total bucket.", + "type": "string" + }, + "CIAppHostInfo": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "CIAppPipelineEvent": { + "description": "Object description of a pipeline event after being processed and stored by Datadog.", + "properties": { + "attributes": { + "description": "JSON object containing all event attributes and their associated values.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "JSON object of attributes from CI Visibility pipeline events.", + "example": { + "customAttribute": 123, + "duration": 2345 + }, + "type": "object" + }, + "ci_level": { + "description": "Pipeline execution level.", + "enum": [ + "pipeline", + "stage", + "job", + "step", + "custom" + ], + "example": "pipeline", + "type": "string", + "x-enum-varnames": [ + "PIPELINE", + "STAGE", + "JOB", + "STEP", + "CUSTOM" + ] + }, + "tags": { + "description": "Array of tags associated with your event.", + "example": [ + "team:A" + ], + "items": { + "description": "Tag associated with your event.", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "Unique ID of the event.", + "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", + "type": "string" + }, + "type": { + "description": "Type of the event.", + "enum": [ + "cipipeline" + ], + "example": "cipipeline", + "type": "string", + "x-enum-varnames": [ + "CIPIPELINE" + ] + } + }, + "type": "object" + }, + "CIAppPipelineEventAttributes": { + "description": "JSON object containing all event attributes and their associated values.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "JSON object of attributes from CI Visibility pipeline events.", + "example": { + "customAttribute": 123, + "duration": 2345 + }, + "type": "object" + }, + "ci_level": { + "description": "Pipeline execution level.", + "enum": [ + "pipeline", + "stage", + "job", + "step", + "custom" + ], + "example": "pipeline", + "type": "string", + "x-enum-varnames": [ + "PIPELINE", + "STAGE", + "JOB", + "STEP", + "CUSTOM" + ] + }, + "tags": { + "description": "Array of tags associated with your event.", + "example": [ + "team:A" + ], + "items": { + "description": "Tag associated with your event.", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CIAppPipelineEventJob": { + "description": "Details of a CI job.", + "properties": { + "dependencies": { + "description": "A list of job IDs that this job depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of job IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the job run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "The UUID for the job. It has to be unique within each pipeline execution.", + "example": "c865bad4-de82-44b8-ade7-2c987528eb54", + "type": "string" + }, + "level": { + "default": "job", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "job" + ], + "example": "job", + "type": "string", + "x-enum-varnames": [ + "JOB" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the job.", + "example": "test", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the job.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the job in the CI provider UI.", + "example": "https://ci-platform.com/job/your-job-name/build/123", + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status", + "url" + ], + "type": "object" + }, + "CIAppPipelineEventJobLevel": { + "default": "job", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "job" + ], + "example": "job", + "type": "string", + "x-enum-varnames": [ + "JOB" + ] + }, + "CIAppPipelineEventJobStatus": { + "description": "The final status of the job.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "CIAppPipelineEventMetrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "CIAppPipelineEventParameters": { "additionalProperties": { "type": "string" }, @@ -177941,6 +182502,77 @@ } }, "type": "object" + }, + "XRayServicesIncludeAll": { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + "XRayServicesIncludeOnly": { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + }, + "XRayServicesList": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] } }, "securitySchemes": { @@ -217408,9 +222040,938 @@ } } }, - "description": "Schedule a downtime request body.", - "required": true - }, + "description": "Schedule a downtime request body.", + "required": true + }, + "responses": { + "200": { + "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.", + "properties": { + "data": { + "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" + }, + { + "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 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": { + "default": "downtime", + "description": "Downtime resource type.", + "enum": [ + "downtime" + ], + "example": "downtime", + "type": "string", + "x-enum-varnames": [ + "DOWNTIME" + ] + } + }, + "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" + } + } + }, + "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" + }, + "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": "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.", + "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" + }, + "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": "Cancel a downtime", + "tags": [ + "Downtimes" + ], + "x-menu-order": 4, + "x-permission": { + "operator": "OR", + "permissions": [ + "monitors_downtime" + ] + }, + "x-undo": { + "type": "idempotent" + } + }, + "get": { + "description": "Get downtime detail by `downtime_id`.", + "operationId": "GetDowntime", + "parameters": [ + { + "description": "ID of the downtime to fetch.", + "in": "path", + "name": "downtime_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`.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "example": "created_by,monitor", + "type": "string" + } + } + ], "responses": { "200": { "content": { @@ -218109,129 +223670,6 @@ }, "description": "Forbidden" }, - "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": "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.", - "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" - }, - "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": { @@ -218258,7 +223696,7 @@ } } }, - "description": "Downtime not found" + "description": "Not Found" }, "429": { "content": { @@ -218300,11 +223738,11 @@ ] } ], - "summary": "Cancel a downtime", + "summary": "Get a downtime", "tags": [ "Downtimes" ], - "x-menu-order": 4, + "x-menu-order": 5, "x-permission": { "operator": "OR", "permissions": [ @@ -218312,34 +223750,257 @@ ] }, "x-undo": { - "type": "idempotent" + "type": "safe" } }, - "get": { - "description": "Get downtime detail by `downtime_id`.", - "operationId": "GetDowntime", + "patch": { + "description": "Update a downtime by `downtime_id`.", + "operationId": "UpdateDowntime", "parameters": [ { - "description": "ID of the downtime to fetch.", + "description": "ID of the downtime to update.", "in": "path", "name": "downtime_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`.", - "in": "query", - "name": "include", - "required": false, - "schema": { - "example": "created_by,monitor", + "example": "00e000000-0000-1234-0000-000000000000", "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request for editing a downtime.", + "properties": { + "data": { + "description": "Object to update a downtime.", + "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", + "type": "string" + }, + "type": { + "default": "downtime", + "description": "Downtime resource type.", + "enum": [ + "downtime" + ], + "example": "downtime", + "type": "string", + "x-enum-varnames": [ + "DOWNTIME" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Update a downtime request body.", + "required": true + }, "responses": { "200": { "content": { @@ -219064,7 +224725,7 @@ } } }, - "description": "Not Found" + "description": "Downtime not found" }, "429": { "content": { @@ -219106,11 +224767,12 @@ ] } ], - "summary": "Get a downtime", + "summary": "Update a downtime", "tags": [ "Downtimes" ], - "x-menu-order": 5, + "x-codegen-request-body-name": "body", + "x-menu-order": 6, "x-permission": { "operator": "OR", "permissions": [ @@ -219118,891 +224780,1002 @@ ] }, "x-undo": { - "type": "safe" + "type": "idempotent" } - }, - "patch": { - "description": "Update a downtime by `downtime_id`.", - "operationId": "UpdateDowntime", + } + }, + "/api/v2/events": { + "get": { + "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.", + "operationId": "ListEvents", "parameters": [ { - "description": "ID of the downtime to update.", - "in": "path", - "name": "downtime_id", - "required": true, + "description": "Search query following events syntax.", + "in": "query", + "name": "filter[query]", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Minimum timestamp for requested events, in milliseconds.", + "in": "query", + "name": "filter[from]", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Maximum timestamp for requested events, in milliseconds.", + "in": "query", + "name": "filter[to]", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Order of events in results.", + "in": "query", + "name": "sort", + "required": false, + "schema": { + "description": "The sort parameters when querying events.", + "enum": [ + "timestamp", + "-timestamp" + ], + "type": "string", + "x-enum-varnames": [ + "TIMESTAMP_ASCENDING", + "TIMESTAMP_DESCENDING" + ] + } + }, + { + "description": "List following results with a cursor provided in the previous query.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "in": "query", + "name": "page[cursor]", + "required": false, "schema": { - "example": "00e000000-0000-1234-0000-000000000000", "type": "string" } + }, + { + "description": "Maximum number of events in the response.", + "example": 25, + "in": "query", + "name": "page[limit]", + "required": false, + "schema": { + "default": 10, + "format": "int32", + "maximum": 1000, + "type": "integer" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Request for editing a downtime.", - "properties": { - "data": { - "description": "Object to update a downtime.", - "properties": { - "attributes": { - "description": "Attributes of the downtime to update.", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The response object with all events matching the request and pagination information.", + "properties": { + "data": { + "description": "An array of events matching the request.", + "items": { + "description": "The object description of an event after being processed and stored by Datadog.", "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.", + "attributes": { + "description": "The object description of an event response attribute.", + "properties": { + "attributes": { + "description": "Object description of attributes from your event.", "properties": { - "monitor_id": { - "description": "ID of the monitor to prevent notifications.", - "example": 123, + "aggregation_key": { + "description": "Aggregation key of the event.", + "type": "string" + }, + "date_happened": { + "description": "POSIX timestamp of the event. Must be sent as an integer (no quotation marks).\nLimited to events no older than 18 hours.", "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" + }, + "device_name": { + "description": "A device name.", + "type": "string" + }, + "duration": { + "description": "The duration between the triggering of the event and its recovery in nanoseconds.", + "format": "int64", + "type": "integer" + }, + "event_object": { + "description": "The event title.", + "example": "Did you hear the news today?", + "type": "string" + }, + "evt": { + "description": "The metadata associated with a request.", + "properties": { + "id": { + "description": "Event ID.", + "example": "6509751066204996294", + "type": "string" + }, + "name": { + "description": "The event name.", + "type": "string" + }, + "source_id": { + "description": "Event source ID.", + "example": 36, + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Event type.", + "example": "error_tracking_alert", + "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": "object" + }, + "hostname": { + "description": "Host name to associate with the event.\nAny tags associated with the host are also applied to this event.", + "type": "string" + }, + "monitor": { + "description": "Attributes from the monitor that triggered the event.", + "nullable": true, + "properties": { + "created_at": { + "description": "The POSIX timestamp of the monitor's creation in nanoseconds.", + "example": 1646318692000, + "format": "int64", + "type": "integer" + }, + "group_status": { + "description": "Monitor group status used when there is no `result_groups`.", + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "groups": { + "description": "Groups to which the monitor belongs.", + "items": { + "description": "A group.", "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": "array" + }, + "id": { + "description": "The monitor ID.", + "format": "int64", + "type": "integer" + }, + "message": { + "description": "The monitor message.", + "type": "string" + }, + "modified": { + "description": "The monitor's last-modified timestamp.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The monitor name.", + "type": "string" + }, + "query": { + "description": "The query that triggers the alert.", + "type": "string" + }, + "tags": { + "description": "A list of tags attached to the monitor.", + "example": [ + "environment:test" + ], + "items": { + "description": "A tag.", "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" - } + "type": "array" }, - "required": [ - "duration", - "rrule" - ], - "type": "object" + "templated_name": { + "description": "The templated name of the monitor before resolving any template variables.", + "type": "string" + }, + "type": { + "description": "The monitor type.", + "type": "string" + } + }, + "type": "object" + }, + "monitor_groups": { + "description": "List of groups referred to in the event.", + "items": { + "description": "Group referred to in the event.", + "type": "string" }, + "nullable": true, "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", + "monitor_id": { + "description": "ID of the monitor that triggered the event. When an event isn't related to a monitor, this field is empty.", + "format": "int64", "nullable": true, - "type": "string" + "type": "integer" }, - "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", + "priority": { + "description": "The priority of the event's monitor. For example, `normal` or `low`.", + "enum": [ + "normal", + "low" + ], + "example": "normal", "nullable": true, + "type": "string", + "x-enum-varnames": [ + "NORMAL", + "LOW" + ] + }, + "related_event_id": { + "description": "Related event ID.", + "format": "int64", + "type": "integer" + }, + "service": { + "description": "Service that triggered the event.", + "example": "datadog-api", + "type": "string" + }, + "source_type_name": { + "description": "The type of event being posted.\nFor example, `nagios`, `hudson`, `jenkins`, `my_apps`, `chef`, `puppet`, `git` or `bitbucket`.\nThe list of standard source attribute values is [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).", + "type": "string" + }, + "sourcecategory": { + "description": "Identifier for the source of the event, such as a monitor alert, an externally-submitted event, or an integration.", + "type": "string" + }, + "status": { + "description": "If an alert event is enabled, its status is one of the following:\n`failure`, `error`, `warning`, `info`, `success`, `user_update`,\n`recommendation`, or `snapshot`.", + "enum": [ + "failure", + "error", + "warning", + "info", + "success", + "user_update", + "recommendation", + "snapshot" + ], + "example": "info", + "type": "string", + "x-enum-varnames": [ + "FAILURE", + "ERROR", + "WARNING", + "INFO", + "SUCCESS", + "USER_UPDATE", + "RECOMMENDATION", + "SNAPSHOT" + ] + }, + "tags": { + "description": "A list of tags to apply to the event.", + "example": [ + "environment:test" + ], + "items": { + "description": "A tag.", + "type": "string" + }, + "type": "array" + }, + "timestamp": { + "description": "POSIX timestamp of your event in milliseconds.", + "example": 1652274265000, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The event title.", + "example": "Oh boy!", "type": "string" } }, "type": "object" + }, + "message": { + "description": "The message of the event.", + "type": "string" + }, + "tags": { + "description": "An array of tags associated with the event.", + "example": [ + "team:A" + ], + "items": { + "description": "The tag associated with the event.", + "type": "string" + }, + "type": "array" + }, + "timestamp": { + "description": "The timestamp of the event.", + "example": "2019-01-02T09:42:36.320Z", + "format": "date-time", + "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", + "id": { + "description": "the unique ID of the event.", + "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", "type": "string" + }, + "type": { + "default": "event", + "description": "Type of the event.", + "enum": [ + "event" + ], + "example": "event", + "type": "string", + "x-enum-varnames": [ + "EVENT" + ] } }, "type": "object" }, - "id": { - "description": "ID of this downtime.", - "example": "00000000-0000-1234-0000-000000000000", + "type": "array" + }, + "links": { + "description": "Links attributes.", + "properties": { + "next": { + "description": "Link for the next set of results. Note that the request can also be made using the\nPOST endpoint.", + "example": "https://app.datadoghq.com/api/v2/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "description": "The metadata associated with a request.", + "properties": { + "elapsed": { + "description": "The time elapsed in milliseconds.", + "example": 132, + "format": "int64", + "type": "integer" + }, + "page": { + "description": "Pagination attributes.", + "properties": { + "after": { + "description": "The cursor to use to get the next results, if any. To make the next request, use the same\nparameters with the addition of the `page[cursor]`.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + } + }, + "type": "object" + }, + "request_id": { + "description": "The identifier of the request.", + "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", + "type": "string" + }, + "status": { + "description": "The request status.", + "example": "done", + "type": "string" + }, + "warnings": { + "description": "A list of warnings (non-fatal errors) encountered. Partial results might be returned if\nwarnings are present in the response.", + "items": { + "description": "A warning message indicating something is wrong with the query.", + "properties": { + "code": { + "description": "A unique code for this type of warning.", + "example": "unknown_index", + "type": "string" + }, + "detail": { + "description": "A detailed explanation of this specific warning.", + "example": "indexes: foo, bar", + "type": "string" + }, + "title": { + "description": "A short human-readable summary of the warning.", + "example": "One or several indexes are missing or invalid. Results hold data from the other indexes.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "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": "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": { - "default": "downtime", - "description": "Downtime resource type.", - "enum": [ - "downtime" - ], - "example": "downtime", - "type": "string", - "x-enum-varnames": [ - "DOWNTIME" - ] + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "events_read" + ] + } + ], + "summary": "Get a list of events", + "tags": [ + "Events" + ], + "x-menu-order": 1, + "x-pagination": { + "cursorParam": "page[cursor]", + "cursorPath": "meta.page.after", + "limitParam": "page[limit]", + "resultsPath": "data" + }, + "x-permission": { + "operator": "OR", + "permissions": [ + "events_read" + ] + }, + "x-undo": { + "type": "safe" + } + }, + "x-merge-override": { + "get": false + } + }, + "/api/v2/events/search": { + "post": { + "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 build complex events filtering and search.", + "operationId": "SearchEvents", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "The object sent with the request to retrieve a list of events from your organization.", + "properties": { + "filter": { + "description": "The search and filter query settings.", + "properties": { + "from": { + "default": "now-15m", + "description": "The minimum time for the requested events. Supports date math and regular timestamps in milliseconds.", + "example": "now-15m", + "type": "string" + }, + "query": { + "default": "*", + "description": "The search query following the event search syntax.", + "example": "service:web* AND @http.status_code:[200 TO 299]", + "type": "string" + }, + "to": { + "default": "now", + "description": "The maximum time for the requested events. Supports date math and regular timestamps in milliseconds.", + "example": "now", + "type": "string" + } + }, + "type": "object" + }, + "options": { + "description": "The global query options that are used. Either provide a timezone or a time offset but not both,\notherwise the query fails.", + "properties": { + "timeOffset": { + "description": "The time offset to apply to the query in seconds.", + "format": "int64", + "type": "integer" + }, + "timezone": { + "default": "UTC", + "description": "The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).", + "example": "GMT", + "type": "string" + } + }, + "type": "object" + }, + "page": { + "description": "Pagination settings.", + "properties": { + "cursor": { + "description": "The returned paging point to use to get the next results.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + }, + "limit": { + "default": 10, + "description": "The maximum number of logs in the response.", + "example": 25, + "format": "int32", + "maximum": 1000, + "type": "integer" } }, - "required": [ - "id", - "type", - "attributes" - ], "type": "object" + }, + "sort": { + "description": "The sort parameters when querying events.", + "enum": [ + "timestamp", + "-timestamp" + ], + "type": "string", + "x-enum-varnames": [ + "TIMESTAMP_ASCENDING", + "TIMESTAMP_DESCENDING" + ] } }, - "required": [ - "data" - ], "type": "object" } } }, - "description": "Update a downtime request body.", - "required": true + "required": false }, "responses": { "200": { "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": "The response object with all events matching the request and pagination information.", "properties": { "data": { - "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" - } + "description": "An array of events matching the request.", + "items": { + "description": "The object description of an event after being processed and stored by Datadog.", + "properties": { + "attributes": { + "description": "The object description of an event response attribute.", + "properties": { + "attributes": { + "description": "Object description of attributes from your event.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "type": "string" }, - "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", + "date_happened": { + "description": "POSIX timestamp of the event. Must be sent as an integer (no quotation marks).\nLimited to events no older than 18 hours.", + "format": "int64", + "type": "integer" + }, + "device_name": { + "description": "A device name.", + "type": "string" + }, + "duration": { + "description": "The duration between the triggering of the event and its recovery in nanoseconds.", + "format": "int64", + "type": "integer" + }, + "event_object": { + "description": "The event title.", + "example": "Did you hear the news today?", + "type": "string" + }, + "evt": { + "description": "The metadata associated with a request.", + "properties": { + "id": { + "description": "Event ID.", + "example": "6509751066204996294", "type": "string" }, - "minItems": 1, - "type": "array" - } + "name": { + "description": "The event name.", + "type": "string" + }, + "source_id": { + "description": "Event source ID.", + "example": 36, + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Event type.", + "example": "error_tracking_alert", + "type": "string" + } + }, + "type": "object" }, - "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, + "hostname": { + "description": "Host name to associate with the event.\nAny tags associated with the host are also applied to this event.", + "type": "string" + }, + "monitor": { + "description": "Attributes from the monitor that triggered the event.", + "nullable": true, + "properties": { + "created_at": { + "description": "The POSIX timestamp of the monitor's creation in nanoseconds.", + "example": 1646318692000, + "format": "int64", + "type": "integer" + }, + "group_status": { + "description": "Monitor group status used when there is no `result_groups`.", + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "groups": { + "description": "Groups to which the monitor belongs.", + "items": { + "description": "A group.", "type": "string" }, - "start": { - "description": "The start of the current downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "type": "string" - } + "type": "array" }, - "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" - } + "id": { + "description": "The monitor ID.", + "format": "int64", + "type": "integer" + }, + "message": { + "description": "The monitor message.", + "type": "string" + }, + "modified": { + "description": "The monitor's last-modified timestamp.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The monitor name.", + "type": "string" + }, + "query": { + "description": "The query that triggers the alert.", + "type": "string" + }, + "tags": { + "description": "A list of tags attached to the monitor.", + "example": [ + "environment:test" + ], + "items": { + "description": "A tag.", + "type": "string" }, - "type": "object" + "type": "array" }, - "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 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" + "templated_name": { + "description": "The templated name of the monitor before resolving any template variables.", + "type": "string" + }, + "type": { + "description": "The monitor type.", + "type": "string" + } }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } + "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", + "monitor_groups": { + "description": "List of groups referred to in the event.", + "items": { + "description": "Group referred to in the event.", "type": "string" }, - "type": { - "default": "monitors", - "description": "Monitor resource type.", - "enum": [ - "monitors" - ], - "example": "monitors", - "type": "string", - "x-enum-varnames": [ - "MONITORS" - ] - } + "nullable": true, + "type": "array" }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "downtime", - "description": "Downtime resource type.", - "enum": [ - "downtime" - ], - "example": "downtime", - "type": "string", - "x-enum-varnames": [ - "DOWNTIME" - ] - } - }, - "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" + "monitor_id": { + "description": "ID of the monitor that triggered the event. When an event isn't related to a monitor, this field is empty.", + "format": "int64", + "nullable": true, + "type": "integer" }, - "disabled": { - "description": "Whether the user is disabled.", - "type": "boolean" + "priority": { + "description": "The priority of the event's monitor. For example, `normal` or `low`.", + "enum": [ + "normal", + "low" + ], + "example": "normal", + "nullable": true, + "type": "string", + "x-enum-varnames": [ + "NORMAL", + "LOW" + ] }, - "email": { - "description": "Email of the user.", - "type": "string" + "related_event_id": { + "description": "Related event ID.", + "format": "int64", + "type": "integer" }, - "handle": { - "description": "Handle of the user.", + "service": { + "description": "Service that triggered the event.", + "example": "datadog-api", "type": "string" }, - "icon": { - "description": "URL of the user's icon.", + "source_type_name": { + "description": "The type of event being posted.\nFor example, `nagios`, `hudson`, `jenkins`, `my_apps`, `chef`, `puppet`, `git` or `bitbucket`.\nThe list of standard source attribute values is [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).", "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", + "sourcecategory": { + "description": "Identifier for the source of the event, such as a monitor alert, an externally-submitted event, or an integration.", "type": "string" }, - "name": { - "description": "Name of the user.", - "nullable": true, - "type": "string" + "status": { + "description": "If an alert event is enabled, its status is one of the following:\n`failure`, `error`, `warning`, `info`, `success`, `user_update`,\n`recommendation`, or `snapshot`.", + "enum": [ + "failure", + "error", + "warning", + "info", + "success", + "user_update", + "recommendation", + "snapshot" + ], + "example": "info", + "type": "string", + "x-enum-varnames": [ + "FAILURE", + "ERROR", + "WARNING", + "INFO", + "SUCCESS", + "USER_UPDATE", + "RECOMMENDATION", + "SNAPSHOT" + ] }, - "service_account": { - "description": "Whether the user is a service account.", - "type": "boolean" + "tags": { + "description": "A list of tags to apply to the event.", + "example": [ + "environment:test" + ], + "items": { + "description": "A tag.", + "type": "string" + }, + "type": "array" }, - "status": { - "description": "Status of the user.", - "type": "string" + "timestamp": { + "description": "POSIX timestamp of your event in milliseconds.", + "example": 1652274265000, + "format": "int64", + "type": "integer" }, "title": { - "description": "Title of the user.", - "nullable": true, + "description": "The event title.", + "example": "Oh boy!", "type": "string" - }, - "verified": { - "description": "Whether the user is verified.", - "type": "boolean" } }, "type": "object" }, - "id": { - "description": "ID of the user.", + "message": { + "description": "The message of the event.", "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 - } - } + "tags": { + "description": "An array of tags associated with the event.", + "example": [ + "team:A" + ], + "items": { + "description": "The tag associated with the event.", + "type": "string" }, - "type": "object", - "x-merge-override": { - "properties": false - } + "type": "array" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "timestamp": { + "description": "The timestamp of the event.", + "example": "2019-01-02T09:42:36.320Z", + "format": "date-time", + "type": "string" } }, - "type": "object", - "x-merge-override": { - "required": false + "type": "object" + }, + "id": { + "description": "the unique ID of the event.", + "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", + "type": "string" + }, + "type": { + "default": "event", + "description": "Type of the event.", + "enum": [ + "event" + ], + "example": "event", + "type": "string", + "x-enum-varnames": [ + "EVENT" + ] + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "description": "Links attributes.", + "properties": { + "next": { + "description": "Link for the next set of results. Note that the request can also be made using the\nPOST endpoint.", + "example": "https://app.datadoghq.com/api/v2/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "description": "The metadata associated with a request.", + "properties": { + "elapsed": { + "description": "The time elapsed in milliseconds.", + "example": 132, + "format": "int64", + "type": "integer" + }, + "page": { + "description": "Pagination attributes.", + "properties": { + "after": { + "description": "The cursor to use to get the next results, if any. To make the next request, use the same\nparameters with the addition of the `page[cursor]`.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" } }, - { - "description": "Information about the monitor identified by the downtime.", + "type": "object" + }, + "request_id": { + "description": "The identifier of the request.", + "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", + "type": "string" + }, + "status": { + "description": "The request status.", + "example": "done", + "type": "string" + }, + "warnings": { + "description": "A list of warnings (non-fatal errors) encountered. Partial results might be returned if\nwarnings are present in the response.", + "items": { + "description": "A warning message indicating something is wrong with the query.", "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" + "code": { + "description": "A unique code for this type of warning.", + "example": "unknown_index", + "type": "string" }, - "id": { - "description": "ID of the monitor identified by the downtime.", - "example": 12345, - "format": "int64", - "type": "integer" + "detail": { + "description": "A detailed explanation of this specific warning.", + "example": "indexes: foo, bar", + "type": "string" }, - "type": { - "default": "monitors", - "description": "Monitor resource type.", - "enum": [ - "monitors" - ], - "example": "monitors", - "type": "string", - "x-enum-varnames": [ - "MONITORS" - ] + "title": { + "description": "A short human-readable summary of the warning.", + "example": "One or several indexes are missing or invalid. Results hold data from the other indexes.", + "type": "string" } }, "type": "object" - } - ] + }, + "type": "array" + } }, - "type": "array" + "type": "object" } }, "type": "object" @@ -220065,35 +225838,7 @@ } } }, - "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" + "description": "Not Authorized" }, "429": { "content": { @@ -220124,104 +225869,80 @@ "description": "Too many requests" } }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "monitors_downtime" - ] - } - ], - "summary": "Update a downtime", + "summary": "Search events", "tags": [ - "Downtimes" + "Events" ], "x-codegen-request-body-name": "body", - "x-menu-order": 6, + "x-menu-order": 2, + "x-pagination": { + "cursorParam": "body.page.cursor", + "cursorPath": "meta.page.after", + "limitParam": "body.page.limit", + "resultsPath": "data" + }, "x-permission": { "operator": "OR", "permissions": [ - "monitors_downtime" + "events_read" ] }, "x-undo": { - "type": "idempotent" + "type": "safe" } + }, + "x-merge-override": { + "post": false } }, - "/api/v2/events": { + "/api/v2/incidents": { "get": { - "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.", - "operationId": "ListEvents", + "description": "Get all incidents for the user's organization.", + "operationId": "ListIncidents", "parameters": [ { - "description": "Search query following events syntax.", - "in": "query", - "name": "filter[query]", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Minimum timestamp for requested events, in milliseconds.", - "in": "query", - "name": "filter[from]", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Maximum timestamp for requested events, in milliseconds.", - "in": "query", - "name": "filter[to]", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Order of events in results.", + "description": "Specifies which types of related objects should be included in the response.", + "explode": false, "in": "query", - "name": "sort", + "name": "include", "required": false, "schema": { - "description": "The sort parameters when querying events.", - "enum": [ - "timestamp", - "-timestamp" - ], - "type": "string", - "x-enum-varnames": [ - "TIMESTAMP_ASCENDING", - "TIMESTAMP_DESCENDING" - ] + "items": { + "description": "Object related to an incident.", + "enum": [ + "users", + "attachments" + ], + "type": "string", + "x-enum-varnames": [ + "USERS", + "ATTACHMENTS" + ] + }, + "type": "array" } }, { - "description": "List following results with a cursor provided in the previous query.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "description": "Size for a given page. The maximum allowed value is 100.", "in": "query", - "name": "page[cursor]", + "name": "page[size]", "required": false, "schema": { - "type": "string" + "default": 10, + "example": 10, + "format": "int64", + "type": "integer" } }, { - "description": "Maximum number of events in the response.", - "example": 25, + "description": "Specific offset to use as the beginning of the returned page.", "in": "query", - "name": "page[limit]", + "name": "page[offset]", "required": false, "schema": { - "default": 10, - "format": "int32", - "maximum": 1000, + "default": 0, + "example": 0, + "format": "int64", "type": "integer" } } @@ -220231,353 +225952,1096 @@ "content": { "application/json": { "schema": { - "description": "The response object with all events matching the request and pagination information.", + "description": "Response with a list of incidents.", "properties": { "data": { - "description": "An array of events matching the request.", + "description": "An array of incidents.", + "example": [ + { + "attributes": { + "created": "2020-04-21T15:34:08.627205+00:00", + "creation_idempotency_key": null, + "customer_impact_duration": 0, + "customer_impact_end": null, + "customer_impact_scope": null, + "customer_impact_start": null, + "customer_impacted": false, + "detected": "2020-04-14T00:00:00+00:00", + "incident_type_uuid": "00000000-0000-0000-0000-000000000001", + "modified": "2020-09-17T14:16:58.696424+00:00", + "public_id": 1, + "resolved": null, + "severity": "SEV-1", + "time_to_detect": 0, + "time_to_internal_response": 0, + "time_to_repair": 0, + "time_to_resolve": 0, + "title": "Example Incident" + }, + "id": "00000000-aaaa-0000-0000-000000000000", + "relationships": { + "attachments": { + "data": [ + { + "id": "00000000-9999-0000-0000-000000000000", + "type": "incident_attachments" + }, + { + "id": "00000000-1234-0000-0000-000000000000", + "type": "incident_attachments" + } + ] + }, + "commander_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + }, + "created_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + }, + "integrations": { + "data": [ + { + "id": "00000000-0000-0000-4444-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-0000-0000-5555-000000000000", + "type": "incident_integrations" + } + ] + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + } + }, + "type": "incidents" + }, + { + "attributes": { + "created": "2020-04-21T15:34:08.627205+00:00", + "creation_idempotency_key": null, + "customer_impact_duration": 0, + "customer_impact_end": null, + "customer_impact_scope": null, + "customer_impact_start": null, + "customer_impacted": false, + "detected": "2020-04-14T00:00:00+00:00", + "incident_type_uuid": "00000000-0000-0000-0000-000000000002", + "modified": "2020-09-17T14:16:58.696424+00:00", + "public_id": 2, + "resolved": null, + "severity": "SEV-5", + "time_to_detect": 0, + "time_to_internal_response": 0, + "time_to_repair": 0, + "time_to_resolve": 0, + "title": "Example Incident 2" + }, + "id": "00000000-1111-0000-0000-000000000000", + "relationships": { + "attachments": { + "data": [ + { + "id": "00000000-9999-0000-0000-000000000000", + "type": "incident_attachments" + } + ] + }, + "commander_user": { + "data": { + "id": "00000000-aaaa-0000-0000-000000000000", + "type": "users" + } + }, + "created_by_user": { + "data": { + "id": "00000000-aaaa-0000-0000-000000000000", + "type": "users" + } + }, + "integrations": { + "data": [ + { + "id": "00000000-0000-0000-0001-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-0000-0000-0002-000000000000", + "type": "incident_integrations" + } + ] + }, + "last_modified_by_user": { + "data": { + "id": "00000000-aaaa-0000-0000-000000000000", + "type": "users" + } + } + }, + "type": "incidents" + } + ], "items": { - "description": "The object description of an event after being processed and stored by Datadog.", + "description": "Incident data from a response.", "properties": { "attributes": { - "description": "The object description of an event response attribute.", + "description": "The incident's attributes from a response.", "properties": { - "attributes": { - "description": "Object description of attributes from your event.", + "archived": { + "description": "Timestamp of when the incident was archived.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "case_id": { + "description": "The incident case id.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "created": { + "description": "Timestamp when the incident was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "customer_impact_duration": { + "description": "Length of the incident's customer impact in seconds.\nEquals the difference between `customer_impact_start` and `customer_impact_end`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "customer_impact_end": { + "description": "Timestamp when customers were no longer impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impact_scope": { + "description": "A summary of the impact customers experienced during the incident.", + "example": "An example customer impact scope", + "nullable": true, + "type": "string" + }, + "customer_impact_start": { + "description": "Timestamp when customers began being impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impacted": { + "description": "A flag indicating whether the incident caused customer impact.", + "example": false, + "type": "boolean" + }, + "detected": { + "description": "Timestamp when the incident was detected.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "fields": { + "additionalProperties": { + "description": "Dynamic fields for which selections can be made, with field names as keys.", + "oneOf": [ + { + "description": "A field with a single value selected.", + "properties": { + "type": { + "default": "dropdown", + "description": "Type of the single value field definitions.", + "enum": [ + "dropdown", + "textbox" + ], + "example": "dropdown", + "type": "string", + "x-enum-varnames": [ + "DROPDOWN", + "TEXTBOX" + ] + }, + "value": { + "description": "The single value selected for this field.", + "example": "SEV-1", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + { + "description": "A field with potentially multiple values selected.", + "properties": { + "type": { + "default": "multiselect", + "description": "Type of the multiple value field definitions.", + "enum": [ + "multiselect", + "textarray", + "metrictag", + "autocomplete" + ], + "example": "multiselect", + "type": "string", + "x-enum-varnames": [ + "MULTISELECT", + "TEXTARRAY", + "METRICTAG", + "AUTOCOMPLETE" + ] + }, + "value": { + "description": "The multiple values selected for this field.", + "example": [ + "1.0", + "1.1" + ], + "items": { + "description": "A value which has been selected for the parent field.", + "example": "1.1", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "description": "A condensed view of the user-defined fields attached to incidents.", + "example": { + "severity": { + "type": "dropdown", + "value": "SEV-5" + } + }, + "type": "object" + }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "modified": { + "description": "Timestamp when the incident was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "non_datadog_creator": { + "description": "Incident's non Datadog creator.", + "nullable": true, "properties": { - "aggregation_key": { - "description": "Aggregation key of the event.", + "image_48_px": { + "description": "Non Datadog creator `48px` image.", "type": "string" }, - "date_happened": { - "description": "POSIX timestamp of the event. Must be sent as an integer (no quotation marks).\nLimited to events no older than 18 hours.", - "format": "int64", - "type": "integer" + "name": { + "description": "Non Datadog creator name.", + "type": "string" + } + }, + "type": "object" + }, + "notification_handles": { + "description": "Notification handles that will be notified of the incident during update.", + "example": [ + { + "display_name": "Jane Doe", + "handle": "@user@email.com" }, - "device_name": { - "description": "A device name.", + { + "display_name": "Slack Channel", + "handle": "@slack-channel" + }, + { + "display_name": "Incident Workflow", + "handle": "@workflow-from-incident" + } + ], + "items": { + "description": "A notification handle that will be notified at incident creation.", + "properties": { + "display_name": { + "description": "The name of the notified handle.", + "example": "Jane Doe", + "type": "string" + }, + "handle": { + "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", + "example": "@test.user@test.com", + "type": "string" + } + }, + "type": "object" + }, + "nullable": true, + "type": "array" + }, + "public_id": { + "description": "The monotonically increasing integer ID for the incident.", + "example": 1, + "format": "int64", + "type": "integer" + }, + "resolved": { + "description": "Timestamp when the incident's state was last changed from active or stable to resolved or completed.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "severity": { + "description": "The incident severity.", + "enum": [ + "UNKNOWN", + "SEV-1", + "SEV-2", + "SEV-3", + "SEV-4", + "SEV-5" + ], + "example": "UNKNOWN", + "type": "string", + "x-enum-varnames": [ + "UNKNOWN", + "SEV_1", + "SEV_2", + "SEV_3", + "SEV_4", + "SEV_5" + ] + }, + "state": { + "description": "The state incident.", + "nullable": true, + "type": "string" + }, + "time_to_detect": { + "description": "The amount of time in seconds to detect the incident.\nEquals the difference between `customer_impact_start` and `detected`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_internal_response": { + "description": "The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_repair": { + "description": "The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_resolve": { + "description": "The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "title": { + "description": "The title of the incident, which summarizes what happened.", + "example": "A test incident title", + "type": "string" + }, + "visibility": { + "description": "The incident visibility status.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "title" + ], + "type": "object" + }, + "id": { + "description": "The incident's ID.", + "example": "00000000-0000-0000-1234-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident's relationships from a response.", + "properties": { + "attachments": { + "description": "A relationship reference for attachments.", + "properties": { + "data": { + "description": "An array of incident attachments.", + "items": { + "description": "The attachment relationship data.", + "properties": { + "id": { + "description": "A unique identifier that represents the attachment.", + "example": "00000000-0000-abcd-1000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "commander_user": { + "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": "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "impacts": { + "description": "Relationship to impacts.", + "properties": { + "data": { + "description": "An array of incident impacts.", + "items": { + "description": "Relationship to impact object.", + "properties": { + "id": { + "description": "A unique identifier that represents the impact.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "description": "The incident impacts type.", + "enum": [ + "incident_impacts" + ], + "example": "incident_impacts", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_IMPACTS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "integrations": { + "description": "A relationship reference for multiple integration metadata objects.", + "example": { + "data": [ + { + "id": "00000000-abcd-0005-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0006-0000-000000000000", + "type": "incident_integrations" + } + ] + }, + "properties": { + "data": { + "description": "Integration metadata relationship array", + "example": [ + { + "id": "00000000-abcd-0003-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0004-0000-000000000000", + "type": "incident_integrations" + } + ], + "items": { + "description": "A relationship reference for an integration metadata object.", + "example": { + "id": "00000000-abcd-0002-0000-000000000000", + "type": "incident_integrations" + }, + "properties": { + "id": { + "description": "A unique identifier that represents the integration metadata.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_integrations", + "description": "Integration metadata resource type.", + "enum": [ + "incident_integrations" + ], + "example": "incident_integrations", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_INTEGRATIONS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "responders": { + "description": "Relationship to incident responders.", + "properties": { + "data": { + "description": "An array of incident responders.", + "items": { + "description": "Relationship to impact object.", + "properties": { + "id": { + "description": "A unique identifier that represents the responder.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "description": "The incident responders type.", + "enum": [ + "incident_responders" + ], + "example": "incident_responders", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_RESPONDERS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "user_defined_fields": { + "description": "Relationship to incident user defined fields.", + "properties": { + "data": { + "description": "An array of user defined fields.", + "items": { + "description": "Relationship to impact object.", + "properties": { + "id": { + "description": "A unique identifier that represents the responder.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "description": "The incident user defined fields type.", + "enum": [ + "user_defined_field" + ], + "example": "user_defined_field", + "type": "string", + "x-enum-varnames": [ + "USER_DEFINED_FIELD" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "incidents", + "description": "Incident resource type.", + "enum": [ + "incidents" + ], + "example": "incidents", + "type": "string", + "x-enum-varnames": [ + "INCIDENTS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + }, + "included": { + "description": "Included related resources that the user requested.", + "items": { + "description": "An object related to an incident that is included in the response.", + "oneOf": [ + { + "description": "User object returned by the API.", + "properties": { + "attributes": { + "description": "Attributes of user object returned by the API.", + "properties": { + "email": { + "description": "Email of the user.", "type": "string" }, - "duration": { - "description": "The duration between the triggering of the event and its recovery in nanoseconds.", - "format": "int64", - "type": "integer" + "handle": { + "description": "Handle of the user.", + "type": "string" + }, + "icon": { + "description": "URL of the user's icon.", + "type": "string" }, - "event_object": { - "description": "The event title.", - "example": "Did you hear the news today?", + "name": { + "description": "Name of the user.", + "nullable": true, "type": "string" }, - "evt": { - "description": "The metadata associated with a request.", + "uuid": { + "description": "UUID of the user.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the user.", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + }, + { + "description": "A single incident attachment.", + "example": { + "attributes": { + "attachment": { + "documentUrl": "", + "title": "Postmortem IR-123" + }, + "attachment_type": "postmortem" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + }, + "properties": { + "attributes": { + "description": "The attributes object for an attachment.", + "oneOf": [ + { + "description": "The attributes object for a postmortem attachment.", "properties": { - "id": { - "description": "Event ID.", - "example": "6509751066204996294", - "type": "string" - }, - "name": { - "description": "The event name.", - "type": "string" - }, - "source_id": { - "description": "Event source ID.", - "example": 36, - "format": "int64", - "type": "integer" + "attachment": { + "description": "The postmortem attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this notebook attachment.", + "example": "https://app.datadoghq.com/notebook/123", + "type": "string" + }, + "title": { + "description": "The title of this postmortem attachment.", + "example": "Postmortem IR-123", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" }, - "type": { - "description": "Event type.", - "example": "error_tracking_alert", - "type": "string" + "attachment_type": { + "default": "postmortem", + "description": "The type of postmortem attachment attributes.", + "enum": [ + "postmortem" + ], + "example": "postmortem", + "type": "string", + "x-enum-varnames": [ + "POSTMORTEM" + ] } }, + "required": [ + "attachment_type", + "attachment" + ], "type": "object" }, - "hostname": { - "description": "Host name to associate with the event.\nAny tags associated with the host are also applied to this event.", - "type": "string" - }, - "monitor": { - "description": "Attributes from the monitor that triggered the event.", - "nullable": true, + { + "description": "The attributes object for a link attachment.", "properties": { - "created_at": { - "description": "The POSIX timestamp of the monitor's creation in nanoseconds.", - "example": 1646318692000, - "format": "int64", - "type": "integer" - }, - "group_status": { - "description": "Monitor group status used when there is no `result_groups`.", - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "groups": { - "description": "Groups to which the monitor belongs.", - "items": { - "description": "A group.", - "type": "string" + "attachment": { + "description": "The link attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this link attachment.", + "example": "https://www.example.com/webstore-failure-runbook", + "type": "string" + }, + "title": { + "description": "The title of this link attachment.", + "example": "Runbook for webstore service failures", + "type": "string" + } }, - "type": "array" - }, - "id": { - "description": "The monitor ID.", - "format": "int64", - "type": "integer" - }, - "message": { - "description": "The monitor message.", - "type": "string" - }, - "modified": { - "description": "The monitor's last-modified timestamp.", - "format": "int64", - "type": "integer" - }, - "name": { - "description": "The monitor name.", - "type": "string" - }, - "query": { - "description": "The query that triggers the alert.", - "type": "string" - }, - "tags": { - "description": "A list of tags attached to the monitor.", - "example": [ - "environment:test" + "required": [ + "documentUrl", + "title" ], - "items": { - "description": "A tag.", - "type": "string" - }, - "type": "array" + "type": "object" }, - "templated_name": { - "description": "The templated name of the monitor before resolving any template variables.", - "type": "string" + "attachment_type": { + "default": "link", + "description": "The type of link attachment attributes.", + "enum": [ + "link" + ], + "example": "link", + "type": "string", + "x-enum-varnames": [ + "LINK" + ] }, - "type": { - "description": "The monitor type.", + "modified": { + "description": "Timestamp when the incident attachment link was last modified.", + "format": "date-time", + "readOnly": true, "type": "string" } }, + "required": [ + "attachment_type", + "attachment" + ], "type": "object" - }, - "monitor_groups": { - "description": "List of groups referred to in the event.", - "items": { - "description": "Group referred to in the event.", - "type": "string" + } + ] + }, + "id": { + "description": "A unique identifier that represents the incident attachment.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident attachment's relationships.", + "properties": { + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } }, - "nullable": true, - "type": "array" - }, - "monitor_id": { - "description": "ID of the monitor that triggered the event. When an event isn't related to a monitor, this field is empty.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "priority": { - "description": "The priority of the event's monitor. For example, `normal` or `low`.", - "enum": [ - "normal", - "low" - ], - "example": "normal", - "nullable": true, - "type": "string", - "x-enum-varnames": [ - "NORMAL", - "LOW" - ] - }, - "related_event_id": { - "description": "Related event ID.", - "format": "int64", - "type": "integer" - }, - "service": { - "description": "Service that triggered the event.", - "example": "datadog-api", - "type": "string" - }, - "source_type_name": { - "description": "The type of event being posted.\nFor example, `nagios`, `hudson`, `jenkins`, `my_apps`, `chef`, `puppet`, `git` or `bitbucket`.\nThe list of standard source attribute values is [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).", - "type": "string" - }, - "sourcecategory": { - "description": "Identifier for the source of the event, such as a monitor alert, an externally-submitted event, or an integration.", - "type": "string" - }, - "status": { - "description": "If an alert event is enabled, its status is one of the following:\n`failure`, `error`, `warning`, `info`, `success`, `user_update`,\n`recommendation`, or `snapshot`.", - "enum": [ - "failure", - "error", - "warning", - "info", - "success", - "user_update", - "recommendation", - "snapshot" - ], - "example": "info", - "type": "string", - "x-enum-varnames": [ - "FAILURE", - "ERROR", - "WARNING", - "INFO", - "SUCCESS", - "USER_UPDATE", - "RECOMMENDATION", - "SNAPSHOT" - ] - }, - "tags": { - "description": "A list of tags to apply to the event.", - "example": [ - "environment:test" + "required": [ + "data" ], - "items": { - "description": "A tag.", - "type": "string" - }, - "type": "array" - }, - "timestamp": { - "description": "POSIX timestamp of your event in milliseconds.", - "example": 1652274265000, - "format": "int64", - "type": "integer" - }, - "title": { - "description": "The event title.", - "example": "Oh boy!", - "type": "string" + "type": "object" } }, "type": "object" }, - "message": { - "description": "The message of the event.", - "type": "string" - }, - "tags": { - "description": "An array of tags associated with the event.", - "example": [ - "team:A" + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" ], - "items": { - "description": "The tag associated with the event.", - "type": "string" - }, - "type": "array" - }, - "timestamp": { - "description": "The timestamp of the event.", - "example": "2019-01-02T09:42:36.320Z", - "format": "date-time", - "type": "string" + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] } }, - "type": "object" - }, - "id": { - "description": "the unique ID of the event.", - "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", - "type": "string" - }, - "type": { - "default": "event", - "description": "Type of the event.", - "enum": [ - "event" + "required": [ + "type", + "attributes", + "id", + "relationships" ], - "example": "event", - "type": "string", - "x-enum-varnames": [ - "EVENT" - ] + "type": "object" } - }, - "type": "object" + ] }, + "readOnly": true, "type": "array" }, - "links": { - "description": "Links attributes.", - "properties": { - "next": { - "description": "Link for the next set of results. Note that the request can also be made using the\nPOST endpoint.", - "example": "https://app.datadoghq.com/api/v2/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - } - }, - "type": "object" - }, "meta": { - "description": "The metadata associated with a request.", + "description": "The metadata object containing pagination metadata.", "properties": { - "elapsed": { - "description": "The time elapsed in milliseconds.", - "example": 132, - "format": "int64", - "type": "integer" - }, - "page": { - "description": "Pagination attributes.", + "pagination": { + "description": "Pagination properties.", "properties": { - "after": { - "description": "The cursor to use to get the next results, if any. To make the next request, use the same\nparameters with the addition of the `page[cursor]`.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" + "next_offset": { + "description": "The index of the first element in the next page of results. Equal to page size added to the current offset.", + "example": 1000, + "format": "int64", + "type": "integer" + }, + "offset": { + "description": "The index of the first element in the results.", + "example": 10, + "format": "int64", + "type": "integer" + }, + "size": { + "description": "Maximum size of pages to return.", + "example": 1000, + "format": "int64", + "type": "integer" } }, "type": "object" - }, - "request_id": { - "description": "The identifier of the request.", - "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", - "type": "string" - }, - "status": { - "description": "The request status.", - "example": "done", - "type": "string" - }, - "warnings": { - "description": "A list of warnings (non-fatal errors) encountered. Partial results might be returned if\nwarnings are present in the response.", - "items": { - "description": "A warning message indicating something is wrong with the query.", - "properties": { - "code": { - "description": "A unique code for this type of warning.", - "example": "unknown_index", - "type": "string" - }, - "detail": { - "description": "A detailed explanation of this specific warning.", - "example": "indexes: foo, bar", - "type": "string" - }, - "title": { - "description": "A short human-readable summary of the warning.", - "example": "One or several indexes are missing or invalid. Results hold data from the other indexes.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" } }, + "readOnly": true, "type": "object" } }, + "required": [ + "data" + ], "type": "object" } } @@ -220612,547 +227076,35 @@ }, "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": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "events_read" - ] - } - ], - "summary": "Get a list of events", - "tags": [ - "Events" - ], - "x-menu-order": 1, - "x-pagination": { - "cursorParam": "page[cursor]", - "cursorPath": "meta.page.after", - "limitParam": "page[limit]", - "resultsPath": "data" - }, - "x-permission": { - "operator": "OR", - "permissions": [ - "events_read" - ] - }, - "x-undo": { - "type": "safe" - } - }, - "x-merge-override": { - "get": false - } - }, - "/api/v2/events/search": { - "post": { - "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 build complex events filtering and search.", - "operationId": "SearchEvents", - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "The object sent with the request to retrieve a list of events from your organization.", - "properties": { - "filter": { - "description": "The search and filter query settings.", - "properties": { - "from": { - "default": "now-15m", - "description": "The minimum time for the requested events. Supports date math and regular timestamps in milliseconds.", - "example": "now-15m", - "type": "string" - }, - "query": { - "default": "*", - "description": "The search query following the event search syntax.", - "example": "service:web* AND @http.status_code:[200 TO 299]", - "type": "string" - }, - "to": { - "default": "now", - "description": "The maximum time for the requested events. Supports date math and regular timestamps in milliseconds.", - "example": "now", - "type": "string" - } - }, - "type": "object" - }, - "options": { - "description": "The global query options that are used. Either provide a timezone or a time offset but not both,\notherwise the query fails.", - "properties": { - "timeOffset": { - "description": "The time offset to apply to the query in seconds.", - "format": "int64", - "type": "integer" - }, - "timezone": { - "default": "UTC", - "description": "The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).", - "example": "GMT", - "type": "string" - } - }, - "type": "object" - }, - "page": { - "description": "Pagination settings.", - "properties": { - "cursor": { - "description": "The returned paging point to use to get the next results.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - }, - "limit": { - "default": 10, - "description": "The maximum number of logs in the response.", - "example": 25, - "format": "int32", - "maximum": 1000, - "type": "integer" - } - }, - "type": "object" - }, - "sort": { - "description": "The sort parameters when querying events.", - "enum": [ - "timestamp", - "-timestamp" - ], - "type": "string", - "x-enum-varnames": [ - "TIMESTAMP_ASCENDING", - "TIMESTAMP_DESCENDING" - ] - } - }, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "The response object with all events matching the request and pagination information.", - "properties": { - "data": { - "description": "An array of events matching the request.", - "items": { - "description": "The object description of an event after being processed and stored by Datadog.", - "properties": { - "attributes": { - "description": "The object description of an event response attribute.", - "properties": { - "attributes": { - "description": "Object description of attributes from your event.", - "properties": { - "aggregation_key": { - "description": "Aggregation key of the event.", - "type": "string" - }, - "date_happened": { - "description": "POSIX timestamp of the event. Must be sent as an integer (no quotation marks).\nLimited to events no older than 18 hours.", - "format": "int64", - "type": "integer" - }, - "device_name": { - "description": "A device name.", - "type": "string" - }, - "duration": { - "description": "The duration between the triggering of the event and its recovery in nanoseconds.", - "format": "int64", - "type": "integer" - }, - "event_object": { - "description": "The event title.", - "example": "Did you hear the news today?", - "type": "string" - }, - "evt": { - "description": "The metadata associated with a request.", - "properties": { - "id": { - "description": "Event ID.", - "example": "6509751066204996294", - "type": "string" - }, - "name": { - "description": "The event name.", - "type": "string" - }, - "source_id": { - "description": "Event source ID.", - "example": 36, - "format": "int64", - "type": "integer" - }, - "type": { - "description": "Event type.", - "example": "error_tracking_alert", - "type": "string" - } - }, - "type": "object" - }, - "hostname": { - "description": "Host name to associate with the event.\nAny tags associated with the host are also applied to this event.", - "type": "string" - }, - "monitor": { - "description": "Attributes from the monitor that triggered the event.", - "nullable": true, - "properties": { - "created_at": { - "description": "The POSIX timestamp of the monitor's creation in nanoseconds.", - "example": 1646318692000, - "format": "int64", - "type": "integer" - }, - "group_status": { - "description": "Monitor group status used when there is no `result_groups`.", - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "groups": { - "description": "Groups to which the monitor belongs.", - "items": { - "description": "A group.", - "type": "string" - }, - "type": "array" - }, - "id": { - "description": "The monitor ID.", - "format": "int64", - "type": "integer" - }, - "message": { - "description": "The monitor message.", - "type": "string" - }, - "modified": { - "description": "The monitor's last-modified timestamp.", - "format": "int64", - "type": "integer" - }, - "name": { - "description": "The monitor name.", - "type": "string" - }, - "query": { - "description": "The query that triggers the alert.", - "type": "string" - }, - "tags": { - "description": "A list of tags attached to the monitor.", - "example": [ - "environment:test" - ], - "items": { - "description": "A tag.", - "type": "string" - }, - "type": "array" - }, - "templated_name": { - "description": "The templated name of the monitor before resolving any template variables.", - "type": "string" - }, - "type": { - "description": "The monitor type.", - "type": "string" - } - }, - "type": "object" - }, - "monitor_groups": { - "description": "List of groups referred to in the event.", - "items": { - "description": "Group referred to in the event.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "monitor_id": { - "description": "ID of the monitor that triggered the event. When an event isn't related to a monitor, this field is empty.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "priority": { - "description": "The priority of the event's monitor. For example, `normal` or `low`.", - "enum": [ - "normal", - "low" - ], - "example": "normal", - "nullable": true, - "type": "string", - "x-enum-varnames": [ - "NORMAL", - "LOW" - ] - }, - "related_event_id": { - "description": "Related event ID.", - "format": "int64", - "type": "integer" - }, - "service": { - "description": "Service that triggered the event.", - "example": "datadog-api", - "type": "string" - }, - "source_type_name": { - "description": "The type of event being posted.\nFor example, `nagios`, `hudson`, `jenkins`, `my_apps`, `chef`, `puppet`, `git` or `bitbucket`.\nThe list of standard source attribute values is [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).", - "type": "string" - }, - "sourcecategory": { - "description": "Identifier for the source of the event, such as a monitor alert, an externally-submitted event, or an integration.", - "type": "string" - }, - "status": { - "description": "If an alert event is enabled, its status is one of the following:\n`failure`, `error`, `warning`, `info`, `success`, `user_update`,\n`recommendation`, or `snapshot`.", - "enum": [ - "failure", - "error", - "warning", - "info", - "success", - "user_update", - "recommendation", - "snapshot" - ], - "example": "info", - "type": "string", - "x-enum-varnames": [ - "FAILURE", - "ERROR", - "WARNING", - "INFO", - "SUCCESS", - "USER_UPDATE", - "RECOMMENDATION", - "SNAPSHOT" - ] - }, - "tags": { - "description": "A list of tags to apply to the event.", - "example": [ - "environment:test" - ], - "items": { - "description": "A tag.", - "type": "string" - }, - "type": "array" - }, - "timestamp": { - "description": "POSIX timestamp of your event in milliseconds.", - "example": 1652274265000, - "format": "int64", - "type": "integer" - }, - "title": { - "description": "The event title.", - "example": "Oh boy!", - "type": "string" - } - }, - "type": "object" - }, - "message": { - "description": "The message of the event.", - "type": "string" - }, - "tags": { - "description": "An array of tags associated with the event.", - "example": [ - "team:A" - ], - "items": { - "description": "The tag associated with the event.", - "type": "string" - }, - "type": "array" - }, - "timestamp": { - "description": "The timestamp of the event.", - "example": "2019-01-02T09:42:36.320Z", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "the unique ID of the event.", - "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", - "type": "string" - }, - "type": { - "default": "event", - "description": "Type of the event.", - "enum": [ - "event" - ], - "example": "event", - "type": "string", - "x-enum-varnames": [ - "EVENT" - ] - } - }, - "type": "object" - }, - "type": "array" - }, - "links": { - "description": "Links attributes.", - "properties": { - "next": { - "description": "Link for the next set of results. Note that the request can also be made using the\nPOST endpoint.", - "example": "https://app.datadoghq.com/api/v2/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - } - }, - "type": "object" - }, - "meta": { - "description": "The metadata associated with a request.", - "properties": { - "elapsed": { - "description": "The time elapsed in milliseconds.", - "example": 132, - "format": "int64", - "type": "integer" - }, - "page": { - "description": "Pagination attributes.", - "properties": { - "after": { - "description": "The cursor to use to get the next results, if any. To make the next request, use the same\nparameters with the addition of the `page[cursor]`.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - } - }, - "type": "object" - }, - "request_id": { - "description": "The identifier of the request.", - "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", - "type": "string" - }, - "status": { - "description": "The request status.", - "example": "done", - "type": "string" - }, - "warnings": { - "description": "A list of warnings (non-fatal errors) encountered. Partial results might be returned if\nwarnings are present in the response.", - "items": { - "description": "A warning message indicating something is wrong with the query.", - "properties": { - "code": { - "description": "A unique code for this type of warning.", - "example": "unknown_index", - "type": "string" - }, - "detail": { - "description": "A detailed explanation of this specific warning.", - "example": "indexes: foo, bar", - "type": "string" - }, - "title": { - "description": "A short human-readable summary of the warning.", - "example": "One or several indexes are missing or invalid. Results hold data from the other indexes.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } + "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": "object" + "type": "array" } }, + "required": [ + "errors" + ], "type": "object" } } }, - "description": "OK" + "description": "Unauthorized" }, - "400": { + "403": { "content": { "application/json": { "schema": { @@ -221178,9 +227130,9 @@ } } }, - "description": "Bad Request" + "description": "Forbidden" }, - "403": { + "404": { "content": { "application/json": { "schema": { @@ -221206,7 +227158,7 @@ } } }, - "description": "Not Authorized" + "description": "Not Found" }, "429": { "content": { @@ -221237,579 +227189,641 @@ "description": "Too many requests" } }, - "summary": "Search events", + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_read" + ] + } + ], + "summary": "Get a list of incidents", "tags": [ - "Events" + "Incidents" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 2, + "x-menu-order": 5, "x-pagination": { - "cursorParam": "body.page.cursor", - "cursorPath": "meta.page.after", - "limitParam": "body.page.limit", + "limitParam": "page[size]", + "pageOffsetParam": "page[offset]", "resultsPath": "data" }, "x-permission": { "operator": "OR", "permissions": [ - "events_read" + "incident_read" ] }, "x-undo": { "type": "safe" - } + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." }, - "x-merge-override": { - "post": false - } - }, - "/api/v2/incidents": { - "get": { - "description": "Get all incidents for the user's organization.", - "operationId": "ListIncidents", - "parameters": [ - { - "description": "Specifies which types of related objects should be included in the response.", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "description": "Object related to an incident.", - "enum": [ - "users", - "attachments" - ], - "type": "string", - "x-enum-varnames": [ - "USERS", - "ATTACHMENTS" - ] - }, - "type": "array" - } - }, - { - "description": "Size for a given page. The maximum allowed value is 100.", - "in": "query", - "name": "page[size]", - "required": false, - "schema": { - "default": 10, - "example": 10, - "format": "int64", - "type": "integer" - } - }, - { - "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" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "Response with a list of incidents.", - "properties": { - "data": { - "description": "An array of incidents.", - "example": [ - { - "attributes": { - "created": "2020-04-21T15:34:08.627205+00:00", - "creation_idempotency_key": null, - "customer_impact_duration": 0, - "customer_impact_end": null, - "customer_impact_scope": null, - "customer_impact_start": null, - "customer_impacted": false, - "detected": "2020-04-14T00:00:00+00:00", - "incident_type_uuid": "00000000-0000-0000-0000-000000000001", - "modified": "2020-09-17T14:16:58.696424+00:00", - "public_id": 1, - "resolved": null, - "severity": "SEV-1", - "time_to_detect": 0, - "time_to_internal_response": 0, - "time_to_repair": 0, - "time_to_resolve": 0, - "title": "Example Incident" + "post": { + "description": "Create an incident.", + "operationId": "CreateIncident", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Create request for an incident.", + "properties": { + "data": { + "description": "Incident data for a create request.", + "properties": { + "attributes": { + "description": "The incident's attributes for a create request.", + "properties": { + "customer_impact_scope": { + "description": "Required if `customer_impacted:\"true\"`. A summary of the impact customers experienced during the incident.", + "example": "Example customer impact scope", + "type": "string" }, - "id": "00000000-aaaa-0000-0000-000000000000", - "relationships": { - "attachments": { - "data": [ + "customer_impacted": { + "description": "A flag indicating whether the incident caused customer impact.", + "example": false, + "type": "boolean" + }, + "fields": { + "additionalProperties": { + "description": "Dynamic fields for which selections can be made, with field names as keys.", + "oneOf": [ { - "id": "00000000-9999-0000-0000-000000000000", - "type": "incident_attachments" + "description": "A field with a single value selected.", + "properties": { + "type": { + "default": "dropdown", + "description": "Type of the single value field definitions.", + "enum": [ + "dropdown", + "textbox" + ], + "example": "dropdown", + "type": "string", + "x-enum-varnames": [ + "DROPDOWN", + "TEXTBOX" + ] + }, + "value": { + "description": "The single value selected for this field.", + "example": "SEV-1", + "nullable": true, + "type": "string" + } + }, + "type": "object" }, { - "id": "00000000-1234-0000-0000-000000000000", - "type": "incident_attachments" + "description": "A field with potentially multiple values selected.", + "properties": { + "type": { + "default": "multiselect", + "description": "Type of the multiple value field definitions.", + "enum": [ + "multiselect", + "textarray", + "metrictag", + "autocomplete" + ], + "example": "multiselect", + "type": "string", + "x-enum-varnames": [ + "MULTISELECT", + "TEXTARRAY", + "METRICTAG", + "AUTOCOMPLETE" + ] + }, + "value": { + "description": "The multiple values selected for this field.", + "example": [ + "1.0", + "1.1" + ], + "items": { + "description": "A value which has been selected for the parent field.", + "example": "1.1", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" } ] }, - "commander_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - }, - "created_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" + "description": "A condensed view of the user-defined fields for which to create initial selections.", + "example": { + "severity": { + "type": "dropdown", + "value": "SEV-5" } }, - "integrations": { - "data": [ - { - "id": "00000000-0000-0000-4444-000000000000", - "type": "incident_integrations" - }, - { - "id": "00000000-0000-0000-5555-000000000000", - "type": "incident_integrations" - } - ] - }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - } + "type": "object" }, - "type": "incidents" - }, - { - "attributes": { - "created": "2020-04-21T15:34:08.627205+00:00", - "creation_idempotency_key": null, - "customer_impact_duration": 0, - "customer_impact_end": null, - "customer_impact_scope": null, - "customer_impact_start": null, - "customer_impacted": false, - "detected": "2020-04-14T00:00:00+00:00", - "incident_type_uuid": "00000000-0000-0000-0000-000000000002", - "modified": "2020-09-17T14:16:58.696424+00:00", - "public_id": 2, - "resolved": null, - "severity": "SEV-5", - "time_to_detect": 0, - "time_to_internal_response": 0, - "time_to_repair": 0, - "time_to_resolve": 0, - "title": "Example Incident 2" + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type. The default incident type will be used if this property is not provided.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" }, - "id": "00000000-1111-0000-0000-000000000000", - "relationships": { - "attachments": { - "data": [ - { - "id": "00000000-9999-0000-0000-000000000000", - "type": "incident_attachments" - } - ] - }, - "commander_user": { - "data": { - "id": "00000000-aaaa-0000-0000-000000000000", - "type": "users" - } - }, - "created_by_user": { - "data": { - "id": "00000000-aaaa-0000-0000-000000000000", - "type": "users" - } - }, - "integrations": { - "data": [ - { - "id": "00000000-0000-0000-0001-000000000000", - "type": "incident_integrations" - }, + "initial_cells": { + "description": "An array of initial timeline cells to be placed at the beginning of the incident timeline.", + "items": { + "description": "The timeline cell's attributes for a create request.", + "oneOf": [ { - "id": "00000000-0000-0000-0002-000000000000", - "type": "incident_integrations" - } - ] - }, - "last_modified_by_user": { - "data": { - "id": "00000000-aaaa-0000-0000-000000000000", - "type": "users" - } - } - }, - "type": "incidents" - } - ], - "items": { - "description": "Incident data from a response.", - "properties": { - "attributes": { - "description": "The incident's attributes from a response.", - "properties": { - "archived": { - "description": "Timestamp of when the incident was archived.", - "format": "date-time", - "nullable": true, - "readOnly": true, - "type": "string" - }, - "case_id": { - "description": "The incident case id.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "created": { - "description": "Timestamp when the incident was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "customer_impact_duration": { - "description": "Length of the incident's customer impact in seconds.\nEquals the difference between `customer_impact_start` and `customer_impact_end`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "customer_impact_end": { - "description": "Timestamp when customers were no longer impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impact_scope": { - "description": "A summary of the impact customers experienced during the incident.", - "example": "An example customer impact scope", - "nullable": true, - "type": "string" - }, - "customer_impact_start": { - "description": "Timestamp when customers began being impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impacted": { - "description": "A flag indicating whether the incident caused customer impact.", - "example": false, - "type": "boolean" - }, - "detected": { - "description": "Timestamp when the incident was detected.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "fields": { - "additionalProperties": { - "description": "Dynamic fields for which selections can be made, with field names as keys.", - "oneOf": [ - { - "description": "A field with a single value selected.", + "description": "Timeline cell data for Markdown timeline cells for a create request.", + "properties": { + "cell_type": { + "default": "markdown", + "description": "Type of the Markdown timeline cell.", + "enum": [ + "markdown" + ], + "example": "markdown", + "type": "string", + "x-enum-varnames": [ + "MARKDOWN" + ] + }, + "content": { + "description": "The Markdown timeline cell contents.", "properties": { - "type": { - "default": "dropdown", - "description": "Type of the single value field definitions.", - "enum": [ - "dropdown", - "textbox" - ], - "example": "dropdown", - "type": "string", - "x-enum-varnames": [ - "DROPDOWN", - "TEXTBOX" - ] - }, - "value": { - "description": "The single value selected for this field.", - "example": "SEV-1", - "nullable": true, + "content": { + "description": "The Markdown content of the cell.", + "example": "An example timeline cell message.", + "nullable": false, "type": "string" } }, "type": "object" }, - { - "description": "A field with potentially multiple values selected.", - "properties": { - "type": { - "default": "multiselect", - "description": "Type of the multiple value field definitions.", - "enum": [ - "multiselect", - "textarray", - "metrictag", - "autocomplete" - ], - "example": "multiselect", - "type": "string", - "x-enum-varnames": [ - "MULTISELECT", - "TEXTARRAY", - "METRICTAG", - "AUTOCOMPLETE" - ] - }, - "value": { - "description": "The multiple values selected for this field.", - "example": [ - "1.0", - "1.1" - ], - "items": { - "description": "A value which has been selected for the parent field.", - "example": "1.1", - "type": "string" - }, - "nullable": true, - "type": "array" - } - }, - "type": "object" + "important": { + "default": false, + "description": "A flag indicating whether the timeline cell is important and should be highlighted.", + "example": false, + "type": "boolean" } - ] - }, - "description": "A condensed view of the user-defined fields attached to incidents.", - "example": { - "severity": { - "type": "dropdown", - "value": "SEV-5" - } - }, - "type": "object" + }, + "required": [ + "content", + "cell_type" + ], + "type": "object" + } + ] + }, + "type": "array" + }, + "notification_handles": { + "description": "Notification handles that will be notified of the incident at creation.", + "example": [ + { + "display_name": "Jane Doe", + "handle": "@user@email.com" }, - "incident_type_uuid": { - "description": "A unique identifier that represents an incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "type": "string" + { + "display_name": "Slack Channel", + "handle": "@slack-channel" }, - "modified": { - "description": "Timestamp when the incident was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" + { + "display_name": "Incident Workflow", + "handle": "@workflow-from-incident" + } + ], + "items": { + "description": "A notification handle that will be notified at incident creation.", + "properties": { + "display_name": { + "description": "The name of the notified handle.", + "example": "Jane Doe", + "type": "string" + }, + "handle": { + "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", + "example": "@test.user@test.com", + "type": "string" + } }, - "non_datadog_creator": { - "description": "Incident's non Datadog creator.", + "type": "object" + }, + "type": "array" + }, + "title": { + "description": "The title of the incident, which summarizes what happened.", + "example": "A test incident title", + "type": "string" + } + }, + "required": [ + "title", + "customer_impacted" + ], + "type": "object" + }, + "relationships": { + "description": "The relationships the incident will have with other resources once created.", + "properties": { + "commander_user": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", "nullable": true, "properties": { - "image_48_px": { - "description": "Non Datadog creator `48px` image.", - "type": "string" - }, - "name": { - "description": "Non Datadog creator name.", + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" - } - }, - "type": "object" - }, - "notification_handles": { - "description": "Notification handles that will be notified of the incident during update.", - "example": [ - { - "display_name": "Jane Doe", - "handle": "@user@email.com" - }, - { - "display_name": "Slack Channel", - "handle": "@slack-channel" }, - { - "display_name": "Incident Workflow", - "handle": "@workflow-from-incident" + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] } - ], - "items": { - "description": "A notification handle that will be notified at incident creation.", - "properties": { - "display_name": { - "description": "The name of the notified handle.", - "example": "Jane Doe", - "type": "string" - }, - "handle": { - "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", - "example": "@test.user@test.com", - "type": "string" - } - }, - "type": "object" }, - "nullable": true, - "type": "array" - }, - "public_id": { - "description": "The monotonically increasing integer ID for the incident.", - "example": 1, - "format": "int64", - "type": "integer" - }, - "resolved": { - "description": "Timestamp when the incident's state was last changed from active or stable to resolved or completed.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "severity": { - "description": "The incident severity.", - "enum": [ - "UNKNOWN", - "SEV-1", - "SEV-2", - "SEV-3", - "SEV-4", - "SEV-5" + "required": [ + "id", + "type" ], - "example": "UNKNOWN", - "type": "string", - "x-enum-varnames": [ - "UNKNOWN", - "SEV_1", - "SEV_2", - "SEV_3", - "SEV_4", - "SEV_5" - ] - }, - "state": { - "description": "The state incident.", - "nullable": true, - "type": "string" - }, - "time_to_detect": { - "description": "The amount of time in seconds to detect the incident.\nEquals the difference between `customer_impact_start` and `detected`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_internal_response": { - "description": "The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_repair": { - "description": "The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_resolve": { - "description": "The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "title": { - "description": "The title of the incident, which summarizes what happened.", - "example": "A test incident title", - "type": "string" - }, - "visibility": { - "description": "The incident visibility status.", - "nullable": true, - "type": "string" + "type": "object", + "x-merge-override": { + "required": false + } } }, "required": [ - "title" + "data" ], "type": "object" - }, - "id": { - "description": "The incident's ID.", - "example": "00000000-0000-0000-1234-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident's relationships from a response.", - "properties": { - "attachments": { - "description": "A relationship reference for attachments.", - "properties": { - "data": { - "description": "An array of incident attachments.", - "items": { - "description": "The attachment relationship data.", - "properties": { - "id": { - "description": "A unique identifier that represents the attachment.", - "example": "00000000-0000-abcd-1000-000000000000", + } + }, + "required": [ + "commander_user" + ], + "type": "object" + }, + "type": { + "default": "incidents", + "description": "Incident resource type.", + "enum": [ + "incidents" + ], + "example": "incidents", + "type": "string", + "x-enum-varnames": [ + "INCIDENTS" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Incident payload.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Response with an incident.", + "properties": { + "data": { + "description": "Incident data from a response.", + "properties": { + "attributes": { + "description": "The incident's attributes from a response.", + "properties": { + "archived": { + "description": "Timestamp of when the incident was archived.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "case_id": { + "description": "The incident case id.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "created": { + "description": "Timestamp when the incident was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "customer_impact_duration": { + "description": "Length of the incident's customer impact in seconds.\nEquals the difference between `customer_impact_start` and `customer_impact_end`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "customer_impact_end": { + "description": "Timestamp when customers were no longer impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impact_scope": { + "description": "A summary of the impact customers experienced during the incident.", + "example": "An example customer impact scope", + "nullable": true, + "type": "string" + }, + "customer_impact_start": { + "description": "Timestamp when customers began being impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impacted": { + "description": "A flag indicating whether the incident caused customer impact.", + "example": false, + "type": "boolean" + }, + "detected": { + "description": "Timestamp when the incident was detected.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "fields": { + "additionalProperties": { + "description": "Dynamic fields for which selections can be made, with field names as keys.", + "oneOf": [ + { + "description": "A field with a single value selected.", + "properties": { + "type": { + "default": "dropdown", + "description": "Type of the single value field definitions.", + "enum": [ + "dropdown", + "textbox" + ], + "example": "dropdown", + "type": "string", + "x-enum-varnames": [ + "DROPDOWN", + "TEXTBOX" + ] + }, + "value": { + "description": "The single value selected for this field.", + "example": "SEV-1", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + { + "description": "A field with potentially multiple values selected.", + "properties": { + "type": { + "default": "multiselect", + "description": "Type of the multiple value field definitions.", + "enum": [ + "multiselect", + "textarray", + "metrictag", + "autocomplete" + ], + "example": "multiselect", + "type": "string", + "x-enum-varnames": [ + "MULTISELECT", + "TEXTARRAY", + "METRICTAG", + "AUTOCOMPLETE" + ] + }, + "value": { + "description": "The multiple values selected for this field.", + "example": [ + "1.0", + "1.1" + ], + "items": { + "description": "A value which has been selected for the parent field.", + "example": "1.1", "type": "string" }, - "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", - "enum": [ - "incident_attachments" - ], - "example": "incident_attachments", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "nullable": true, + "type": "array" } }, - "type": "array" + "type": "object" } + ] + }, + "description": "A condensed view of the user-defined fields attached to incidents.", + "example": { + "severity": { + "type": "dropdown", + "value": "SEV-5" + } + }, + "type": "object" + }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "modified": { + "description": "Timestamp when the incident was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "non_datadog_creator": { + "description": "Incident's non Datadog creator.", + "nullable": true, + "properties": { + "image_48_px": { + "description": "Non Datadog creator `48px` image.", + "type": "string" }, - "required": [ - "data" - ], - "type": "object" + "name": { + "description": "Non Datadog creator name.", + "type": "string" + } }, - "commander_user": { - "description": "Relationship to user.", - "nullable": true, + "type": "object" + }, + "notification_handles": { + "description": "Notification handles that will be notified of the incident during update.", + "example": [ + { + "display_name": "Jane Doe", + "handle": "@user@email.com" + }, + { + "display_name": "Slack Channel", + "handle": "@slack-channel" + }, + { + "display_name": "Incident Workflow", + "handle": "@workflow-from-incident" + } + ], + "items": { + "description": "A notification handle that will be notified at incident creation.", "properties": { - "data": { - "description": "Relationship to user object.", - "nullable": true, + "display_name": { + "description": "The name of the notified handle.", + "example": "Jane Doe", + "type": "string" + }, + "handle": { + "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", + "example": "@test.user@test.com", + "type": "string" + } + }, + "type": "object" + }, + "nullable": true, + "type": "array" + }, + "public_id": { + "description": "The monotonically increasing integer ID for the incident.", + "example": 1, + "format": "int64", + "type": "integer" + }, + "resolved": { + "description": "Timestamp when the incident's state was last changed from active or stable to resolved or completed.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "severity": { + "description": "The incident severity.", + "enum": [ + "UNKNOWN", + "SEV-1", + "SEV-2", + "SEV-3", + "SEV-4", + "SEV-5" + ], + "example": "UNKNOWN", + "type": "string", + "x-enum-varnames": [ + "UNKNOWN", + "SEV_1", + "SEV_2", + "SEV_3", + "SEV_4", + "SEV_5" + ] + }, + "state": { + "description": "The state incident.", + "nullable": true, + "type": "string" + }, + "time_to_detect": { + "description": "The amount of time in seconds to detect the incident.\nEquals the difference between `customer_impact_start` and `detected`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_internal_response": { + "description": "The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_repair": { + "description": "The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_resolve": { + "description": "The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "title": { + "description": "The title of the incident, which summarizes what happened.", + "example": "A test incident title", + "type": "string" + }, + "visibility": { + "description": "The incident visibility status.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "title" + ], + "type": "object" + }, + "id": { + "description": "The incident's ID.", + "example": "00000000-0000-0000-1234-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident's relationships from a response.", + "properties": { + "attachments": { + "description": "A relationship reference for attachments.", + "properties": { + "data": { + "description": "An array of incident attachments.", + "items": { + "description": "The attachment relationship data.", "properties": { "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-0000-000000000000", + "description": "A unique identifier that represents the attachment.", + "example": "00000000-0000-abcd-1000-000000000000", "type": "string" }, "type": { - "default": "users", - "description": "Users resource type.", + "default": "incident_attachments", + "description": "The incident attachment resource type.", "enum": [ - "users" + "incident_attachments" ], - "example": "users", + "example": "incident_attachments", "type": "string", "x-enum-varnames": [ - "USERS" + "INCIDENT_ATTACHMENTS" ] } }, @@ -221821,34 +227835,117 @@ "x-merge-override": { "required": false } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "commander_user": { + "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": "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 } - }, - "required": [ - "data" - ], - "type": "object" + } }, - "created_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "description": "Relationship to user object.", + "required": [ + "data" + ], + "type": "object" + }, + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "impacts": { + "description": "Relationship to impacts.", + "properties": { + "data": { + "description": "An array of incident impacts.", + "items": { + "description": "Relationship to impact object.", "properties": { "id": { - "description": "A unique identifier that represents the user.", + "description": "A unique identifier that represents the impact.", "example": "00000000-0000-0000-2345-000000000000", "type": "string" }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "The incident impacts type.", "enum": [ - "users" + "incident_impacts" ], - "example": "users", + "example": "incident_impacts", "type": "string", "x-enum-varnames": [ - "USERS" + "INCIDENT_IMPACTS" ] } }, @@ -221860,145 +227957,145 @@ "x-merge-override": { "required": false } - } - }, - "required": [ - "data" - ], - "type": "object" + }, + "type": "array" + } }, - "impacts": { - "description": "Relationship to impacts.", - "properties": { - "data": { - "description": "An array of incident impacts.", - "items": { - "description": "Relationship to impact object.", - "properties": { - "id": { - "description": "A unique identifier that represents the impact.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "description": "The incident impacts type.", - "enum": [ - "incident_impacts" - ], - "example": "incident_impacts", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_IMPACTS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" + "required": [ + "data" + ], + "type": "object" + }, + "integrations": { + "description": "A relationship reference for multiple integration metadata objects.", + "example": { + "data": [ + { + "id": "00000000-abcd-0005-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0006-0000-000000000000", + "type": "incident_integrations" } - }, - "required": [ - "data" - ], - "type": "object" + ] }, - "integrations": { - "description": "A relationship reference for multiple integration metadata objects.", - "example": { - "data": [ + "properties": { + "data": { + "description": "Integration metadata relationship array", + "example": [ { - "id": "00000000-abcd-0005-0000-000000000000", + "id": "00000000-abcd-0003-0000-000000000000", "type": "incident_integrations" }, { - "id": "00000000-abcd-0006-0000-000000000000", + "id": "00000000-abcd-0004-0000-000000000000", "type": "incident_integrations" } - ] - }, - "properties": { - "data": { - "description": "Integration metadata relationship array", - "example": [ - { - "id": "00000000-abcd-0003-0000-000000000000", - "type": "incident_integrations" + ], + "items": { + "description": "A relationship reference for an integration metadata object.", + "example": { + "id": "00000000-abcd-0002-0000-000000000000", + "type": "incident_integrations" + }, + "properties": { + "id": { + "description": "A unique identifier that represents the integration metadata.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" }, - { - "id": "00000000-abcd-0004-0000-000000000000", - "type": "incident_integrations" + "type": { + "default": "incident_integrations", + "description": "Integration metadata resource type.", + "enum": [ + "incident_integrations" + ], + "example": "incident_integrations", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_INTEGRATIONS" + ] } + }, + "required": [ + "id", + "type" ], - "items": { - "description": "A relationship reference for an integration metadata object.", - "example": { - "id": "00000000-abcd-0002-0000-000000000000", - "type": "incident_integrations" - }, - "properties": { - "id": { - "description": "A unique identifier that represents the integration metadata.", - "example": "00000000-abcd-0001-0000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", - "enum": [ - "incident_integrations" - ], - "example": "incident_integrations", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" }, - "type": "array" + "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 } - }, - "required": [ - "data" - ], - "type": "object" + } }, - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "description": "Relationship to user object.", + "required": [ + "data" + ], + "type": "object" + }, + "responders": { + "description": "Relationship to incident responders.", + "properties": { + "data": { + "description": "An array of incident responders.", + "items": { + "description": "Relationship to impact object.", "properties": { "id": { - "description": "A unique identifier that represents the user.", + "description": "A unique identifier that represents the responder.", "example": "00000000-0000-0000-2345-000000000000", "type": "string" }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "The incident responders type.", "enum": [ - "users" + "incident_responders" ], - "example": "users", + "example": "incident_responders", "type": "string", "x-enum-varnames": [ - "USERS" + "INCIDENT_RESPONDERS" ] } }, @@ -222010,123 +228107,81 @@ "x-merge-override": { "required": false } - } - }, - "required": [ - "data" - ], - "type": "object" + }, + "type": "array" + } }, - "responders": { - "description": "Relationship to incident responders.", - "properties": { - "data": { - "description": "An array of incident responders.", - "items": { - "description": "Relationship to impact object.", - "properties": { - "id": { - "description": "A unique identifier that represents the responder.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "description": "The incident responders type.", - "enum": [ - "incident_responders" - ], - "example": "incident_responders", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_RESPONDERS" - ] - } + "required": [ + "data" + ], + "type": "object" + }, + "user_defined_fields": { + "description": "Relationship to incident user defined fields.", + "properties": { + "data": { + "description": "An array of user defined fields.", + "items": { + "description": "Relationship to impact object.", + "properties": { + "id": { + "description": "A unique identifier that represents the responder.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "type": { + "description": "The incident user defined fields type.", + "enum": [ + "user_defined_field" + ], + "example": "user_defined_field", + "type": "string", + "x-enum-varnames": [ + "USER_DEFINED_FIELD" + ] } }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } }, - "user_defined_fields": { - "description": "Relationship to incident user defined fields.", - "properties": { - "data": { - "description": "An array of user defined fields.", - "items": { - "description": "Relationship to impact object.", - "properties": { - "id": { - "description": "A unique identifier that represents the responder.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "description": "The incident user defined fields type.", - "enum": [ - "user_defined_field" - ], - "example": "user_defined_field", - "type": "string", - "x-enum-varnames": [ - "USER_DEFINED_FIELD" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + "required": [ + "data" + ], + "type": "object" + } }, - "type": { - "default": "incidents", - "description": "Incident resource type.", - "enum": [ - "incidents" - ], - "example": "incidents", - "type": "string", - "x-enum-varnames": [ - "INCIDENTS" - ] - } + "type": "object" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "type": { + "default": "incidents", + "description": "Incident resource type.", + "enum": [ + "incidents" + ], + "example": "incidents", + "type": "string", + "x-enum-varnames": [ + "INCIDENTS" + ] } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } }, "included": { "description": "Included related resources that the user requested.", @@ -222201,209 +228256,1311 @@ } } }, - "type": "incident_attachments" - }, - "properties": { - "attributes": { - "description": "The attributes object for an attachment.", - "oneOf": [ - { - "description": "The attributes object for a postmortem attachment.", - "properties": { - "attachment": { - "description": "The postmortem attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this notebook attachment.", - "example": "https://app.datadoghq.com/notebook/123", - "type": "string" - }, - "title": { - "description": "The title of this postmortem attachment.", - "example": "Postmortem IR-123", - "type": "string" - } - }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" - }, - "attachment_type": { - "default": "postmortem", - "description": "The type of postmortem attachment attributes.", - "enum": [ - "postmortem" - ], - "example": "postmortem", - "type": "string", - "x-enum-varnames": [ - "POSTMORTEM" - ] - } - }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - }, - { - "description": "The attributes object for a link attachment.", - "properties": { - "attachment": { - "description": "The link attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this link attachment.", - "example": "https://www.example.com/webstore-failure-runbook", - "type": "string" - }, - "title": { - "description": "The title of this link attachment.", - "example": "Runbook for webstore service failures", - "type": "string" - } - }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" - }, - "attachment_type": { - "default": "link", - "description": "The type of link attachment attributes.", - "enum": [ - "link" - ], - "example": "link", - "type": "string", - "x-enum-varnames": [ - "LINK" - ] - }, - "modified": { - "description": "Timestamp when the incident attachment link was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - } - }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - } - ] + "type": "incident_attachments" + }, + "properties": { + "attributes": { + "description": "The attributes object for an attachment.", + "oneOf": [ + { + "description": "The attributes object for a postmortem attachment.", + "properties": { + "attachment": { + "description": "The postmortem attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this notebook attachment.", + "example": "https://app.datadoghq.com/notebook/123", + "type": "string" + }, + "title": { + "description": "The title of this postmortem attachment.", + "example": "Postmortem IR-123", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" + }, + "attachment_type": { + "default": "postmortem", + "description": "The type of postmortem attachment attributes.", + "enum": [ + "postmortem" + ], + "example": "postmortem", + "type": "string", + "x-enum-varnames": [ + "POSTMORTEM" + ] + } + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + }, + { + "description": "The attributes object for a link attachment.", + "properties": { + "attachment": { + "description": "The link attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this link attachment.", + "example": "https://www.example.com/webstore-failure-runbook", + "type": "string" + }, + "title": { + "description": "The title of this link attachment.", + "example": "Runbook for webstore service failures", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" + }, + "attachment_type": { + "default": "link", + "description": "The type of link attachment attributes.", + "enum": [ + "link" + ], + "example": "link", + "type": "string", + "x-enum-varnames": [ + "LINK" + ] + }, + "modified": { + "description": "Timestamp when the incident attachment link was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + } + ] + }, + "id": { + "description": "A unique identifier that represents the incident attachment.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident attachment's relationships.", + "properties": { + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] + } + }, + "required": [ + "type", + "attributes", + "id", + "relationships" + ], + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "CREATED" + }, + "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": [ + "incident_write" + ] + } + ], + "summary": "Create an incident", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-given": { + "incident": { + "parameters": [ + { + "name": "body", + "value": "{\n \"data\": {\n \"attributes\": {\n \"title\": \"{{ unique }}\",\n \"customer_impacted\": false\n },\n \"type\": \"incidents\"\n }\n}" + } + ], + "step": "there is a valid \"incident\" in the system" + } + }, + "x-menu-order": 1, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_write" + ] + }, + "x-undo": { + "operationId": "DeleteIncident", + "parameters": [ + { + "name": "incident_id", + "source": "data.id" + } + ], + "type": "unsafe" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + } + }, + "/api/v2/incidents/config/types": { + "get": { + "description": "Get all incident types.", + "operationId": "ListIncidentTypes", + "parameters": [ + { + "description": "Include deleted incident types in the response.", + "in": "query", + "name": "include_deleted", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response with a list of incident types.", + "properties": { + "data": { + "description": "An array of incident type objects.", + "items": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", + "example": false, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" }, - "id": { - "description": "A unique identifier that represents the incident attachment.", - "example": "00000000-abcd-0001-0000-000000000000", + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, "type": "string" }, - "relationships": { - "description": "The incident attachment's relationships.", - "properties": { - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" }, - "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", - "enum": [ - "incident_attachments" - ], - "example": "incident_attachments", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" - ] + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" } }, "required": [ - "type", - "attributes", - "id", - "relationships" + "name" ], "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] } - ] + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "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" + }, + "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" }, - "readOnly": true, "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_settings_read", + "incident_read" + ] + } + ], + "summary": "Get a list of incident types", + "tags": [ + "Incidents" + ], + "x-menu-order": 20, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_settings_read", + "incident_read" + ] + }, + "x-undo": { + "type": "safe" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "post": { + "description": "Create an incident type.", + "operationId": "CreateIncidentType", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Create request for an incident type.", + "properties": { + "data": { + "description": "Incident type data for a create request.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", + "example": false, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } }, - "meta": { - "description": "The metadata object containing pagination metadata.", + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Incident type payload.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Incident type response data.", + "properties": { + "data": { + "description": "Incident type response data.", "properties": { - "pagination": { - "description": "Pagination properties.", + "attributes": { + "description": "Incident type's attributes.", "properties": { - "next_offset": { - "description": "The index of the first element in the next page of results. Equal to page size added to the current offset.", - "example": 1000, - "format": "int64", - "type": "integer" + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" }, - "offset": { - "description": "The index of the first element in the results.", - "example": 10, - "format": "int64", - "type": "integer" + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" }, - "size": { - "description": "Maximum size of pages to return.", - "example": 1000, - "format": "int64", - "type": "integer" + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", + "example": false, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "CREATED" + }, + "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": [ + "incident_settings_write" + ] + } + ], + "summary": "Create an incident type", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-given": { + "incident_type": { + "parameters": [ + { + "name": "body", + "value": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Security Incident\",\n \"description\": \"Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.\",\n \"is_default\": false\n },\n \"type\": \"incident_types\"\n }\n}" + } + ], + "step": "there is a valid \"incident_type\" in the system" + } + }, + "x-menu-order": 19, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_settings_write" + ] + }, + "x-undo": { + "operationId": "DeleteIncidentType", + "parameters": [ + { + "name": "incident_type_id", + "source": "data.id" + } + ], + "type": "unsafe" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + } + }, + "/api/v2/incidents/config/types/{incident_type_id}": { + "delete": { + "description": "Delete an incident type.", + "operationId": "DeleteIncidentType", + "parameters": [ + { + "description": "The UUID of the incident type.", + "in": "path", + "name": "incident_type_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "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": [ + "incident_settings_write" + ] + } + ], + "summary": "Delete an incident type", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 23, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_settings_write" + ] + }, + "x-undo": { + "type": "idempotent" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "get": { + "description": "Get incident type details.", + "operationId": "GetIncidentType", + "parameters": [ + { + "description": "The UUID of the incident type.", + "in": "path", + "name": "incident_type_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Incident type response data.", + "properties": { + "data": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", + "example": false, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" } }, + "required": [ + "name" + ], "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] } }, - "readOnly": true, + "required": [ + "id", + "type" + ], "type": "object" } }, @@ -222564,23 +229721,20 @@ }, { "AuthZ": [ + "incident_settings_read", "incident_read" ] } ], - "summary": "Get a list of incidents", + "summary": "Get incident type details", "tags": [ "Incidents" ], - "x-menu-order": 5, - "x-pagination": { - "limitParam": "page[size]", - "pageOffsetParam": "page[offset]", - "resultsPath": "data" - }, + "x-menu-order": 21, "x-permission": { "operator": "OR", "permissions": [ + "incident_settings_read", "incident_read" ] }, @@ -222589,281 +229743,104 @@ }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." }, - "post": { - "description": "Create an incident.", - "operationId": "CreateIncident", + "patch": { + "description": "Update an incident type.", + "operationId": "UpdateIncidentType", + "parameters": [ + { + "description": "The UUID of the incident type.", + "in": "path", + "name": "incident_type_id", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "description": "Create request for an incident.", + "description": "Patch request for an incident type.", "properties": { "data": { - "description": "Incident data for a create request.", + "description": "Incident type data for a patch request.", "properties": { "attributes": { - "description": "The incident's attributes for a create request.", + "description": "Incident type's attributes for updates.", "properties": { - "customer_impact_scope": { - "description": "Required if `customer_impacted:\"true\"`. A summary of the impact customers experienced during the incident.", - "example": "Example customer impact scope", + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, "type": "string" }, - "customer_impacted": { - "description": "A flag indicating whether the incident caused customer impact.", + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", + "type": "string" + }, + "is_default": { + "description": "When true, this incident type will be used as the default type when an incident type is not specified.", "example": false, "type": "boolean" }, - "fields": { - "additionalProperties": { - "description": "Dynamic fields for which selections can be made, with field names as keys.", - "oneOf": [ - { - "description": "A field with a single value selected.", - "properties": { - "type": { - "default": "dropdown", - "description": "Type of the single value field definitions.", - "enum": [ - "dropdown", - "textbox" - ], - "example": "dropdown", - "type": "string", - "x-enum-varnames": [ - "DROPDOWN", - "TEXTBOX" - ] - }, - "value": { - "description": "The single value selected for this field.", - "example": "SEV-1", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - { - "description": "A field with potentially multiple values selected.", - "properties": { - "type": { - "default": "multiselect", - "description": "Type of the multiple value field definitions.", - "enum": [ - "multiselect", - "textarray", - "metrictag", - "autocomplete" - ], - "example": "multiselect", - "type": "string", - "x-enum-varnames": [ - "MULTISELECT", - "TEXTARRAY", - "METRICTAG", - "AUTOCOMPLETE" - ] - }, - "value": { - "description": "The multiple values selected for this field.", - "example": [ - "1.0", - "1.1" - ], - "items": { - "description": "A value which has been selected for the parent field.", - "example": "1.1", - "type": "string" - }, - "nullable": true, - "type": "array" - } - }, - "type": "object" - } - ] - }, - "description": "A condensed view of the user-defined fields for which to create initial selections.", - "example": { - "severity": { - "type": "dropdown", - "value": "SEV-5" - } - }, - "type": "object" - }, - "incident_type_uuid": { - "description": "A unique identifier that represents an incident type. The default incident type will be used if this property is not provided.", + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, "type": "string" }, - "initial_cells": { - "description": "An array of initial timeline cells to be placed at the beginning of the incident timeline.", - "items": { - "description": "The timeline cell's attributes for a create request.", - "oneOf": [ - { - "description": "Timeline cell data for Markdown timeline cells for a create request.", - "properties": { - "cell_type": { - "default": "markdown", - "description": "Type of the Markdown timeline cell.", - "enum": [ - "markdown" - ], - "example": "markdown", - "type": "string", - "x-enum-varnames": [ - "MARKDOWN" - ] - }, - "content": { - "description": "The Markdown timeline cell contents.", - "properties": { - "content": { - "description": "The Markdown content of the cell.", - "example": "An example timeline cell message.", - "nullable": false, - "type": "string" - } - }, - "type": "object" - }, - "important": { - "default": false, - "description": "A flag indicating whether the timeline cell is important and should be highlighted.", - "example": false, - "type": "boolean" - } - }, - "required": [ - "content", - "cell_type" - ], - "type": "object" - } - ] - }, - "type": "array" + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" }, - "notification_handles": { - "description": "Notification handles that will be notified of the incident at creation.", - "example": [ - { - "display_name": "Jane Doe", - "handle": "@user@email.com" - }, - { - "display_name": "Slack Channel", - "handle": "@slack-channel" - }, - { - "display_name": "Incident Workflow", - "handle": "@workflow-from-incident" - } - ], - "items": { - "description": "A notification handle that will be notified at incident creation.", - "properties": { - "display_name": { - "description": "The name of the notified handle.", - "example": "Jane Doe", - "type": "string" - }, - "handle": { - "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", - "example": "@test.user@test.com", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" }, - "title": { - "description": "The title of the incident, which summarizes what happened.", - "example": "A test incident title", + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, "type": "string" } }, - "required": [ - "title", - "customer_impacted" - ], "type": "object" }, - "relationships": { - "description": "The relationships the incident will have with other resources once created.", - "properties": { - "commander_user": { - "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": "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "required": [ - "commander_user" - ], - "type": "object" + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" }, "type": { - "default": "incidents", - "description": "Incident resource type.", + "default": "incident_types", + "description": "Incident type resource type.", "enum": [ - "incidents" + "incident_types" ], - "example": "incidents", + "example": "incident_types", "type": "string", "x-enum-varnames": [ - "INCIDENTS" + "INCIDENT_TYPES" ] } }, "required": [ + "id", "type", "attributes" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, "required": [ @@ -222873,639 +229850,1410 @@ } } }, - "description": "Incident payload.", + "description": "Incident type payload.", "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "description": "Response with an incident.", + "description": "Incident type response data.", "properties": { "data": { - "description": "Incident data from a response.", + "description": "Incident type response data.", "properties": { "attributes": { - "description": "The incident's attributes from a response.", + "description": "Incident type's attributes.", "properties": { - "archived": { - "description": "Timestamp of when the incident was archived.", - "format": "date-time", - "nullable": true, - "readOnly": true, - "type": "string" - }, - "case_id": { - "description": "The incident case id.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "created": { - "description": "Timestamp when the incident was created.", + "createdAt": { + "description": "Timestamp when the incident type was created.", "format": "date-time", "readOnly": true, "type": "string" }, - "customer_impact_duration": { - "description": "Length of the incident's customer impact in seconds.\nEquals the difference between `customer_impact_start` and `customer_impact_end`.", - "format": "int64", + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", "readOnly": true, - "type": "integer" - }, - "customer_impact_end": { - "description": "Timestamp when customers were no longer impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impact_scope": { - "description": "A summary of the impact customers experienced during the incident.", - "example": "An example customer impact scope", - "nullable": true, "type": "string" }, - "customer_impact_start": { - "description": "Timestamp when customers began being impacted by the incident.", - "format": "date-time", - "nullable": true, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", "type": "string" }, - "customer_impacted": { - "description": "A flag indicating whether the incident caused customer impact.", + "is_default": { + "default": false, + "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", "example": false, "type": "boolean" }, - "detected": { - "description": "Timestamp when the incident was detected.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "fields": { - "additionalProperties": { - "description": "Dynamic fields for which selections can be made, with field names as keys.", - "oneOf": [ - { - "description": "A field with a single value selected.", - "properties": { - "type": { - "default": "dropdown", - "description": "Type of the single value field definitions.", - "enum": [ - "dropdown", - "textbox" - ], - "example": "dropdown", - "type": "string", - "x-enum-varnames": [ - "DROPDOWN", - "TEXTBOX" - ] - }, - "value": { - "description": "The single value selected for this field.", - "example": "SEV-1", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - { - "description": "A field with potentially multiple values selected.", - "properties": { - "type": { - "default": "multiselect", - "description": "Type of the multiple value field definitions.", - "enum": [ - "multiselect", - "textarray", - "metrictag", - "autocomplete" - ], - "example": "multiselect", - "type": "string", - "x-enum-varnames": [ - "MULTISELECT", - "TEXTARRAY", - "METRICTAG", - "AUTOCOMPLETE" - ] - }, - "value": { - "description": "The multiple values selected for this field.", - "example": [ - "1.0", - "1.1" - ], - "items": { - "description": "A value which has been selected for the parent field.", - "example": "1.1", - "type": "string" - }, - "nullable": true, - "type": "array" - } - }, - "type": "object" - } - ] - }, - "description": "A condensed view of the user-defined fields attached to incidents.", - "example": { - "severity": { - "type": "dropdown", - "value": "SEV-5" - } - }, - "type": "object" - }, - "incident_type_uuid": { - "description": "A unique identifier that represents an incident type.", + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", "example": "00000000-0000-0000-0000-000000000000", - "type": "string" - }, - "modified": { - "description": "Timestamp when the incident was last modified.", - "format": "date-time", "readOnly": true, "type": "string" }, - "non_datadog_creator": { - "description": "Incident's non Datadog creator.", - "nullable": true, - "properties": { - "image_48_px": { - "description": "Non Datadog creator `48px` image.", - "type": "string" - }, - "name": { - "description": "Non Datadog creator name.", - "type": "string" - } - }, - "type": "object" - }, - "notification_handles": { - "description": "Notification handles that will be notified of the incident during update.", - "example": [ - { - "display_name": "Jane Doe", - "handle": "@user@email.com" - }, - { - "display_name": "Slack Channel", - "handle": "@slack-channel" - }, - { - "display_name": "Incident Workflow", - "handle": "@workflow-from-incident" - } - ], - "items": { - "description": "A notification handle that will be notified at incident creation.", - "properties": { - "display_name": { - "description": "The name of the notified handle.", - "example": "Jane Doe", - "type": "string" - }, - "handle": { - "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", - "example": "@test.user@test.com", - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "public_id": { - "description": "The monotonically increasing integer ID for the incident.", - "example": 1, - "format": "int64", - "type": "integer" - }, - "resolved": { - "description": "Timestamp when the incident's state was last changed from active or stable to resolved or completed.", + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", "format": "date-time", - "nullable": true, + "readOnly": true, "type": "string" }, - "severity": { - "description": "The incident severity.", - "enum": [ - "UNKNOWN", - "SEV-1", - "SEV-2", - "SEV-3", - "SEV-4", - "SEV-5" - ], - "example": "UNKNOWN", - "type": "string", - "x-enum-varnames": [ - "UNKNOWN", - "SEV_1", - "SEV_2", - "SEV_3", - "SEV_4", - "SEV_5" - ] - }, - "state": { - "description": "The state incident.", - "nullable": true, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", "type": "string" }, - "time_to_detect": { - "description": "The amount of time in seconds to detect the incident.\nEquals the difference between `customer_impact_start` and `detected`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_internal_response": { - "description": "The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_repair": { - "description": "The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_resolve": { - "description": "The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`.", - "format": "int64", + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", "readOnly": true, - "type": "integer" - }, - "title": { - "description": "The title of the incident, which summarizes what happened.", - "example": "A test incident title", - "type": "string" - }, - "visibility": { - "description": "The incident visibility status.", - "nullable": true, "type": "string" } }, "required": [ - "title" + "name" ], "type": "object" }, "id": { - "description": "The incident's ID.", - "example": "00000000-0000-0000-1234-000000000000", + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" }, - "relationships": { - "description": "The incident's relationships from a response.", + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "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": [ + "incident_settings_write" + ] + } + ], + "summary": "Update an incident type", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 22, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_settings_write" + ] + }, + "x-undo": { + "type": "idempotent" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + } + }, + "/api/v2/incidents/search": { + "get": { + "description": "Search for incidents matching a certain query.", + "operationId": "SearchIncidents", + "parameters": [ + { + "description": "Specifies which types of related objects should be included in the response.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "description": "Object related to an incident.", + "enum": [ + "users", + "attachments" + ], + "type": "string", + "x-enum-varnames": [ + "USERS", + "ATTACHMENTS" + ] + } + }, + { + "description": "Specifies which incidents should be returned. The query can contain any number of incident facets\njoined by `ANDs`, along with multiple values for each of those facets joined by `OR`s. For\nexample: `state:active AND severity:(SEV-2 OR SEV-1)`.", + "explode": false, + "in": "query", + "name": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the order of returned incidents.", + "explode": false, + "in": "query", + "name": "sort", + "required": false, + "schema": { + "description": "The ways searched incidents can be sorted.", + "enum": [ + "created", + "-created" + ], + "type": "string", + "x-enum-varnames": [ + "CREATED_ASCENDING", + "CREATED_DESCENDING" + ] + } + }, + { + "description": "Size for a given page. The maximum allowed value is 100.", + "in": "query", + "name": "page[size]", + "required": false, + "schema": { + "default": 10, + "example": 10, + "format": "int64", + "type": "integer" + } + }, + { + "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" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response with incidents and facets.", + "properties": { + "data": { + "description": "Data returned by an incident search.", + "properties": { + "attributes": { + "description": "Attributes returned by an incident search.", "properties": { - "attachments": { - "description": "A relationship reference for attachments.", + "facets": { + "description": "Facet data for incidents returned by a search query.", "properties": { - "data": { - "description": "An array of incident attachments.", + "commander": { + "description": "Facet data for incident commander users.", "items": { - "description": "The attachment relationship data.", + "description": "Facet data for user attributes of an incident.", "properties": { - "id": { - "description": "A unique identifier that represents the attachment.", - "example": "00000000-0000-abcd-1000-000000000000", + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "email": { + "description": "Email of the user.", + "example": "datadog.user@example.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "@datadog.user@example.com", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "Datadog User", + "type": "string" + }, + "uuid": { + "description": "ID of the user.", + "example": "773b045d-ccf8-4808-bd3b-955ef6a8c940", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "created_by": { + "description": "Facet data for incident creator users.", + "items": { + "description": "Facet data for user attributes of an incident.", + "properties": { + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "email": { + "description": "Email of the user.", + "example": "datadog.user@example.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "@datadog.user@example.com", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "Datadog User", "type": "string" }, - "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", - "enum": [ - "incident_attachments" - ], - "example": "incident_attachments", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" - ] + "uuid": { + "description": "ID of the user.", + "example": "773b045d-ccf8-4808-bd3b-955ef6a8c940", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "fields": { + "description": "Facet data for incident property fields.", + "items": { + "description": "Facet data for the incident property fields.", + "properties": { + "aggregates": { + "description": "Aggregate information for numeric incident data.", + "properties": { + "max": { + "description": "Maximum value of the numeric aggregates.", + "example": 1234, + "format": "double", + "nullable": true, + "type": "number" + }, + "min": { + "description": "Minimum value of the numeric aggregates.", + "example": 20, + "format": "double", + "nullable": true, + "type": "number" + } + }, + "type": "object" + }, + "facets": { + "description": "Facet data for the property field of an incident.", + "items": { + "description": "Facet value and number of occurrences for a property field of an incident.", + "properties": { + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "name": { + "description": "The facet value appearing in search results.", + "example": "SEV-2", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "name": { + "description": "Name of the incident property field.", + "example": "Severity", + "type": "string" } }, "required": [ - "id", - "type" + "facets", + "name" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "commander_user": { - "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": "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "created_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + }, + "impact": { + "description": "Facet data for incident impact attributes.", + "items": { + "description": "Facet value and number of occurrences for a property field of an incident.", + "properties": { + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "name": { + "description": "The facet value appearing in search results.", + "example": "SEV-2", + "type": "string" + } }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } + "type": "object" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "impacts": { - "description": "Relationship to impacts.", - "properties": { - "data": { - "description": "An array of incident impacts.", + "type": "array" + }, + "last_modified_by": { + "description": "Facet data for incident last modified by users.", "items": { - "description": "Relationship to impact object.", + "description": "Facet data for user attributes of an incident.", "properties": { - "id": { - "description": "A unique identifier that represents the impact.", - "example": "00000000-0000-0000-2345-000000000000", + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "email": { + "description": "Email of the user.", + "example": "datadog.user@example.com", "type": "string" }, - "type": { - "description": "The incident impacts type.", - "enum": [ - "incident_impacts" - ], - "example": "incident_impacts", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_IMPACTS" - ] + "handle": { + "description": "Handle of the user.", + "example": "@datadog.user@example.com", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "Datadog User", + "type": "string" + }, + "uuid": { + "description": "ID of the user.", + "example": "773b045d-ccf8-4808-bd3b-955ef6a8c940", + "type": "string" } }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "integrations": { - "description": "A relationship reference for multiple integration metadata objects.", - "example": { - "data": [ - { - "id": "00000000-abcd-0005-0000-000000000000", - "type": "incident_integrations" + }, + "postmortem": { + "description": "Facet data for incident postmortem existence.", + "items": { + "description": "Facet value and number of occurrences for a property field of an incident.", + "properties": { + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "name": { + "description": "The facet value appearing in search results.", + "example": "SEV-2", + "type": "string" + } + }, + "type": "object" }, - { - "id": "00000000-abcd-0006-0000-000000000000", - "type": "incident_integrations" - } - ] - }, - "properties": { - "data": { - "description": "Integration metadata relationship array", - "example": [ - { - "id": "00000000-abcd-0003-0000-000000000000", - "type": "incident_integrations" + "type": "array" + }, + "responder": { + "description": "Facet data for incident responder users.", + "items": { + "description": "Facet data for user attributes of an incident.", + "properties": { + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "email": { + "description": "Email of the user.", + "example": "datadog.user@example.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "@datadog.user@example.com", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "Datadog User", + "type": "string" + }, + "uuid": { + "description": "ID of the user.", + "example": "773b045d-ccf8-4808-bd3b-955ef6a8c940", + "type": "string" + } }, - { - "id": "00000000-abcd-0004-0000-000000000000", - "type": "incident_integrations" - } - ], + "type": "object" + }, + "type": "array" + }, + "severity": { + "description": "Facet data for incident severity attributes.", "items": { - "description": "A relationship reference for an integration metadata object.", - "example": { - "id": "00000000-abcd-0002-0000-000000000000", - "type": "incident_integrations" + "description": "Facet value and number of occurrences for a property field of an incident.", + "properties": { + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "name": { + "description": "The facet value appearing in search results.", + "example": "SEV-2", + "type": "string" + } }, + "type": "object" + }, + "type": "array" + }, + "state": { + "description": "Facet data for incident state attributes.", + "items": { + "description": "Facet value and number of occurrences for a property field of an incident.", "properties": { - "id": { - "description": "A unique identifier that represents the integration metadata.", - "example": "00000000-abcd-0001-0000-000000000000", + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "name": { + "description": "The facet value appearing in search results.", + "example": "SEV-2", "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "time_to_repair": { + "description": "Facet data for incident time to repair metrics.", + "items": { + "description": "Facet data numeric attributes of an incident.", + "properties": { + "aggregates": { + "description": "Aggregate information for numeric incident data.", + "properties": { + "max": { + "description": "Maximum value of the numeric aggregates.", + "example": 1234, + "format": "double", + "nullable": true, + "type": "number" + }, + "min": { + "description": "Minimum value of the numeric aggregates.", + "example": 20, + "format": "double", + "nullable": true, + "type": "number" + } + }, + "type": "object" }, - "type": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", - "enum": [ - "incident_integrations" - ], - "example": "incident_integrations", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" - ] + "name": { + "description": "Name of the incident property field.", + "example": "time_to_repair", + "type": "string" } }, "required": [ - "id", - "type" + "name", + "aggregates" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "responders": { - "description": "Relationship to incident responders.", - "properties": { - "data": { - "description": "An array of incident responders.", + }, + "time_to_resolve": { + "description": "Facet data for incident time to resolve metrics.", "items": { - "description": "Relationship to impact object.", + "description": "Facet data numeric attributes of an incident.", "properties": { - "id": { - "description": "A unique identifier that represents the responder.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + "aggregates": { + "description": "Aggregate information for numeric incident data.", + "properties": { + "max": { + "description": "Maximum value of the numeric aggregates.", + "example": 1234, + "format": "double", + "nullable": true, + "type": "number" + }, + "min": { + "description": "Minimum value of the numeric aggregates.", + "example": 20, + "format": "double", + "nullable": true, + "type": "number" + } + }, + "type": "object" }, - "type": { - "description": "The incident responders type.", - "enum": [ - "incident_responders" - ], - "example": "incident_responders", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_RESPONDERS" - ] + "name": { + "description": "Name of the incident property field.", + "example": "time_to_repair", + "type": "string" } }, "required": [ - "id", - "type" + "name", + "aggregates" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, "type": "array" } }, - "required": [ - "data" - ], "type": "object" }, - "user_defined_fields": { - "description": "Relationship to incident user defined fields.", - "properties": { - "data": { - "description": "An array of user defined fields.", - "items": { - "description": "Relationship to impact object.", + "incidents": { + "description": "Incidents returned by the search.", + "items": { + "description": "Incident returned by the search.", + "properties": { + "data": { + "description": "Incident data from a response.", "properties": { + "attributes": { + "description": "The incident's attributes from a response.", + "properties": { + "archived": { + "description": "Timestamp of when the incident was archived.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "case_id": { + "description": "The incident case id.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "created": { + "description": "Timestamp when the incident was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "customer_impact_duration": { + "description": "Length of the incident's customer impact in seconds.\nEquals the difference between `customer_impact_start` and `customer_impact_end`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "customer_impact_end": { + "description": "Timestamp when customers were no longer impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impact_scope": { + "description": "A summary of the impact customers experienced during the incident.", + "example": "An example customer impact scope", + "nullable": true, + "type": "string" + }, + "customer_impact_start": { + "description": "Timestamp when customers began being impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impacted": { + "description": "A flag indicating whether the incident caused customer impact.", + "example": false, + "type": "boolean" + }, + "detected": { + "description": "Timestamp when the incident was detected.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "fields": { + "additionalProperties": { + "description": "Dynamic fields for which selections can be made, with field names as keys.", + "oneOf": [ + { + "description": "A field with a single value selected.", + "properties": { + "type": { + "default": "dropdown", + "description": "Type of the single value field definitions.", + "enum": [ + "dropdown", + "textbox" + ], + "example": "dropdown", + "type": "string", + "x-enum-varnames": [ + "DROPDOWN", + "TEXTBOX" + ] + }, + "value": { + "description": "The single value selected for this field.", + "example": "SEV-1", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + { + "description": "A field with potentially multiple values selected.", + "properties": { + "type": { + "default": "multiselect", + "description": "Type of the multiple value field definitions.", + "enum": [ + "multiselect", + "textarray", + "metrictag", + "autocomplete" + ], + "example": "multiselect", + "type": "string", + "x-enum-varnames": [ + "MULTISELECT", + "TEXTARRAY", + "METRICTAG", + "AUTOCOMPLETE" + ] + }, + "value": { + "description": "The multiple values selected for this field.", + "example": [ + "1.0", + "1.1" + ], + "items": { + "description": "A value which has been selected for the parent field.", + "example": "1.1", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "description": "A condensed view of the user-defined fields attached to incidents.", + "example": { + "severity": { + "type": "dropdown", + "value": "SEV-5" + } + }, + "type": "object" + }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "modified": { + "description": "Timestamp when the incident was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "non_datadog_creator": { + "description": "Incident's non Datadog creator.", + "nullable": true, + "properties": { + "image_48_px": { + "description": "Non Datadog creator `48px` image.", + "type": "string" + }, + "name": { + "description": "Non Datadog creator name.", + "type": "string" + } + }, + "type": "object" + }, + "notification_handles": { + "description": "Notification handles that will be notified of the incident during update.", + "example": [ + { + "display_name": "Jane Doe", + "handle": "@user@email.com" + }, + { + "display_name": "Slack Channel", + "handle": "@slack-channel" + }, + { + "display_name": "Incident Workflow", + "handle": "@workflow-from-incident" + } + ], + "items": { + "description": "A notification handle that will be notified at incident creation.", + "properties": { + "display_name": { + "description": "The name of the notified handle.", + "example": "Jane Doe", + "type": "string" + }, + "handle": { + "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", + "example": "@test.user@test.com", + "type": "string" + } + }, + "type": "object" + }, + "nullable": true, + "type": "array" + }, + "public_id": { + "description": "The monotonically increasing integer ID for the incident.", + "example": 1, + "format": "int64", + "type": "integer" + }, + "resolved": { + "description": "Timestamp when the incident's state was last changed from active or stable to resolved or completed.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "severity": { + "description": "The incident severity.", + "enum": [ + "UNKNOWN", + "SEV-1", + "SEV-2", + "SEV-3", + "SEV-4", + "SEV-5" + ], + "example": "UNKNOWN", + "type": "string", + "x-enum-varnames": [ + "UNKNOWN", + "SEV_1", + "SEV_2", + "SEV_3", + "SEV_4", + "SEV_5" + ] + }, + "state": { + "description": "The state incident.", + "nullable": true, + "type": "string" + }, + "time_to_detect": { + "description": "The amount of time in seconds to detect the incident.\nEquals the difference between `customer_impact_start` and `detected`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_internal_response": { + "description": "The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_repair": { + "description": "The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_resolve": { + "description": "The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "title": { + "description": "The title of the incident, which summarizes what happened.", + "example": "A test incident title", + "type": "string" + }, + "visibility": { + "description": "The incident visibility status.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "title" + ], + "type": "object" + }, "id": { - "description": "A unique identifier that represents the responder.", - "example": "00000000-0000-0000-2345-000000000000", + "description": "The incident's ID.", + "example": "00000000-0000-0000-1234-000000000000", "type": "string" }, + "relationships": { + "description": "The incident's relationships from a response.", + "properties": { + "attachments": { + "description": "A relationship reference for attachments.", + "properties": { + "data": { + "description": "An array of incident attachments.", + "items": { + "description": "The attachment relationship data.", + "properties": { + "id": { + "description": "A unique identifier that represents the attachment.", + "example": "00000000-0000-abcd-1000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "commander_user": { + "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": "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "impacts": { + "description": "Relationship to impacts.", + "properties": { + "data": { + "description": "An array of incident impacts.", + "items": { + "description": "Relationship to impact object.", + "properties": { + "id": { + "description": "A unique identifier that represents the impact.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "description": "The incident impacts type.", + "enum": [ + "incident_impacts" + ], + "example": "incident_impacts", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_IMPACTS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "integrations": { + "description": "A relationship reference for multiple integration metadata objects.", + "example": { + "data": [ + { + "id": "00000000-abcd-0005-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0006-0000-000000000000", + "type": "incident_integrations" + } + ] + }, + "properties": { + "data": { + "description": "Integration metadata relationship array", + "example": [ + { + "id": "00000000-abcd-0003-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0004-0000-000000000000", + "type": "incident_integrations" + } + ], + "items": { + "description": "A relationship reference for an integration metadata object.", + "example": { + "id": "00000000-abcd-0002-0000-000000000000", + "type": "incident_integrations" + }, + "properties": { + "id": { + "description": "A unique identifier that represents the integration metadata.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_integrations", + "description": "Integration metadata resource type.", + "enum": [ + "incident_integrations" + ], + "example": "incident_integrations", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_INTEGRATIONS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "responders": { + "description": "Relationship to incident responders.", + "properties": { + "data": { + "description": "An array of incident responders.", + "items": { + "description": "Relationship to impact object.", + "properties": { + "id": { + "description": "A unique identifier that represents the responder.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "description": "The incident responders type.", + "enum": [ + "incident_responders" + ], + "example": "incident_responders", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_RESPONDERS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "user_defined_fields": { + "description": "Relationship to incident user defined fields.", + "properties": { + "data": { + "description": "An array of user defined fields.", + "items": { + "description": "Relationship to impact object.", + "properties": { + "id": { + "description": "A unique identifier that represents the responder.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "description": "The incident user defined fields type.", + "enum": [ + "user_defined_field" + ], + "example": "user_defined_field", + "type": "string", + "x-enum-varnames": [ + "USER_DEFINED_FIELD" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, "type": { - "description": "The incident user defined fields type.", + "default": "incidents", + "description": "Incident resource type.", "enum": [ - "user_defined_field" + "incidents" ], - "example": "user_defined_field", + "example": "incidents", "type": "string", "x-enum-varnames": [ - "USER_DEFINED_FIELD" + "INCIDENTS" ] } }, @@ -223517,1418 +231265,321 @@ "x-merge-override": { "required": false } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "incidents", - "description": "Incident resource type.", - "enum": [ - "incidents" - ], - "example": "incidents", - "type": "string", - "x-enum-varnames": [ - "INCIDENTS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "included": { - "description": "Included related resources that the user requested.", - "items": { - "description": "An object related to an incident that is included in the response.", - "oneOf": [ - { - "description": "User object returned by the API.", - "properties": { - "attributes": { - "description": "Attributes of user object returned by the API.", - "properties": { - "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" - }, - "name": { - "description": "Name of the user.", - "nullable": true, - "type": "string" - }, - "uuid": { - "description": "UUID of the user.", - "type": "string" } }, - "type": "object" - }, - "id": { - "description": "ID of the user.", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" + "required": [ + "data" ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object" - }, - { - "description": "A single incident attachment.", - "example": { - "attributes": { - "attachment": { - "documentUrl": "", - "title": "Postmortem IR-123" - }, - "attachment_type": "postmortem" - }, - "id": "00000000-abcd-0002-0000-000000000000", - "relationships": { - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - } - }, - "type": "incident_attachments" - }, - "properties": { - "attributes": { - "description": "The attributes object for an attachment.", - "oneOf": [ - { - "description": "The attributes object for a postmortem attachment.", - "properties": { - "attachment": { - "description": "The postmortem attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this notebook attachment.", - "example": "https://app.datadoghq.com/notebook/123", - "type": "string" - }, - "title": { - "description": "The title of this postmortem attachment.", - "example": "Postmortem IR-123", - "type": "string" - } - }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" - }, - "attachment_type": { - "default": "postmortem", - "description": "The type of postmortem attachment attributes.", - "enum": [ - "postmortem" - ], - "example": "postmortem", - "type": "string", - "x-enum-varnames": [ - "POSTMORTEM" - ] - } - }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - }, - { - "description": "The attributes object for a link attachment.", - "properties": { - "attachment": { - "description": "The link attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this link attachment.", - "example": "https://www.example.com/webstore-failure-runbook", - "type": "string" - }, - "title": { - "description": "The title of this link attachment.", - "example": "Runbook for webstore service failures", - "type": "string" - } - }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" - }, - "attachment_type": { - "default": "link", - "description": "The type of link attachment attributes.", - "enum": [ - "link" - ], - "example": "link", - "type": "string", - "x-enum-varnames": [ - "LINK" - ] - }, - "modified": { - "description": "Timestamp when the incident attachment link was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - } - }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - } - ] - }, - "id": { - "description": "A unique identifier that represents the incident attachment.", - "example": "00000000-abcd-0001-0000-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident attachment's relationships.", - "properties": { - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, "type": "object" }, - "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", - "enum": [ - "incident_attachments" - ], - "example": "incident_attachments", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" - ] - } - }, - "required": [ - "type", - "attributes", - "id", - "relationships" - ], - "type": "object" - } - ] - }, - "readOnly": true, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "description": "CREATED" - }, - "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": [ - "incident_write" - ] - } - ], - "summary": "Create an incident", - "tags": [ - "Incidents" - ], - "x-codegen-request-body-name": "body", - "x-given": { - "incident": { - "parameters": [ - { - "name": "body", - "value": "{\n \"data\": {\n \"attributes\": {\n \"title\": \"{{ unique }}\",\n \"customer_impacted\": false\n },\n \"type\": \"incidents\"\n }\n}" - } - ], - "step": "there is a valid \"incident\" in the system" - } - }, - "x-menu-order": 1, - "x-permission": { - "operator": "OR", - "permissions": [ - "incident_write" - ] - }, - "x-undo": { - "operationId": "DeleteIncident", - "parameters": [ - { - "name": "incident_id", - "source": "data.id" - } - ], - "type": "unsafe" - }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - } - }, - "/api/v2/incidents/config/types": { - "get": { - "description": "Get all incident types.", - "operationId": "ListIncidentTypes", - "parameters": [ - { - "description": "Include deleted incident types in the response.", - "in": "query", - "name": "include_deleted", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "Response with a list of incident types.", - "properties": { - "data": { - "description": "An array of incident type objects.", - "items": { - "description": "Incident type response data.", - "properties": { - "attributes": { - "description": "Incident type's attributes.", - "properties": { - "createdAt": { - "description": "Timestamp when the incident type was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "createdBy": { - "description": "A unique identifier that represents the user that created the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Text that describes the incident type.", - "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", - "type": "string" - }, - "is_default": { - "default": false, - "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", - "example": false, - "type": "boolean" - }, - "lastModifiedBy": { - "description": "A unique identifier that represents the user that last modified the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "modifiedAt": { - "description": "Timestamp when the incident type was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the incident type.", - "example": "Security Incident", - "type": "string" - }, - "prefix": { - "description": "The string that will be prepended to the incident title across the Datadog app.", - "example": "IR", - "readOnly": true, - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "id": { - "description": "The incident type's ID.", - "example": "00000000-0000-0000-0000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_types", - "description": "Incident type resource type.", - "enum": [ - "incident_types" - ], - "example": "incident_types", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_TYPES" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "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" - }, - "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": [ - "incident_settings_read", - "incident_read" - ] - } - ], - "summary": "Get a list of incident types", - "tags": [ - "Incidents" - ], - "x-menu-order": 20, - "x-permission": { - "operator": "OR", - "permissions": [ - "incident_settings_read", - "incident_read" - ] - }, - "x-undo": { - "type": "safe" - }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - }, - "post": { - "description": "Create an incident type.", - "operationId": "CreateIncidentType", - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Create request for an incident type.", - "properties": { - "data": { - "description": "Incident type data for a create request.", - "properties": { - "attributes": { - "description": "Incident type's attributes.", - "properties": { - "createdAt": { - "description": "Timestamp when the incident type was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "createdBy": { - "description": "A unique identifier that represents the user that created the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Text that describes the incident type.", - "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", - "type": "string" - }, - "is_default": { - "default": false, - "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", - "example": false, - "type": "boolean" - }, - "lastModifiedBy": { - "description": "A unique identifier that represents the user that last modified the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "modifiedAt": { - "description": "Timestamp when the incident type was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the incident type.", - "example": "Security Incident", - "type": "string" - }, - "prefix": { - "description": "The string that will be prepended to the incident title across the Datadog app.", - "example": "IR", - "readOnly": true, - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "type": { - "default": "incident_types", - "description": "Incident type resource type.", - "enum": [ - "incident_types" - ], - "example": "incident_types", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_TYPES" - ] - } - }, - "required": [ - "type", - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "description": "Incident type payload.", - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "description": "Incident type response data.", - "properties": { - "data": { - "description": "Incident type response data.", - "properties": { - "attributes": { - "description": "Incident type's attributes.", - "properties": { - "createdAt": { - "description": "Timestamp when the incident type was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "createdBy": { - "description": "A unique identifier that represents the user that created the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Text that describes the incident type.", - "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", - "type": "string" - }, - "is_default": { - "default": false, - "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", - "example": false, - "type": "boolean" - }, - "lastModifiedBy": { - "description": "A unique identifier that represents the user that last modified the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "modifiedAt": { - "description": "Timestamp when the incident type was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the incident type.", - "example": "Security Incident", - "type": "string" + "type": "array" }, - "prefix": { - "description": "The string that will be prepended to the incident title across the Datadog app.", - "example": "IR", - "readOnly": true, - "type": "string" + "total": { + "description": "Number of incidents returned by the search.", + "example": 10, + "format": "int32", + "maximum": 2147483647, + "type": "integer" } }, "required": [ - "name" - ], - "type": "object" - }, - "id": { - "description": "The incident type's ID.", - "example": "00000000-0000-0000-0000-000000000000", - "type": "string" + "facets", + "incidents", + "total" + ], + "type": "object" }, "type": { - "default": "incident_types", - "description": "Incident type resource type.", + "default": "incidents_search_results", + "description": "Incident search result type.", "enum": [ - "incident_types" + "incidents_search_results" ], - "example": "incident_types", + "example": "incidents_search_results", "type": "string", "x-enum-varnames": [ - "INCIDENT_TYPES" + "INCIDENTS_SEARCH_RESULTS" ] } }, - "required": [ - "id", - "type" - ], "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "description": "CREATED" - }, - "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": [ - "incident_settings_write" - ] - } - ], - "summary": "Create an incident type", - "tags": [ - "Incidents" - ], - "x-codegen-request-body-name": "body", - "x-given": { - "incident_type": { - "parameters": [ - { - "name": "body", - "value": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Security Incident\",\n \"description\": \"Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.\",\n \"is_default\": false\n },\n \"type\": \"incident_types\"\n }\n}" - } - ], - "step": "there is a valid \"incident_type\" in the system" - } - }, - "x-menu-order": 19, - "x-permission": { - "operator": "OR", - "permissions": [ - "incident_settings_write" - ] - }, - "x-undo": { - "operationId": "DeleteIncidentType", - "parameters": [ - { - "name": "incident_type_id", - "source": "data.id" - } - ], - "type": "unsafe" - }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - } - }, - "/api/v2/incidents/config/types/{incident_type_id}": { - "delete": { - "description": "Delete an incident type.", - "operationId": "DeleteIncidentType", - "parameters": [ - { - "description": "The UUID of the incident type.", - "in": "path", - "name": "incident_type_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "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" - ], + }, + "included": { + "description": "Included related resources that the user requested.", "items": { - "description": "A list of items.", - "example": "Bad Request", - "type": "string" + "description": "An object related to an incident that is included in the response.", + "oneOf": [ + { + "description": "User object returned by the API.", + "properties": { + "attributes": { + "description": "Attributes of user object returned by the API.", + "properties": { + "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" + }, + "name": { + "description": "Name of the user.", + "nullable": true, + "type": "string" + }, + "uuid": { + "description": "UUID of the user.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the user.", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + }, + { + "description": "A single incident attachment.", + "example": { + "attributes": { + "attachment": { + "documentUrl": "", + "title": "Postmortem IR-123" + }, + "attachment_type": "postmortem" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + }, + "properties": { + "attributes": { + "description": "The attributes object for an attachment.", + "oneOf": [ + { + "description": "The attributes object for a postmortem attachment.", + "properties": { + "attachment": { + "description": "The postmortem attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this notebook attachment.", + "example": "https://app.datadoghq.com/notebook/123", + "type": "string" + }, + "title": { + "description": "The title of this postmortem attachment.", + "example": "Postmortem IR-123", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" + }, + "attachment_type": { + "default": "postmortem", + "description": "The type of postmortem attachment attributes.", + "enum": [ + "postmortem" + ], + "example": "postmortem", + "type": "string", + "x-enum-varnames": [ + "POSTMORTEM" + ] + } + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + }, + { + "description": "The attributes object for a link attachment.", + "properties": { + "attachment": { + "description": "The link attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this link attachment.", + "example": "https://www.example.com/webstore-failure-runbook", + "type": "string" + }, + "title": { + "description": "The title of this link attachment.", + "example": "Runbook for webstore service failures", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" + }, + "attachment_type": { + "default": "link", + "description": "The type of link attachment attributes.", + "enum": [ + "link" + ], + "example": "link", + "type": "string", + "x-enum-varnames": [ + "LINK" + ] + }, + "modified": { + "description": "Timestamp when the incident attachment link was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + } + ] + }, + "id": { + "description": "A unique identifier that represents the incident attachment.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident attachment's relationships.", + "properties": { + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] + } + }, + "required": [ + "type", + "attributes", + "id", + "relationships" + ], + "type": "object" + } + ] }, + "readOnly": true, "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - } - } - }, - "description": "Too many requests" - } - }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "incident_settings_write" - ] - } - ], - "summary": "Delete an incident type", - "tags": [ - "Incidents" - ], - "x-codegen-request-body-name": "body", - "x-menu-order": 23, - "x-permission": { - "operator": "OR", - "permissions": [ - "incident_settings_write" - ] - }, - "x-undo": { - "type": "idempotent" - }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - }, - "get": { - "description": "Get incident type details.", - "operationId": "GetIncidentType", - "parameters": [ - { - "description": "The UUID of the incident type.", - "in": "path", - "name": "incident_type_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "Incident type response data.", - "properties": { - "data": { - "description": "Incident type response data.", + }, + "meta": { + "description": "The metadata object containing pagination metadata.", "properties": { - "attributes": { - "description": "Incident type's attributes.", + "pagination": { + "description": "Pagination properties.", "properties": { - "createdAt": { - "description": "Timestamp when the incident type was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "createdBy": { - "description": "A unique identifier that represents the user that created the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Text that describes the incident type.", - "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", - "type": "string" - }, - "is_default": { - "default": false, - "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", - "example": false, - "type": "boolean" - }, - "lastModifiedBy": { - "description": "A unique identifier that represents the user that last modified the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "modifiedAt": { - "description": "Timestamp when the incident type was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" + "next_offset": { + "description": "The index of the first element in the next page of results. Equal to page size added to the current offset.", + "example": 1000, + "format": "int64", + "type": "integer" }, - "name": { - "description": "The name of the incident type.", - "example": "Security Incident", - "type": "string" + "offset": { + "description": "The index of the first element in the results.", + "example": 10, + "format": "int64", + "type": "integer" }, - "prefix": { - "description": "The string that will be prepended to the incident title across the Datadog app.", - "example": "IR", - "readOnly": true, - "type": "string" + "size": { + "description": "Maximum size of pages to return.", + "example": 1000, + "format": "int64", + "type": "integer" } }, - "required": [ - "name" - ], "type": "object" - }, - "id": { - "description": "The incident type's ID.", - "example": "00000000-0000-0000-0000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_types", - "description": "Incident type resource type.", - "enum": [ - "incident_types" - ], - "example": "incident_types", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_TYPES" - ] } }, - "required": [ - "id", - "type" - ], + "readOnly": true, "type": "object" } }, @@ -225037,287 +231688,101 @@ "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": [ - "incident_settings_read", - "incident_read" - ] - } - ], - "summary": "Get incident type details", - "tags": [ - "Incidents" - ], - "x-menu-order": 21, - "x-permission": { - "operator": "OR", - "permissions": [ - "incident_settings_read", - "incident_read" - ] - }, - "x-undo": { - "type": "safe" - }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - }, - "patch": { - "description": "Update an incident type.", - "operationId": "UpdateIncidentType", - "parameters": [ - { - "description": "The UUID of the incident type.", - "in": "path", - "name": "incident_type_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Patch request for an incident type.", - "properties": { - "data": { - "description": "Incident type data for a patch request.", - "properties": { - "attributes": { - "description": "Incident type's attributes for updates.", - "properties": { - "createdAt": { - "description": "Timestamp when the incident type was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "createdBy": { - "description": "A unique identifier that represents the user that created the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Text that describes the incident type.", - "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", - "type": "string" - }, - "is_default": { - "description": "When true, this incident type will be used as the default type when an incident type is not specified.", - "example": false, - "type": "boolean" - }, - "lastModifiedBy": { - "description": "A unique identifier that represents the user that last modified the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "modifiedAt": { - "description": "Timestamp when the incident type was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the incident type.", - "example": "Security Incident", - "type": "string" - }, - "prefix": { - "description": "The string that will be prepended to the incident title across the Datadog app.", - "example": "IR", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "The incident type's ID.", - "example": "00000000-0000-0000-0000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_types", - "description": "Incident type resource type.", - "enum": [ - "incident_types" - ], - "example": "incident_types", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_TYPES" - ] - } - }, - "required": [ - "id", - "type", - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "description": "Incident type payload.", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "Incident type response data.", - "properties": { - "data": { - "description": "Incident type response data.", - "properties": { - "attributes": { - "description": "Incident type's attributes.", - "properties": { - "createdAt": { - "description": "Timestamp when the incident type was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "createdBy": { - "description": "A unique identifier that represents the user that created the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Text that describes the incident type.", - "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", - "type": "string" - }, - "is_default": { - "default": false, - "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", - "example": false, - "type": "boolean" - }, - "lastModifiedBy": { - "description": "A unique identifier that represents the user that last modified the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "modifiedAt": { - "description": "Timestamp when the incident type was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the incident type.", - "example": "Security Incident", - "type": "string" - }, - "prefix": { - "description": "The string that will be prepended to the incident title across the Datadog app.", - "example": "IR", - "readOnly": true, - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "id": { - "description": "The incident type's ID.", - "example": "00000000-0000-0000-0000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_types", - "description": "Incident type resource type.", - "enum": [ - "incident_types" - ], - "example": "incident_types", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_TYPES" - ] - } + "description": "A list of items.", + "example": "Bad Request", + "type": "string" }, - "required": [ - "id", - "type" + "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" ], - "type": "object" + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" } }, "required": [ - "data" + "errors" ], "type": "object" } } }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_read" + ] + } + ], + "summary": "Search for incidents", + "tags": [ + "Incidents" + ], + "x-menu-order": 6, + "x-pagination": { + "limitParam": "page[size]", + "pageOffsetParam": "page[offset]", + "resultsPath": "data.attributes.incidents" + }, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_read" + ] + }, + "x-undo": { + "type": "safe" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + } + }, + "/api/v2/incidents/{incident_id}": { + "delete": { + "description": "Deletes an existing incident from the users organization.", + "operationId": "DeleteIncident", + "parameters": [ + { + "description": "The UUID of the incident.", + "in": "path", + "name": "incident_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { "description": "OK" }, "400": { @@ -225468,102 +231933,59 @@ }, { "AuthZ": [ - "incident_settings_write" + "incident_write" ] } ], - "summary": "Update an incident type", + "summary": "Delete an existing incident", "tags": [ "Incidents" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 22, + "x-menu-order": 4, "x-permission": { "operator": "OR", "permissions": [ - "incident_settings_write" + "incident_write" ] }, "x-undo": { "type": "idempotent" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - } - }, - "/api/v2/incidents/search": { + }, "get": { - "description": "Search for incidents matching a certain query.", - "operationId": "SearchIncidents", + "description": "Get the details of an incident by `incident_id`.", + "operationId": "GetIncident", "parameters": [ { - "description": "Specifies which types of related objects should be included in the response.", - "in": "query", - "name": "include", - "required": false, - "schema": { - "description": "Object related to an incident.", - "enum": [ - "users", - "attachments" - ], - "type": "string", - "x-enum-varnames": [ - "USERS", - "ATTACHMENTS" - ] - } - }, - { - "description": "Specifies which incidents should be returned. The query can contain any number of incident facets\njoined by `ANDs`, along with multiple values for each of those facets joined by `OR`s. For\nexample: `state:active AND severity:(SEV-2 OR SEV-1)`.", - "explode": false, - "in": "query", - "name": "query", + "description": "The UUID of the incident.", + "in": "path", + "name": "incident_id", "required": true, "schema": { "type": "string" } }, { - "description": "Specifies the order of returned incidents.", + "description": "Specifies which types of related objects should be included in the response.", "explode": false, "in": "query", - "name": "sort", - "required": false, - "schema": { - "description": "The ways searched incidents can be sorted.", - "enum": [ - "created", - "-created" - ], - "type": "string", - "x-enum-varnames": [ - "CREATED_ASCENDING", - "CREATED_DESCENDING" - ] - } - }, - { - "description": "Size for a given page. The maximum allowed value is 100.", - "in": "query", - "name": "page[size]", - "required": false, - "schema": { - "default": 10, - "example": 10, - "format": "int64", - "type": "integer" - } - }, - { - "description": "Specific offset to use as the beginning of the returned page.", - "in": "query", - "name": "page[offset]", + "name": "include", "required": false, "schema": { - "default": 0, - "example": 0, - "format": "int64", - "type": "integer" + "items": { + "description": "Object related to an incident.", + "enum": [ + "users", + "attachments" + ], + "type": "string", + "x-enum-varnames": [ + "USERS", + "ATTACHMENTS" + ] + }, + "type": "array" } } ], @@ -225572,1056 +231994,631 @@ "content": { "application/json": { "schema": { - "description": "Response with incidents and facets.", + "description": "Response with an incident.", "properties": { "data": { - "description": "Data returned by an incident search.", + "description": "Incident data from a response.", "properties": { "attributes": { - "description": "Attributes returned by an incident search.", + "description": "The incident's attributes from a response.", "properties": { - "facets": { - "description": "Facet data for incidents returned by a search query.", - "properties": { - "commander": { - "description": "Facet data for incident commander users.", - "items": { - "description": "Facet data for user attributes of an incident.", - "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "email": { - "description": "Email of the user.", - "example": "datadog.user@example.com", - "type": "string" - }, - "handle": { - "description": "Handle of the user.", - "example": "@datadog.user@example.com", - "type": "string" - }, - "name": { - "description": "Name of the user.", - "example": "Datadog User", - "type": "string" - }, - "uuid": { - "description": "ID of the user.", - "example": "773b045d-ccf8-4808-bd3b-955ef6a8c940", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "created_by": { - "description": "Facet data for incident creator users.", - "items": { - "description": "Facet data for user attributes of an incident.", + "archived": { + "description": "Timestamp of when the incident was archived.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "case_id": { + "description": "The incident case id.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "created": { + "description": "Timestamp when the incident was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "customer_impact_duration": { + "description": "Length of the incident's customer impact in seconds.\nEquals the difference between `customer_impact_start` and `customer_impact_end`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "customer_impact_end": { + "description": "Timestamp when customers were no longer impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impact_scope": { + "description": "A summary of the impact customers experienced during the incident.", + "example": "An example customer impact scope", + "nullable": true, + "type": "string" + }, + "customer_impact_start": { + "description": "Timestamp when customers began being impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impacted": { + "description": "A flag indicating whether the incident caused customer impact.", + "example": false, + "type": "boolean" + }, + "detected": { + "description": "Timestamp when the incident was detected.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "fields": { + "additionalProperties": { + "description": "Dynamic fields for which selections can be made, with field names as keys.", + "oneOf": [ + { + "description": "A field with a single value selected.", "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "email": { - "description": "Email of the user.", - "example": "datadog.user@example.com", - "type": "string" - }, - "handle": { - "description": "Handle of the user.", - "example": "@datadog.user@example.com", - "type": "string" - }, - "name": { - "description": "Name of the user.", - "example": "Datadog User", - "type": "string" + "type": { + "default": "dropdown", + "description": "Type of the single value field definitions.", + "enum": [ + "dropdown", + "textbox" + ], + "example": "dropdown", + "type": "string", + "x-enum-varnames": [ + "DROPDOWN", + "TEXTBOX" + ] }, - "uuid": { - "description": "ID of the user.", - "example": "773b045d-ccf8-4808-bd3b-955ef6a8c940", + "value": { + "description": "The single value selected for this field.", + "example": "SEV-1", + "nullable": true, "type": "string" } }, "type": "object" }, - "type": "array" - }, - "fields": { - "description": "Facet data for incident property fields.", - "items": { - "description": "Facet data for the incident property fields.", + { + "description": "A field with potentially multiple values selected.", "properties": { - "aggregates": { - "description": "Aggregate information for numeric incident data.", - "properties": { - "max": { - "description": "Maximum value of the numeric aggregates.", - "example": 1234, - "format": "double", - "nullable": true, - "type": "number" - }, - "min": { - "description": "Minimum value of the numeric aggregates.", - "example": 20, - "format": "double", - "nullable": true, - "type": "number" - } - }, - "type": "object" + "type": { + "default": "multiselect", + "description": "Type of the multiple value field definitions.", + "enum": [ + "multiselect", + "textarray", + "metrictag", + "autocomplete" + ], + "example": "multiselect", + "type": "string", + "x-enum-varnames": [ + "MULTISELECT", + "TEXTARRAY", + "METRICTAG", + "AUTOCOMPLETE" + ] }, - "facets": { - "description": "Facet data for the property field of an incident.", + "value": { + "description": "The multiple values selected for this field.", + "example": [ + "1.0", + "1.1" + ], "items": { - "description": "Facet value and number of occurrences for a property field of an incident.", - "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "name": { - "description": "The facet value appearing in search results.", - "example": "SEV-2", - "type": "string" - } - }, - "type": "object" + "description": "A value which has been selected for the parent field.", + "example": "1.1", + "type": "string" }, + "nullable": true, "type": "array" - }, - "name": { - "description": "Name of the incident property field.", - "example": "Severity", - "type": "string" } }, - "required": [ - "facets", - "name" - ], "type": "object" - }, - "type": "array" + } + ] + }, + "description": "A condensed view of the user-defined fields attached to incidents.", + "example": { + "severity": { + "type": "dropdown", + "value": "SEV-5" + } + }, + "type": "object" + }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "modified": { + "description": "Timestamp when the incident was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "non_datadog_creator": { + "description": "Incident's non Datadog creator.", + "nullable": true, + "properties": { + "image_48_px": { + "description": "Non Datadog creator `48px` image.", + "type": "string" }, - "impact": { - "description": "Facet data for incident impact attributes.", - "items": { - "description": "Facet value and number of occurrences for a property field of an incident.", - "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "name": { - "description": "The facet value appearing in search results.", - "example": "SEV-2", - "type": "string" - } - }, - "type": "object" + "name": { + "description": "Non Datadog creator name.", + "type": "string" + } + }, + "type": "object" + }, + "notification_handles": { + "description": "Notification handles that will be notified of the incident during update.", + "example": [ + { + "display_name": "Jane Doe", + "handle": "@user@email.com" + }, + { + "display_name": "Slack Channel", + "handle": "@slack-channel" + }, + { + "display_name": "Incident Workflow", + "handle": "@workflow-from-incident" + } + ], + "items": { + "description": "A notification handle that will be notified at incident creation.", + "properties": { + "display_name": { + "description": "The name of the notified handle.", + "example": "Jane Doe", + "type": "string" }, - "type": "array" + "handle": { + "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", + "example": "@test.user@test.com", + "type": "string" + } }, - "last_modified_by": { - "description": "Facet data for incident last modified by users.", + "type": "object" + }, + "nullable": true, + "type": "array" + }, + "public_id": { + "description": "The monotonically increasing integer ID for the incident.", + "example": 1, + "format": "int64", + "type": "integer" + }, + "resolved": { + "description": "Timestamp when the incident's state was last changed from active or stable to resolved or completed.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "severity": { + "description": "The incident severity.", + "enum": [ + "UNKNOWN", + "SEV-1", + "SEV-2", + "SEV-3", + "SEV-4", + "SEV-5" + ], + "example": "UNKNOWN", + "type": "string", + "x-enum-varnames": [ + "UNKNOWN", + "SEV_1", + "SEV_2", + "SEV_3", + "SEV_4", + "SEV_5" + ] + }, + "state": { + "description": "The state incident.", + "nullable": true, + "type": "string" + }, + "time_to_detect": { + "description": "The amount of time in seconds to detect the incident.\nEquals the difference between `customer_impact_start` and `detected`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_internal_response": { + "description": "The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_repair": { + "description": "The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_resolve": { + "description": "The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "title": { + "description": "The title of the incident, which summarizes what happened.", + "example": "A test incident title", + "type": "string" + }, + "visibility": { + "description": "The incident visibility status.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "title" + ], + "type": "object" + }, + "id": { + "description": "The incident's ID.", + "example": "00000000-0000-0000-1234-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident's relationships from a response.", + "properties": { + "attachments": { + "description": "A relationship reference for attachments.", + "properties": { + "data": { + "description": "An array of incident attachments.", "items": { - "description": "Facet data for user attributes of an incident.", + "description": "The attachment relationship data.", "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "email": { - "description": "Email of the user.", - "example": "datadog.user@example.com", - "type": "string" - }, - "handle": { - "description": "Handle of the user.", - "example": "@datadog.user@example.com", - "type": "string" - }, - "name": { - "description": "Name of the user.", - "example": "Datadog User", + "id": { + "description": "A unique identifier that represents the attachment.", + "example": "00000000-0000-abcd-1000-000000000000", "type": "string" }, - "uuid": { - "description": "ID of the user.", - "example": "773b045d-ccf8-4808-bd3b-955ef6a8c940", - "type": "string" + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] } }, - "type": "object" + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } }, "type": "array" - }, - "postmortem": { - "description": "Facet data for incident postmortem existence.", - "items": { - "description": "Facet value and number of occurrences for a property field of an incident.", - "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "name": { - "description": "The facet value appearing in search results.", - "example": "SEV-2", - "type": "string" - } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "commander_user": { + "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": "object" + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } }, - "type": "array" - }, - "responder": { - "description": "Facet data for incident responder users.", - "items": { - "description": "Facet data for user attributes of an incident.", - "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "email": { - "description": "Email of the user.", - "example": "datadog.user@example.com", - "type": "string" - }, - "handle": { - "description": "Handle of the user.", - "example": "@datadog.user@example.com", - "type": "string" - }, - "name": { - "description": "Name of the user.", - "example": "Datadog User", - "type": "string" - }, - "uuid": { - "description": "ID of the user.", - "example": "773b045d-ccf8-4808-bd3b-955ef6a8c940", - "type": "string" - } + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" }, - "type": "object" + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } }, - "type": "array" - }, - "severity": { - "description": "Facet data for incident severity attributes.", + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "impacts": { + "description": "Relationship to impacts.", + "properties": { + "data": { + "description": "An array of incident impacts.", "items": { - "description": "Facet value and number of occurrences for a property field of an incident.", + "description": "Relationship to impact object.", "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "name": { - "description": "The facet value appearing in search results.", - "example": "SEV-2", + "id": { + "description": "A unique identifier that represents the impact.", + "example": "00000000-0000-0000-2345-000000000000", "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "state": { - "description": "Facet data for incident state attributes.", - "items": { - "description": "Facet value and number of occurrences for a property field of an incident.", - "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" }, - "name": { - "description": "The facet value appearing in search results.", - "example": "SEV-2", - "type": "string" + "type": { + "description": "The incident impacts type.", + "enum": [ + "incident_impacts" + ], + "example": "incident_impacts", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_IMPACTS" + ] } }, - "type": "object" + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } }, "type": "array" - }, - "time_to_repair": { - "description": "Facet data for incident time to repair metrics.", + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "integrations": { + "description": "A relationship reference for multiple integration metadata objects.", + "example": { + "data": [ + { + "id": "00000000-abcd-0005-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0006-0000-000000000000", + "type": "incident_integrations" + } + ] + }, + "properties": { + "data": { + "description": "Integration metadata relationship array", + "example": [ + { + "id": "00000000-abcd-0003-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0004-0000-000000000000", + "type": "incident_integrations" + } + ], "items": { - "description": "Facet data numeric attributes of an incident.", + "description": "A relationship reference for an integration metadata object.", + "example": { + "id": "00000000-abcd-0002-0000-000000000000", + "type": "incident_integrations" + }, "properties": { - "aggregates": { - "description": "Aggregate information for numeric incident data.", - "properties": { - "max": { - "description": "Maximum value of the numeric aggregates.", - "example": 1234, - "format": "double", - "nullable": true, - "type": "number" - }, - "min": { - "description": "Minimum value of the numeric aggregates.", - "example": 20, - "format": "double", - "nullable": true, - "type": "number" - } - }, - "type": "object" - }, - "name": { - "description": "Name of the incident property field.", - "example": "time_to_repair", + "id": { + "description": "A unique identifier that represents the integration metadata.", + "example": "00000000-abcd-0001-0000-000000000000", "type": "string" + }, + "type": { + "default": "incident_integrations", + "description": "Integration metadata resource type.", + "enum": [ + "incident_integrations" + ], + "example": "incident_integrations", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_INTEGRATIONS" + ] } }, "required": [ - "name", - "aggregates" + "id", + "type" ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } }, "type": "array" - }, - "time_to_resolve": { - "description": "Facet data for incident time to resolve metrics.", + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "responders": { + "description": "Relationship to incident responders.", + "properties": { + "data": { + "description": "An array of incident responders.", "items": { - "description": "Facet data numeric attributes of an incident.", + "description": "Relationship to impact object.", "properties": { - "aggregates": { - "description": "Aggregate information for numeric incident data.", - "properties": { - "max": { - "description": "Maximum value of the numeric aggregates.", - "example": 1234, - "format": "double", - "nullable": true, - "type": "number" - }, - "min": { - "description": "Minimum value of the numeric aggregates.", - "example": 20, - "format": "double", - "nullable": true, - "type": "number" - } - }, - "type": "object" - }, - "name": { - "description": "Name of the incident property field.", - "example": "time_to_repair", + "id": { + "description": "A unique identifier that represents the responder.", + "example": "00000000-0000-0000-2345-000000000000", "type": "string" + }, + "type": { + "description": "The incident responders type.", + "enum": [ + "incident_responders" + ], + "example": "incident_responders", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_RESPONDERS" + ] } }, "required": [ - "name", - "aggregates" + "id", + "type" ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } }, "type": "array" } }, + "required": [ + "data" + ], "type": "object" }, - "incidents": { - "description": "Incidents returned by the search.", - "items": { - "description": "Incident returned by the search.", - "properties": { - "data": { - "description": "Incident data from a response.", + "user_defined_fields": { + "description": "Relationship to incident user defined fields.", + "properties": { + "data": { + "description": "An array of user defined fields.", + "items": { + "description": "Relationship to impact object.", "properties": { - "attributes": { - "description": "The incident's attributes from a response.", - "properties": { - "archived": { - "description": "Timestamp of when the incident was archived.", - "format": "date-time", - "nullable": true, - "readOnly": true, - "type": "string" - }, - "case_id": { - "description": "The incident case id.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "created": { - "description": "Timestamp when the incident was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "customer_impact_duration": { - "description": "Length of the incident's customer impact in seconds.\nEquals the difference between `customer_impact_start` and `customer_impact_end`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "customer_impact_end": { - "description": "Timestamp when customers were no longer impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impact_scope": { - "description": "A summary of the impact customers experienced during the incident.", - "example": "An example customer impact scope", - "nullable": true, - "type": "string" - }, - "customer_impact_start": { - "description": "Timestamp when customers began being impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impacted": { - "description": "A flag indicating whether the incident caused customer impact.", - "example": false, - "type": "boolean" - }, - "detected": { - "description": "Timestamp when the incident was detected.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "fields": { - "additionalProperties": { - "description": "Dynamic fields for which selections can be made, with field names as keys.", - "oneOf": [ - { - "description": "A field with a single value selected.", - "properties": { - "type": { - "default": "dropdown", - "description": "Type of the single value field definitions.", - "enum": [ - "dropdown", - "textbox" - ], - "example": "dropdown", - "type": "string", - "x-enum-varnames": [ - "DROPDOWN", - "TEXTBOX" - ] - }, - "value": { - "description": "The single value selected for this field.", - "example": "SEV-1", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - { - "description": "A field with potentially multiple values selected.", - "properties": { - "type": { - "default": "multiselect", - "description": "Type of the multiple value field definitions.", - "enum": [ - "multiselect", - "textarray", - "metrictag", - "autocomplete" - ], - "example": "multiselect", - "type": "string", - "x-enum-varnames": [ - "MULTISELECT", - "TEXTARRAY", - "METRICTAG", - "AUTOCOMPLETE" - ] - }, - "value": { - "description": "The multiple values selected for this field.", - "example": [ - "1.0", - "1.1" - ], - "items": { - "description": "A value which has been selected for the parent field.", - "example": "1.1", - "type": "string" - }, - "nullable": true, - "type": "array" - } - }, - "type": "object" - } - ] - }, - "description": "A condensed view of the user-defined fields attached to incidents.", - "example": { - "severity": { - "type": "dropdown", - "value": "SEV-5" - } - }, - "type": "object" - }, - "incident_type_uuid": { - "description": "A unique identifier that represents an incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "type": "string" - }, - "modified": { - "description": "Timestamp when the incident was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "non_datadog_creator": { - "description": "Incident's non Datadog creator.", - "nullable": true, - "properties": { - "image_48_px": { - "description": "Non Datadog creator `48px` image.", - "type": "string" - }, - "name": { - "description": "Non Datadog creator name.", - "type": "string" - } - }, - "type": "object" - }, - "notification_handles": { - "description": "Notification handles that will be notified of the incident during update.", - "example": [ - { - "display_name": "Jane Doe", - "handle": "@user@email.com" - }, - { - "display_name": "Slack Channel", - "handle": "@slack-channel" - }, - { - "display_name": "Incident Workflow", - "handle": "@workflow-from-incident" - } - ], - "items": { - "description": "A notification handle that will be notified at incident creation.", - "properties": { - "display_name": { - "description": "The name of the notified handle.", - "example": "Jane Doe", - "type": "string" - }, - "handle": { - "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", - "example": "@test.user@test.com", - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "public_id": { - "description": "The monotonically increasing integer ID for the incident.", - "example": 1, - "format": "int64", - "type": "integer" - }, - "resolved": { - "description": "Timestamp when the incident's state was last changed from active or stable to resolved or completed.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "severity": { - "description": "The incident severity.", - "enum": [ - "UNKNOWN", - "SEV-1", - "SEV-2", - "SEV-3", - "SEV-4", - "SEV-5" - ], - "example": "UNKNOWN", - "type": "string", - "x-enum-varnames": [ - "UNKNOWN", - "SEV_1", - "SEV_2", - "SEV_3", - "SEV_4", - "SEV_5" - ] - }, - "state": { - "description": "The state incident.", - "nullable": true, - "type": "string" - }, - "time_to_detect": { - "description": "The amount of time in seconds to detect the incident.\nEquals the difference between `customer_impact_start` and `detected`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_internal_response": { - "description": "The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_repair": { - "description": "The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_resolve": { - "description": "The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "title": { - "description": "The title of the incident, which summarizes what happened.", - "example": "A test incident title", - "type": "string" - }, - "visibility": { - "description": "The incident visibility status.", - "nullable": true, - "type": "string" - } - }, - "required": [ - "title" - ], - "type": "object" - }, "id": { - "description": "The incident's ID.", - "example": "00000000-0000-0000-1234-000000000000", + "description": "A unique identifier that represents the responder.", + "example": "00000000-0000-0000-2345-000000000000", "type": "string" }, - "relationships": { - "description": "The incident's relationships from a response.", - "properties": { - "attachments": { - "description": "A relationship reference for attachments.", - "properties": { - "data": { - "description": "An array of incident attachments.", - "items": { - "description": "The attachment relationship data.", - "properties": { - "id": { - "description": "A unique identifier that represents the attachment.", - "example": "00000000-0000-abcd-1000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", - "enum": [ - "incident_attachments" - ], - "example": "incident_attachments", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "commander_user": { - "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": "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "created_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "impacts": { - "description": "Relationship to impacts.", - "properties": { - "data": { - "description": "An array of incident impacts.", - "items": { - "description": "Relationship to impact object.", - "properties": { - "id": { - "description": "A unique identifier that represents the impact.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "description": "The incident impacts type.", - "enum": [ - "incident_impacts" - ], - "example": "incident_impacts", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_IMPACTS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "integrations": { - "description": "A relationship reference for multiple integration metadata objects.", - "example": { - "data": [ - { - "id": "00000000-abcd-0005-0000-000000000000", - "type": "incident_integrations" - }, - { - "id": "00000000-abcd-0006-0000-000000000000", - "type": "incident_integrations" - } - ] - }, - "properties": { - "data": { - "description": "Integration metadata relationship array", - "example": [ - { - "id": "00000000-abcd-0003-0000-000000000000", - "type": "incident_integrations" - }, - { - "id": "00000000-abcd-0004-0000-000000000000", - "type": "incident_integrations" - } - ], - "items": { - "description": "A relationship reference for an integration metadata object.", - "example": { - "id": "00000000-abcd-0002-0000-000000000000", - "type": "incident_integrations" - }, - "properties": { - "id": { - "description": "A unique identifier that represents the integration metadata.", - "example": "00000000-abcd-0001-0000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", - "enum": [ - "incident_integrations" - ], - "example": "incident_integrations", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "responders": { - "description": "Relationship to incident responders.", - "properties": { - "data": { - "description": "An array of incident responders.", - "items": { - "description": "Relationship to impact object.", - "properties": { - "id": { - "description": "A unique identifier that represents the responder.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "description": "The incident responders type.", - "enum": [ - "incident_responders" - ], - "example": "incident_responders", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_RESPONDERS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "user_defined_fields": { - "description": "Relationship to incident user defined fields.", - "properties": { - "data": { - "description": "An array of user defined fields.", - "items": { - "description": "Relationship to impact object.", - "properties": { - "id": { - "description": "A unique identifier that represents the responder.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "description": "The incident user defined fields type.", - "enum": [ - "user_defined_field" - ], - "example": "user_defined_field", - "type": "string", - "x-enum-varnames": [ - "USER_DEFINED_FIELD" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, "type": { - "default": "incidents", - "description": "Incident resource type.", + "description": "The incident user defined fields type.", "enum": [ - "incidents" + "user_defined_field" ], - "example": "incidents", + "example": "user_defined_field", "type": "string", "x-enum-varnames": [ - "INCIDENTS" + "USER_DEFINED_FIELD" ] } }, @@ -226633,44 +232630,39 @@ "x-merge-override": { "required": false } - } - }, - "required": [ - "data" - ], - "type": "object" + }, + "type": "array" + } }, - "type": "array" - }, - "total": { - "description": "Number of incidents returned by the search.", - "example": 10, - "format": "int32", - "maximum": 2147483647, - "type": "integer" + "required": [ + "data" + ], + "type": "object" } }, - "required": [ - "facets", - "incidents", - "total" - ], "type": "object" }, "type": { - "default": "incidents_search_results", - "description": "Incident search result type.", + "default": "incidents", + "description": "Incident resource type.", "enum": [ - "incidents_search_results" + "incidents" ], - "example": "incidents_search_results", + "example": "incidents", "type": "string", "x-enum-varnames": [ - "INCIDENTS_SEARCH_RESULTS" + "INCIDENTS" ] } }, - "type": "object" + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } }, "included": { "description": "Included related resources that the user requested.", @@ -226918,37 +232910,6 @@ }, "readOnly": true, "type": "array" - }, - "meta": { - "description": "The metadata object containing pagination metadata.", - "properties": { - "pagination": { - "description": "Pagination properties.", - "properties": { - "next_offset": { - "description": "The index of the first element in the next page of results. Equal to page size added to the current offset.", - "example": 1000, - "format": "int64", - "type": "integer" - }, - "offset": { - "description": "The index of the first element in the results.", - "example": 10, - "format": "int64", - "type": "integer" - }, - "size": { - "description": "Maximum size of pages to return.", - "example": 1000, - "format": "int64", - "type": "integer" - } - }, - "type": "object" - } - }, - "readOnly": true, - "type": "object" } }, "required": [ @@ -227112,16 +233073,11 @@ ] } ], - "summary": "Search for incidents", + "summary": "Get the details of an incident", "tags": [ "Incidents" ], - "x-menu-order": 6, - "x-pagination": { - "limitParam": "page[size]", - "pageOffsetParam": "page[offset]", - "resultsPath": "data.attributes.incidents" - }, + "x-menu-order": 2, "x-permission": { "operator": "OR", "permissions": [ @@ -227132,12 +233088,10 @@ "type": "safe" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - } - }, - "/api/v2/incidents/{incident_id}": { - "delete": { - "description": "Deletes an existing incident from the users organization.", - "operationId": "DeleteIncident", + }, + "patch": { + "description": "Updates an incident. Provide only the attributes that should be updated as this request is a partial update.", + "operationId": "UpdateIncident", "parameters": [ { "description": "The UUID of the incident.", @@ -227147,216 +233101,388 @@ "schema": { "type": "string" } + }, + { + "description": "Specifies which types of related objects should be included in the response.", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "description": "Object related to an incident.", + "enum": [ + "users", + "attachments" + ], + "type": "string", + "x-enum-varnames": [ + "USERS", + "ATTACHMENTS" + ] + }, + "type": "array" + } } ], - "responses": { - "204": { - "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" + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Update request for an incident.", + "properties": { + "data": { + "description": "Incident data for an update request.", + "properties": { + "attributes": { + "description": "The incident's attributes for an update request.", + "properties": { + "customer_impact_end": { + "description": "Timestamp when customers were no longer impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impact_scope": { + "description": "A summary of the impact customers experienced during the incident.", + "example": "Example customer impact scope", + "type": "string" + }, + "customer_impact_start": { + "description": "Timestamp when customers began being impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impacted": { + "description": "A flag indicating whether the incident caused customer impact.", + "example": false, + "type": "boolean" + }, + "detected": { + "description": "Timestamp when the incident was detected.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "fields": { + "additionalProperties": { + "description": "Dynamic fields for which selections can be made, with field names as keys.", + "oneOf": [ + { + "description": "A field with a single value selected.", + "properties": { + "type": { + "default": "dropdown", + "description": "Type of the single value field definitions.", + "enum": [ + "dropdown", + "textbox" + ], + "example": "dropdown", + "type": "string", + "x-enum-varnames": [ + "DROPDOWN", + "TEXTBOX" + ] + }, + "value": { + "description": "The single value selected for this field.", + "example": "SEV-1", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + { + "description": "A field with potentially multiple values selected.", + "properties": { + "type": { + "default": "multiselect", + "description": "Type of the multiple value field definitions.", + "enum": [ + "multiselect", + "textarray", + "metrictag", + "autocomplete" + ], + "example": "multiselect", + "type": "string", + "x-enum-varnames": [ + "MULTISELECT", + "TEXTARRAY", + "METRICTAG", + "AUTOCOMPLETE" + ] + }, + "value": { + "description": "The multiple values selected for this field.", + "example": [ + "1.0", + "1.1" + ], + "items": { + "description": "A value which has been selected for the parent field.", + "example": "1.1", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "description": "A condensed view of the user-defined fields for which to update selections.", + "example": { + "severity": { + "type": "dropdown", + "value": "SEV-5" + } + }, + "type": "object" + }, + "notification_handles": { + "description": "Notification handles that will be notified of the incident during update.", + "example": [ + { + "display_name": "Jane Doe", + "handle": "@user@email.com" + }, + { + "display_name": "Slack Channel", + "handle": "@slack-channel" + }, + { + "display_name": "Incident Workflow", + "handle": "@workflow-from-incident" + } + ], + "items": { + "description": "A notification handle that will be notified at incident creation.", + "properties": { + "display_name": { + "description": "The name of the notified handle.", + "example": "Jane Doe", + "type": "string" + }, + "handle": { + "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", + "example": "@test.user@test.com", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "title": { + "description": "The title of the incident, which summarizes what happened.", + "example": "A test incident title", + "type": "string" + } + }, + "type": "object" }, - "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", + "id": { + "description": "The incident's ID.", + "example": "00000000-0000-0000-4567-000000000000", "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" + "relationships": { + "description": "The incident's relationships for an update request.", + "properties": { + "commander_user": { + "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": "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "integrations": { + "description": "A relationship reference for multiple integration metadata objects.", + "example": { + "data": [ + { + "id": "00000000-abcd-0005-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0006-0000-000000000000", + "type": "incident_integrations" + } + ] + }, + "properties": { + "data": { + "description": "Integration metadata relationship array", + "example": [ + { + "id": "00000000-abcd-0003-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0004-0000-000000000000", + "type": "incident_integrations" + } + ], + "items": { + "description": "A relationship reference for an integration metadata object.", + "example": { + "id": "00000000-abcd-0002-0000-000000000000", + "type": "incident_integrations" + }, + "properties": { + "id": { + "description": "A unique identifier that represents the integration metadata.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_integrations", + "description": "Integration metadata resource type.", + "enum": [ + "incident_integrations" + ], + "example": "incident_integrations", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_INTEGRATIONS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "postmortem": { + "description": "A relationship reference for postmortems.", + "example": { + "data": { + "id": "00000000-0000-abcd-3000-000000000000", + "type": "incident_postmortems" + } + }, + "properties": { + "data": { + "description": "The postmortem relationship data.", + "example": { + "id": "00000000-0000-abcd-2000-000000000000", + "type": "incident_postmortems" + }, + "properties": { + "id": { + "description": "A unique identifier that represents the postmortem.", + "example": "00000000-0000-abcd-1000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_postmortems", + "description": "Incident postmortem resource type.", + "enum": [ + "incident_postmortems" + ], + "example": "incident_postmortems", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_POSTMORTEMS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" }, - "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - } + "type": { + "default": "incidents", + "description": "Incident resource type.", + "enum": [ + "incidents" + ], + "example": "incidents", + "type": "string", + "x-enum-varnames": [ + "INCIDENTS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" } - }, - "description": "Too many requests" - } - }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "incident_write" - ] - } - ], - "summary": "Delete an existing incident", - "tags": [ - "Incidents" - ], - "x-menu-order": 4, - "x-permission": { - "operator": "OR", - "permissions": [ - "incident_write" - ] - }, - "x-undo": { - "type": "idempotent" - }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - }, - "get": { - "description": "Get the details of an incident by `incident_id`.", - "operationId": "GetIncident", - "parameters": [ - { - "description": "The UUID of the incident.", - "in": "path", - "name": "incident_id", - "required": true, - "schema": { - "type": "string" } }, - { - "description": "Specifies which types of related objects should be included in the response.", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "description": "Object related to an incident.", - "enum": [ - "users", - "attachments" - ], - "type": "string", - "x-enum-varnames": [ - "USERS", - "ATTACHMENTS" - ] - }, - "type": "array" - } - } - ], + "description": "Incident Payload.", + "required": true + }, "responses": { "200": { "content": { @@ -228094,189 +234220,912 @@ "documentUrl": "", "title": "Postmortem IR-123" }, - "attachment_type": "postmortem" + "attachment_type": "postmortem" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + }, + "properties": { + "attributes": { + "description": "The attributes object for an attachment.", + "oneOf": [ + { + "description": "The attributes object for a postmortem attachment.", + "properties": { + "attachment": { + "description": "The postmortem attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this notebook attachment.", + "example": "https://app.datadoghq.com/notebook/123", + "type": "string" + }, + "title": { + "description": "The title of this postmortem attachment.", + "example": "Postmortem IR-123", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" + }, + "attachment_type": { + "default": "postmortem", + "description": "The type of postmortem attachment attributes.", + "enum": [ + "postmortem" + ], + "example": "postmortem", + "type": "string", + "x-enum-varnames": [ + "POSTMORTEM" + ] + } + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + }, + { + "description": "The attributes object for a link attachment.", + "properties": { + "attachment": { + "description": "The link attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this link attachment.", + "example": "https://www.example.com/webstore-failure-runbook", + "type": "string" + }, + "title": { + "description": "The title of this link attachment.", + "example": "Runbook for webstore service failures", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" + }, + "attachment_type": { + "default": "link", + "description": "The type of link attachment attributes.", + "enum": [ + "link" + ], + "example": "link", + "type": "string", + "x-enum-varnames": [ + "LINK" + ] + }, + "modified": { + "description": "Timestamp when the incident attachment link was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + } + ] + }, + "id": { + "description": "A unique identifier that represents the incident attachment.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident attachment's relationships.", + "properties": { + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] + } + }, + "required": [ + "type", + "attributes", + "id", + "relationships" + ], + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "data" + ], + "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": [ + "incident_write" + ] + } + ], + "summary": "Update an existing incident", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 3, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_write" + ] + }, + "x-undo": { + "type": "idempotent" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "x-merge-override": { + "delete": true + } + }, + "/api/v2/incidents/{incident_id}/attachments": { + "get": { + "description": "Get all attachments for a given incident.", + "operationId": "ListIncidentAttachments", + "parameters": [ + { + "description": "The UUID of the incident.", + "in": "path", + "name": "incident_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Specifies which types of related objects are included in the response.", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "description": "The object related to an incident attachment.", + "enum": [ + "users" + ], + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + }, + "type": "array" + } + }, + { + "description": "Specifies which types of attachments are included in the response.", + "explode": false, + "in": "query", + "name": "filter[attachment_type]", + "required": false, + "schema": { + "items": { + "description": "The type of the incident attachment attributes.", + "enum": [ + "link", + "postmortem" + ], + "example": "link", + "type": "string", + "x-enum-varnames": [ + "LINK", + "POSTMORTEM" + ] + }, + "type": "array" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The response object containing an incident's attachments.", + "properties": { + "data": { + "description": "An array of incident attachments.", + "example": [ + { + "attributes": { + "attachment": { + "documentUrl": "", + "title": "Postmortem IR-123" + }, + "attachment_type": "postmortem" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + } + ], + "items": { + "description": "A single incident attachment.", + "example": { + "attributes": { + "attachment": { + "documentUrl": "", + "title": "Postmortem IR-123" + }, + "attachment_type": "postmortem" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + }, + "properties": { + "attributes": { + "description": "The attributes object for an attachment.", + "oneOf": [ + { + "description": "The attributes object for a postmortem attachment.", + "properties": { + "attachment": { + "description": "The postmortem attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this notebook attachment.", + "example": "https://app.datadoghq.com/notebook/123", + "type": "string" + }, + "title": { + "description": "The title of this postmortem attachment.", + "example": "Postmortem IR-123", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" + }, + "attachment_type": { + "default": "postmortem", + "description": "The type of postmortem attachment attributes.", + "enum": [ + "postmortem" + ], + "example": "postmortem", + "type": "string", + "x-enum-varnames": [ + "POSTMORTEM" + ] + } + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + }, + { + "description": "The attributes object for a link attachment.", + "properties": { + "attachment": { + "description": "The link attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this link attachment.", + "example": "https://www.example.com/webstore-failure-runbook", + "type": "string" + }, + "title": { + "description": "The title of this link attachment.", + "example": "Runbook for webstore service failures", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" + }, + "attachment_type": { + "default": "link", + "description": "The type of link attachment attributes.", + "enum": [ + "link" + ], + "example": "link", + "type": "string", + "x-enum-varnames": [ + "LINK" + ] + }, + "modified": { + "description": "Timestamp when the incident attachment link was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + } + ] + }, + "id": { + "description": "A unique identifier that represents the incident attachment.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident attachment's relationships.", + "properties": { + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] + } + }, + "required": [ + "type", + "attributes", + "id", + "relationships" + ], + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Included related resources that the user requested.", + "items": { + "description": "An object related to an attachment that is included in the response.", + "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": "00000000-abcd-0002-0000-000000000000", - "relationships": { - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - } + "id": { + "description": "ID of the user.", + "type": "string" }, - "type": "incident_attachments" - }, - "properties": { - "attributes": { - "description": "The attributes object for an attachment.", - "oneOf": [ - { - "description": "The attributes object for a postmortem attachment.", + "relationships": { + "description": "Relationships of the user object returned by the API.", + "properties": { + "org": { + "description": "Relationship to an organization.", "properties": { - "attachment": { - "description": "The postmortem attachment.", + "data": { + "description": "Relationship to organization object.", "properties": { - "documentUrl": { - "description": "The URL of this notebook attachment.", - "example": "https://app.datadoghq.com/notebook/123", + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", "type": "string" }, - "title": { - "description": "The title of this postmortem attachment.", - "example": "Postmortem IR-123", - "type": "string" + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] } }, "required": [ - "documentUrl", - "title" + "id", + "type" ], "type": "object" - }, - "attachment_type": { - "default": "postmortem", - "description": "The type of postmortem attachment attributes.", - "enum": [ - "postmortem" - ], - "example": "postmortem", - "type": "string", - "x-enum-varnames": [ - "POSTMORTEM" - ] } }, "required": [ - "attachment_type", - "attachment" + "data" ], "type": "object" }, - { - "description": "The attributes object for a link attachment.", + "other_orgs": { + "description": "Relationship to organizations.", "properties": { - "attachment": { - "description": "The link attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this link attachment.", - "example": "https://www.example.com/webstore-failure-runbook", - "type": "string" + "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" + ] + } }, - "title": { - "description": "The title of this link attachment.", - "example": "Runbook for webstore service failures", - "type": "string" - } + "required": [ + "id", + "type" + ], + "type": "object" }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" - }, - "attachment_type": { - "default": "link", - "description": "The type of link attachment attributes.", - "enum": [ - "link" - ], - "example": "link", - "type": "string", - "x-enum-varnames": [ - "LINK" - ] - }, - "modified": { - "description": "Timestamp when the incident attachment link was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" + "type": "array" } }, "required": [ - "attachment_type", - "attachment" + "data" ], "type": "object" - } - ] - }, - "id": { - "description": "A unique identifier that represents the incident attachment.", - "example": "00000000-abcd-0001-0000-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident attachment's relationships.", - "properties": { - "last_modified_by_user": { - "description": "Relationship to user.", + }, + "other_users": { + "description": "Relationship to users.", "properties": { "data": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + "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" + ] + } }, - "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 } }, - "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" + "type": "object", + "x-merge-override": { + "properties": false + } }, "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", + "default": "users", + "description": "Users resource type.", "enum": [ - "incident_attachments" + "users" ], - "example": "incident_attachments", + "example": "users", "type": "string", "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" + "USERS" ] } }, - "required": [ - "type", - "attributes", - "id", - "relationships" - ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } } ] }, - "readOnly": true, "type": "array" } }, @@ -228430,22 +235279,11 @@ "description": "Too many requests" } }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "incident_read" - ] - } - ], - "summary": "Get the details of an incident", + "summary": "Get a list of attachments", "tags": [ "Incidents" ], - "x-menu-order": 2, + "x-menu-order": 7, "x-permission": { "operator": "OR", "permissions": [ @@ -228458,8 +235296,8 @@ "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." }, "patch": { - "description": "Updates an incident. Provide only the attributes that should be updated as this request is a partial update.", - "operationId": "UpdateIncident", + "description": "The bulk update endpoint for creating, updating, and deleting attachments for a given incident.", + "operationId": "UpdateIncidentAttachments", "parameters": [ { "description": "The UUID of the incident.", @@ -228471,22 +235309,20 @@ } }, { - "description": "Specifies which types of related objects should be included in the response.", + "description": "Specifies which types of related objects are included in the response.", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { - "description": "Object related to an incident.", + "description": "The object related to an incident attachment.", "enum": [ - "users", - "attachments" + "users" ], "type": "string", "x-enum-varnames": [ - "USERS", - "ATTACHMENTS" + "USERS" ] }, "type": "array" @@ -228497,948 +235333,347 @@ "content": { "application/json": { "schema": { - "description": "Update request for an incident.", + "description": "The update request for an incident's attachments.", "properties": { "data": { - "description": "Incident data for an update request.", - "properties": { - "attributes": { - "description": "The incident's attributes for an update request.", - "properties": { - "customer_impact_end": { - "description": "Timestamp when customers were no longer impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impact_scope": { - "description": "A summary of the impact customers experienced during the incident.", - "example": "Example customer impact scope", - "type": "string" - }, - "customer_impact_start": { - "description": "Timestamp when customers began being impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impacted": { - "description": "A flag indicating whether the incident caused customer impact.", - "example": false, - "type": "boolean" - }, - "detected": { - "description": "Timestamp when the incident was detected.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "fields": { - "additionalProperties": { - "description": "Dynamic fields for which selections can be made, with field names as keys.", - "oneOf": [ - { - "description": "A field with a single value selected.", - "properties": { - "type": { - "default": "dropdown", - "description": "Type of the single value field definitions.", - "enum": [ - "dropdown", - "textbox" - ], - "example": "dropdown", - "type": "string", - "x-enum-varnames": [ - "DROPDOWN", - "TEXTBOX" - ] - }, - "value": { - "description": "The single value selected for this field.", - "example": "SEV-1", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - { - "description": "A field with potentially multiple values selected.", - "properties": { - "type": { - "default": "multiselect", - "description": "Type of the multiple value field definitions.", - "enum": [ - "multiselect", - "textarray", - "metrictag", - "autocomplete" - ], - "example": "multiselect", - "type": "string", - "x-enum-varnames": [ - "MULTISELECT", - "TEXTARRAY", - "METRICTAG", - "AUTOCOMPLETE" - ] - }, - "value": { - "description": "The multiple values selected for this field.", - "example": [ - "1.0", - "1.1" - ], - "items": { - "description": "A value which has been selected for the parent field.", - "example": "1.1", - "type": "string" - }, - "nullable": true, - "type": "array" - } - }, - "type": "object" - } - ] - }, - "description": "A condensed view of the user-defined fields for which to update selections.", - "example": { - "severity": { - "type": "dropdown", - "value": "SEV-5" - } - }, - "type": "object" - }, - "notification_handles": { - "description": "Notification handles that will be notified of the incident during update.", - "example": [ - { - "display_name": "Jane Doe", - "handle": "@user@email.com" - }, - { - "display_name": "Slack Channel", - "handle": "@slack-channel" - }, - { - "display_name": "Incident Workflow", - "handle": "@workflow-from-incident" - } - ], - "items": { - "description": "A notification handle that will be notified at incident creation.", - "properties": { - "display_name": { - "description": "The name of the notified handle.", - "example": "Jane Doe", - "type": "string" - }, - "handle": { - "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", - "example": "@test.user@test.com", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "title": { - "description": "The title of the incident, which summarizes what happened.", - "example": "A test incident title", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "The incident's ID.", - "example": "00000000-0000-0000-4567-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident's relationships for an update request.", - "properties": { - "commander_user": { - "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": "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "integrations": { - "description": "A relationship reference for multiple integration metadata objects.", - "example": { - "data": [ - { - "id": "00000000-abcd-0005-0000-000000000000", - "type": "incident_integrations" - }, - { - "id": "00000000-abcd-0006-0000-000000000000", - "type": "incident_integrations" - } - ] - }, - "properties": { - "data": { - "description": "Integration metadata relationship array", - "example": [ - { - "id": "00000000-abcd-0003-0000-000000000000", - "type": "incident_integrations" - }, - { - "id": "00000000-abcd-0004-0000-000000000000", - "type": "incident_integrations" - } - ], - "items": { - "description": "A relationship reference for an integration metadata object.", - "example": { - "id": "00000000-abcd-0002-0000-000000000000", - "type": "incident_integrations" - }, - "properties": { - "id": { - "description": "A unique identifier that represents the integration metadata.", - "example": "00000000-abcd-0001-0000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", - "enum": [ - "incident_integrations" - ], - "example": "incident_integrations", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" + "description": "An array of incident attachments. An attachment object without an \"id\" key indicates that you want to\ncreate that attachment. An attachment object without an \"attributes\" key indicates that you want to\ndelete that attachment. An attachment object with both the \"id\" key and a populated \"attributes\" object\nindicates that you want to update that attachment.", + "example": [ + { + "attributes": { + "attachment": { + "documentUrl": "https://app.datadoghq.com/notebook/123", + "title": "Postmortem IR-123" }, - "postmortem": { - "description": "A relationship reference for postmortems.", - "example": { - "data": { - "id": "00000000-0000-abcd-3000-000000000000", - "type": "incident_postmortems" - } - }, - "properties": { - "data": { - "description": "The postmortem relationship data.", - "example": { - "id": "00000000-0000-abcd-2000-000000000000", - "type": "incident_postmortems" - }, - "properties": { - "id": { - "description": "A unique identifier that represents the postmortem.", - "example": "00000000-0000-abcd-1000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_postmortems", - "description": "Incident postmortem resource type.", - "enum": [ - "incident_postmortems" - ], - "example": "incident_postmortems", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_POSTMORTEMS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } + "attachment_type": "postmortem" }, - "type": "object" + "id": "00000000-abcd-0002-0000-000000000000", + "type": "incident_attachments" }, - "type": { - "default": "incidents", - "description": "Incident resource type.", - "enum": [ - "incidents" - ], - "example": "incidents", - "type": "string", - "x-enum-varnames": [ - "INCIDENTS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "description": "Incident Payload.", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "Response with an incident.", - "properties": { - "data": { - "description": "Incident data from a response.", - "properties": { + { "attributes": { - "description": "The incident's attributes from a response.", - "properties": { - "archived": { - "description": "Timestamp of when the incident was archived.", - "format": "date-time", - "nullable": true, - "readOnly": true, - "type": "string" - }, - "case_id": { - "description": "The incident case id.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "created": { - "description": "Timestamp when the incident was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "customer_impact_duration": { - "description": "Length of the incident's customer impact in seconds.\nEquals the difference between `customer_impact_start` and `customer_impact_end`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "customer_impact_end": { - "description": "Timestamp when customers were no longer impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impact_scope": { - "description": "A summary of the impact customers experienced during the incident.", - "example": "An example customer impact scope", - "nullable": true, - "type": "string" - }, - "customer_impact_start": { - "description": "Timestamp when customers began being impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impacted": { - "description": "A flag indicating whether the incident caused customer impact.", - "example": false, - "type": "boolean" - }, - "detected": { - "description": "Timestamp when the incident was detected.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "fields": { - "additionalProperties": { - "description": "Dynamic fields for which selections can be made, with field names as keys.", - "oneOf": [ - { - "description": "A field with a single value selected.", - "properties": { - "type": { - "default": "dropdown", - "description": "Type of the single value field definitions.", - "enum": [ - "dropdown", - "textbox" - ], - "example": "dropdown", - "type": "string", - "x-enum-varnames": [ - "DROPDOWN", - "TEXTBOX" - ] - }, - "value": { - "description": "The single value selected for this field.", - "example": "SEV-1", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - { - "description": "A field with potentially multiple values selected.", - "properties": { - "type": { - "default": "multiselect", - "description": "Type of the multiple value field definitions.", - "enum": [ - "multiselect", - "textarray", - "metrictag", - "autocomplete" - ], - "example": "multiselect", - "type": "string", - "x-enum-varnames": [ - "MULTISELECT", - "TEXTARRAY", - "METRICTAG", - "AUTOCOMPLETE" - ] - }, - "value": { - "description": "The multiple values selected for this field.", - "example": [ - "1.0", - "1.1" - ], - "items": { - "description": "A value which has been selected for the parent field.", - "example": "1.1", - "type": "string" - }, - "nullable": true, - "type": "array" - } - }, - "type": "object" - } - ] - }, - "description": "A condensed view of the user-defined fields attached to incidents.", - "example": { - "severity": { - "type": "dropdown", - "value": "SEV-5" - } - }, - "type": "object" - }, - "incident_type_uuid": { - "description": "A unique identifier that represents an incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "type": "string" - }, - "modified": { - "description": "Timestamp when the incident was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "non_datadog_creator": { - "description": "Incident's non Datadog creator.", - "nullable": true, - "properties": { - "image_48_px": { - "description": "Non Datadog creator `48px` image.", - "type": "string" - }, - "name": { - "description": "Non Datadog creator name.", - "type": "string" - } - }, - "type": "object" - }, - "notification_handles": { - "description": "Notification handles that will be notified of the incident during update.", - "example": [ - { - "display_name": "Jane Doe", - "handle": "@user@email.com" - }, - { - "display_name": "Slack Channel", - "handle": "@slack-channel" - }, - { - "display_name": "Incident Workflow", - "handle": "@workflow-from-incident" - } - ], - "items": { - "description": "A notification handle that will be notified at incident creation.", - "properties": { - "display_name": { - "description": "The name of the notified handle.", - "example": "Jane Doe", - "type": "string" - }, - "handle": { - "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", - "example": "@test.user@test.com", - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "public_id": { - "description": "The monotonically increasing integer ID for the incident.", - "example": 1, - "format": "int64", - "type": "integer" - }, - "resolved": { - "description": "Timestamp when the incident's state was last changed from active or stable to resolved or completed.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "severity": { - "description": "The incident severity.", - "enum": [ - "UNKNOWN", - "SEV-1", - "SEV-2", - "SEV-3", - "SEV-4", - "SEV-5" - ], - "example": "UNKNOWN", - "type": "string", - "x-enum-varnames": [ - "UNKNOWN", - "SEV_1", - "SEV_2", - "SEV_3", - "SEV_4", - "SEV_5" - ] - }, - "state": { - "description": "The state incident.", - "nullable": true, - "type": "string" - }, - "time_to_detect": { - "description": "The amount of time in seconds to detect the incident.\nEquals the difference between `customer_impact_start` and `detected`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_internal_response": { - "description": "The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_repair": { - "description": "The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_resolve": { - "description": "The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "title": { - "description": "The title of the incident, which summarizes what happened.", - "example": "A test incident title", - "type": "string" - }, - "visibility": { - "description": "The incident visibility status.", - "nullable": true, - "type": "string" - } - }, - "required": [ - "title" - ], - "type": "object" - }, - "id": { - "description": "The incident's ID.", - "example": "00000000-0000-0000-1234-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident's relationships from a response.", - "properties": { - "attachments": { - "description": "A relationship reference for attachments.", - "properties": { - "data": { - "description": "An array of incident attachments.", - "items": { - "description": "The attachment relationship data.", - "properties": { - "id": { - "description": "A unique identifier that represents the attachment.", - "example": "00000000-0000-abcd-1000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", - "enum": [ - "incident_attachments" - ], - "example": "incident_attachments", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "commander_user": { - "description": "Relationship to user.", - "nullable": true, + "attachment": { + "documentUrl": "https://www.example.com/webstore-failure-runbook", + "title": "Runbook for webstore service failures" + }, + "attachment_type": "link" + }, + "type": "incident_attachments" + }, + { + "id": "00000000-abcd-0003-0000-000000000000", + "type": "incident_attachments" + } + ], + "items": { + "description": "A single incident attachment.", + "properties": { + "attributes": { + "description": "Incident attachment attributes.", + "oneOf": [ + { + "description": "The attributes object for a postmortem attachment.", "properties": { - "data": { - "description": "Relationship to user object.", - "nullable": true, + "attachment": { + "description": "The postmortem attachment.", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-0000-000000000000", + "documentUrl": { + "description": "The URL of this notebook attachment.", + "example": "https://app.datadoghq.com/notebook/123", "type": "string" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "title": { + "description": "The title of this postmortem attachment.", + "example": "Postmortem IR-123", + "type": "string" } }, "required": [ - "id", - "type" + "documentUrl", + "title" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" + }, + "attachment_type": { + "default": "postmortem", + "description": "The type of postmortem attachment attributes.", + "enum": [ + "postmortem" + ], + "example": "postmortem", + "type": "string", + "x-enum-varnames": [ + "POSTMORTEM" + ] } }, "required": [ - "data" + "attachment_type", + "attachment" ], "type": "object" }, - "created_by_user": { - "description": "Relationship to user.", + { + "description": "The attributes object for a link attachment.", "properties": { - "data": { - "description": "Relationship to user object.", + "attachment": { + "description": "The link attachment.", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", + "documentUrl": { + "description": "The URL of this link attachment.", + "example": "https://www.example.com/webstore-failure-runbook", "type": "string" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "title": { + "description": "The title of this link attachment.", + "example": "Runbook for webstore service failures", + "type": "string" } }, "required": [ - "id", - "type" + "documentUrl", + "title" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" + }, + "attachment_type": { + "default": "link", + "description": "The type of link attachment attributes.", + "enum": [ + "link" + ], + "example": "link", + "type": "string", + "x-enum-varnames": [ + "LINK" + ] + }, + "modified": { + "description": "Timestamp when the incident attachment link was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" } }, "required": [ - "data" + "attachment_type", + "attachment" ], "type": "object" + } + ] + }, + "id": { + "description": "A unique identifier that represents the incident attachment.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Incident Attachment Payload.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The response object containing the created or updated incident attachments.", + "properties": { + "data": { + "description": "An array of incident attachments. Only the attachments that were created or updated by the request are\nreturned.", + "example": [ + { + "attributes": { + "attachment": { + "documentUrl": "", + "title": "Postmortem IR-123" }, - "impacts": { - "description": "Relationship to impacts.", - "properties": { - "data": { - "description": "An array of incident impacts.", - "items": { - "description": "Relationship to impact object.", + "attachment_type": "postmortem" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + } + ], + "items": { + "description": "A single incident attachment.", + "example": { + "attributes": { + "attachment": { + "documentUrl": "", + "title": "Postmortem IR-123" + }, + "attachment_type": "postmortem" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + }, + "properties": { + "attributes": { + "description": "The attributes object for an attachment.", + "oneOf": [ + { + "description": "The attributes object for a postmortem attachment.", + "properties": { + "attachment": { + "description": "The postmortem attachment.", "properties": { - "id": { - "description": "A unique identifier that represents the impact.", - "example": "00000000-0000-0000-2345-000000000000", + "documentUrl": { + "description": "The URL of this notebook attachment.", + "example": "https://app.datadoghq.com/notebook/123", "type": "string" }, - "type": { - "description": "The incident impacts type.", - "enum": [ - "incident_impacts" - ], - "example": "incident_impacts", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_IMPACTS" - ] + "title": { + "description": "The title of this postmortem attachment.", + "example": "Postmortem IR-123", + "type": "string" } }, "required": [ - "id", - "type" + "documentUrl", + "title" ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "integrations": { - "description": "A relationship reference for multiple integration metadata objects.", - "example": { - "data": [ - { - "id": "00000000-abcd-0005-0000-000000000000", - "type": "incident_integrations" + "type": "object" }, - { - "id": "00000000-abcd-0006-0000-000000000000", - "type": "incident_integrations" + "attachment_type": { + "default": "postmortem", + "description": "The type of postmortem attachment attributes.", + "enum": [ + "postmortem" + ], + "example": "postmortem", + "type": "string", + "x-enum-varnames": [ + "POSTMORTEM" + ] } - ] + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" }, - "properties": { - "data": { - "description": "Integration metadata relationship array", - "example": [ - { - "id": "00000000-abcd-0003-0000-000000000000", - "type": "incident_integrations" - }, - { - "id": "00000000-abcd-0004-0000-000000000000", - "type": "incident_integrations" - } - ], - "items": { - "description": "A relationship reference for an integration metadata object.", - "example": { - "id": "00000000-abcd-0002-0000-000000000000", - "type": "incident_integrations" - }, + { + "description": "The attributes object for a link attachment.", + "properties": { + "attachment": { + "description": "The link attachment.", "properties": { - "id": { - "description": "A unique identifier that represents the integration metadata.", - "example": "00000000-abcd-0001-0000-000000000000", + "documentUrl": { + "description": "The URL of this link attachment.", + "example": "https://www.example.com/webstore-failure-runbook", "type": "string" }, - "type": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", - "enum": [ - "incident_integrations" - ], - "example": "incident_integrations", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" - ] + "title": { + "description": "The title of this link attachment.", + "example": "Runbook for webstore service failures", + "type": "string" } }, "required": [ - "id", - "type" + "documentUrl", + "title" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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" - ] - } + "attachment_type": { + "default": "link", + "description": "The type of link attachment attributes.", + "enum": [ + "link" + ], + "example": "link", + "type": "string", + "x-enum-varnames": [ + "LINK" + ] }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "modified": { + "description": "Timestamp when the incident attachment link was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "responders": { - "description": "Relationship to incident responders.", - "properties": { - "data": { - "description": "An array of incident responders.", - "items": { - "description": "Relationship to impact object.", + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + } + ] + }, + "id": { + "description": "A unique identifier that represents the incident attachment.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident attachment's relationships.", + "properties": { + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", "properties": { "id": { - "description": "A unique identifier that represents the responder.", + "description": "A unique identifier that represents the user.", "example": "00000000-0000-0000-2345-000000000000", "type": "string" }, "type": { - "description": "The incident responders type.", + "default": "users", + "description": "Users resource type.", "enum": [ - "incident_responders" + "users" ], - "example": "incident_responders", + "example": "users", "type": "string", "x-enum-varnames": [ - "INCIDENT_RESPONDERS" + "USERS" ] } }, @@ -229450,86 +235685,43 @@ "x-merge-override": { "required": false } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } }, - "user_defined_fields": { - "description": "Relationship to incident user defined fields.", - "properties": { - "data": { - "description": "An array of user defined fields.", - "items": { - "description": "Relationship to impact object.", - "properties": { - "id": { - "description": "A unique identifier that represents the responder.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "description": "The incident user defined fields type.", - "enum": [ - "user_defined_field" - ], - "example": "user_defined_field", - "type": "string", - "x-enum-varnames": [ - "USER_DEFINED_FIELD" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - } + "type": "object" }, - "type": "object" + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] + } }, - "type": { - "default": "incidents", - "description": "Incident resource type.", - "enum": [ - "incidents" - ], - "example": "incidents", - "type": "string", - "x-enum-varnames": [ - "INCIDENTS" - ] - } + "required": [ + "type", + "attributes", + "id", + "relationships" + ], + "type": "object" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" }, "included": { "description": "Included related resources that the user requested.", "items": { - "description": "An object related to an incident that is included in the response.", + "description": "An object related to an attachment that is included in the response.", "oneOf": [ { "description": "User object returned by the API.", @@ -229537,6 +235729,15 @@ "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" @@ -229549,14 +235750,37 @@ "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" }, - "uuid": { - "description": "UUID of the user.", + "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" @@ -229565,212 +235789,195 @@ "description": "ID of the user.", "type": "string" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object" - }, - { - "description": "A single incident attachment.", - "example": { - "attributes": { - "attachment": { - "documentUrl": "", - "title": "Postmortem IR-123" - }, - "attachment_type": "postmortem" - }, - "id": "00000000-abcd-0002-0000-000000000000", "relationships": { - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - } - }, - "type": "incident_attachments" - }, - "properties": { - "attributes": { - "description": "The attributes object for an attachment.", - "oneOf": [ - { - "description": "The attributes object for a postmortem attachment.", + "description": "Relationships of the user object returned by the API.", + "properties": { + "org": { + "description": "Relationship to an organization.", "properties": { - "attachment": { - "description": "The postmortem attachment.", + "data": { + "description": "Relationship to organization object.", "properties": { - "documentUrl": { - "description": "The URL of this notebook attachment.", - "example": "https://app.datadoghq.com/notebook/123", + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", "type": "string" }, - "title": { - "description": "The title of this postmortem attachment.", - "example": "Postmortem IR-123", - "type": "string" + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] } }, "required": [ - "documentUrl", - "title" + "id", + "type" ], "type": "object" - }, - "attachment_type": { - "default": "postmortem", - "description": "The type of postmortem attachment attributes.", - "enum": [ - "postmortem" - ], - "example": "postmortem", - "type": "string", - "x-enum-varnames": [ - "POSTMORTEM" - ] } }, "required": [ - "attachment_type", - "attachment" + "data" ], "type": "object" }, - { - "description": "The attributes object for a link attachment.", + "other_orgs": { + "description": "Relationship to organizations.", "properties": { - "attachment": { - "description": "The link attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this link attachment.", - "example": "https://www.example.com/webstore-failure-runbook", - "type": "string" + "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" + ] + } }, - "title": { - "description": "The title of this link attachment.", - "example": "Runbook for webstore service failures", - "type": "string" - } + "required": [ + "id", + "type" + ], + "type": "object" }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" - }, - "attachment_type": { - "default": "link", - "description": "The type of link attachment attributes.", - "enum": [ - "link" - ], - "example": "link", - "type": "string", - "x-enum-varnames": [ - "LINK" - ] - }, - "modified": { - "description": "Timestamp when the incident attachment link was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" + "type": "array" } }, "required": [ - "attachment_type", - "attachment" + "data" ], "type": "object" - } - ] - }, - "id": { - "description": "A unique identifier that represents the incident attachment.", - "example": "00000000-abcd-0001-0000-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident attachment's relationships.", - "properties": { - "last_modified_by_user": { - "description": "Relationship to user.", + }, + "other_users": { + "description": "Relationship to users.", "properties": { "data": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + "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" + ] + } }, - "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 } }, - "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" + "type": "object", + "x-merge-override": { + "properties": false + } }, "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", + "default": "users", + "description": "Users resource type.", "enum": [ - "incident_attachments" + "users" ], - "example": "incident_attachments", + "example": "users", "type": "string", "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" + "USERS" ] } }, - "required": [ - "type", - "attributes", - "id", - "relationships" - ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } } ] }, - "readOnly": true, "type": "array" } }, @@ -229924,23 +236131,27 @@ "description": "Too many requests" } }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "incident_write" - ] - } - ], - "summary": "Update an existing incident", + "summary": "Create, update, and delete incident attachments", "tags": [ "Incidents" ], "x-codegen-request-body-name": "body", - "x-menu-order": 3, + "x-given": { + "incident_attachment": { + "parameters": [ + { + "name": "incident_id", + "source": "incident.data.id" + }, + { + "name": "body", + "value": "{\n \"data\": [\n {\n \"attributes\": {\n \"attachment_type\": \"link\",\n \"attachment\": {\n \"documentUrl\": \"https://www.example.com/doc\",\n \"title\": \"Important Doc\"\n }\n },\n \"type\": \"incident_attachments\"\n }\n ]\n}" + } + ], + "step": "the \"incident\" has an \"incident_attachment\"" + } + }, + "x-menu-order": 8, "x-permission": { "operator": "OR", "permissions": [ @@ -229951,15 +236162,12 @@ "type": "idempotent" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - }, - "x-merge-override": { - "delete": true } }, - "/api/v2/incidents/{incident_id}/attachments": { + "/api/v2/incidents/{incident_id}/relationships/integrations": { "get": { - "description": "Get all attachments for a given incident.", - "operationId": "ListIncidentAttachments", + "description": "Get all integration metadata for an incident.", + "operationId": "ListIncidentIntegrations", "parameters": [ { "description": "The UUID of the incident.", @@ -229969,206 +236177,252 @@ "schema": { "type": "string" } - }, - { - "description": "Specifies which types of related objects are included in the response.", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "description": "The object related to an incident attachment.", - "enum": [ - "users" - ], - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - }, - "type": "array" - } - }, - { - "description": "Specifies which types of attachments are included in the response.", - "explode": false, - "in": "query", - "name": "filter[attachment_type]", - "required": false, - "schema": { - "items": { - "description": "The type of the incident attachment attributes.", - "enum": [ - "link", - "postmortem" - ], - "example": "link", - "type": "string", - "x-enum-varnames": [ - "LINK", - "POSTMORTEM" - ] - }, - "type": "array" - } } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "The response object containing an incident's attachments.", - "properties": { - "data": { - "description": "An array of incident attachments.", - "example": [ - { - "attributes": { - "attachment": { - "documentUrl": "", - "title": "Postmortem IR-123" - }, - "attachment_type": "postmortem" - }, - "id": "00000000-abcd-0002-0000-000000000000", - "relationships": { - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - } - }, - "type": "incident_attachments" - } - ], - "items": { - "description": "A single incident attachment.", - "example": { - "attributes": { - "attachment": { - "documentUrl": "", - "title": "Postmortem IR-123" - }, - "attachment_type": "postmortem" - }, - "id": "00000000-abcd-0002-0000-000000000000", - "relationships": { - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - } - }, - "type": "incident_attachments" - }, + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response with a list of incident integration metadata.", + "properties": { + "data": { + "description": "An array of incident integration metadata.", + "items": { + "description": "Incident integration metadata from a response.", "properties": { "attributes": { - "description": "The attributes object for an attachment.", - "oneOf": [ - { - "description": "The attributes object for a postmortem attachment.", - "properties": { - "attachment": { - "description": "The postmortem attachment.", + "description": "Incident integration metadata's attributes for a create request.", + "properties": { + "created": { + "description": "Timestamp when the incident todo was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "incident_id": { + "description": "UUID of the incident this integration metadata is connected to.", + "example": "00000000-aaaa-0000-0000-000000000000", + "type": "string" + }, + "integration_type": { + "description": "A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.", + "example": 1, + "format": "int32", + "maximum": 9, + "type": "integer" + }, + "metadata": { + "description": "Incident integration metadata's metadata attribute.", + "oneOf": [ + { + "description": "Incident integration metadata for the Slack integration.", "properties": { - "documentUrl": { - "description": "The URL of this notebook attachment.", - "example": "https://app.datadoghq.com/notebook/123", - "type": "string" - }, - "title": { - "description": "The title of this postmortem attachment.", - "example": "Postmortem IR-123", - "type": "string" + "channels": { + "description": "Array of Slack channels in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Slack integration metadata channel array.", + "properties": { + "channel_id": { + "description": "Slack channel ID.", + "example": "C0123456789", + "type": "string" + }, + "channel_name": { + "description": "Name of the Slack channel.", + "example": "#example-channel-name", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Slack channel.", + "example": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", + "type": "string" + }, + "team_id": { + "description": "Slack team ID.", + "example": "T01234567", + "type": "string" + } + }, + "required": [ + "channel_id", + "channel_name", + "redirect_url" + ], + "type": "object" + }, + "type": "array" } }, "required": [ - "documentUrl", - "title" + "channels" ], "type": "object" }, - "attachment_type": { - "default": "postmortem", - "description": "The type of postmortem attachment attributes.", - "enum": [ - "postmortem" - ], - "example": "postmortem", - "type": "string", - "x-enum-varnames": [ - "POSTMORTEM" - ] - } - }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - }, - { - "description": "The attributes object for a link attachment.", - "properties": { - "attachment": { - "description": "The link attachment.", + { + "description": "Incident integration metadata for the Jira integration.", "properties": { - "documentUrl": { - "description": "The URL of this link attachment.", - "example": "https://www.example.com/webstore-failure-runbook", - "type": "string" - }, - "title": { - "description": "The title of this link attachment.", - "example": "Runbook for webstore service failures", - "type": "string" + "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": [ - "documentUrl", - "title" + "issues" ], "type": "object" }, - "attachment_type": { - "default": "link", - "description": "The type of link attachment attributes.", - "enum": [ - "link" + { + "description": "Incident integration metadata for the Microsoft Teams integration.", + "properties": { + "teams": { + "description": "Array of Microsoft Teams in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Microsoft Teams integration metadata teams array.", + "properties": { + "ms_channel_id": { + "description": "Microsoft Teams channel ID.", + "example": "19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2", + "type": "string" + }, + "ms_channel_name": { + "description": "Microsoft Teams channel name.", + "example": "incident-0001-example", + "type": "string" + }, + "ms_tenant_id": { + "description": "Microsoft Teams tenant ID.", + "example": "00000000-abcd-0005-0000-000000000000", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Microsoft Teams channel.", + "example": "https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000", + "type": "string" + } + }, + "required": [ + "ms_tenant_id", + "ms_channel_id", + "ms_channel_name", + "redirect_url" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "teams" ], - "example": "link", - "type": "string", - "x-enum-varnames": [ - "LINK" - ] - }, - "modified": { - "description": "Timestamp when the incident attachment link was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" + "type": "object" } - }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" + ] + }, + "modified": { + "description": "Timestamp when the incident todo was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.", + "format": "int32", + "maximum": 5, + "type": "integer" } - ] + }, + "required": [ + "integration_type", + "metadata" + ], + "type": "object" }, "id": { - "description": "A unique identifier that represents the incident attachment.", - "example": "00000000-abcd-0001-0000-000000000000", + "description": "The incident integration metadata's ID.", + "example": "00000000-0000-0000-1234-000000000000", "type": "string" }, "relationships": { - "description": "The incident attachment's relationships.", + "description": "The incident's integration relationships from a response.", "properties": { + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, "last_modified_by_user": { "description": "Relationship to user.", "properties": { @@ -230212,23 +236466,21 @@ "type": "object" }, "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", + "default": "incident_integrations", + "description": "Integration metadata resource type.", "enum": [ - "incident_attachments" + "incident_integrations" ], - "example": "incident_attachments", + "example": "incident_integrations", "type": "string", "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" + "INCIDENT_INTEGRATIONS" ] } }, "required": [ - "type", - "attributes", "id", - "relationships" + "type" ], "type": "object" }, @@ -230237,7 +236489,7 @@ "included": { "description": "Included related resources that the user requested.", "items": { - "description": "An object related to an attachment that is included in the response.", + "description": "An object related to an incident integration metadata that is included in the response.", "oneOf": [ { "description": "User object returned by the API.", @@ -230494,7 +236746,39 @@ } ] }, + "readOnly": true, "type": "array" + }, + "meta": { + "description": "The metadata object containing pagination metadata.", + "properties": { + "pagination": { + "description": "Pagination properties.", + "properties": { + "next_offset": { + "description": "The index of the first element in the next page of results. Equal to page size added to the current offset.", + "example": 1000, + "format": "int64", + "type": "integer" + }, + "offset": { + "description": "The index of the first element in the results.", + "example": 10, + "format": "int64", + "type": "integer" + }, + "size": { + "description": "Maximum size of pages to return.", + "example": 1000, + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "readOnly": true, + "type": "object" } }, "required": [ @@ -230647,11 +236931,22 @@ "description": "Too many requests" } }, - "summary": "Get a list of attachments", + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_read" + ] + } + ], + "summary": "Get a list of an incident's integration metadata", "tags": [ "Incidents" ], - "x-menu-order": 7, + "x-menu-order": 9, "x-permission": { "operator": "OR", "permissions": [ @@ -230663,9 +236958,9 @@ }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." }, - "patch": { - "description": "The bulk update endpoint for creating, updating, and deleting attachments for a given incident.", - "operationId": "UpdateIncidentAttachments", + "post": { + "description": "Create an incident integration metadata.", + "operationId": "CreateIncidentIntegration", "parameters": [ { "description": "The UUID of the incident.", @@ -230675,185 +236970,220 @@ "schema": { "type": "string" } - }, - { - "description": "Specifies which types of related objects are included in the response.", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "description": "The object related to an incident attachment.", - "enum": [ - "users" - ], - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - }, - "type": "array" - } } ], "requestBody": { "content": { "application/json": { "schema": { - "description": "The update request for an incident's attachments.", + "description": "Create request for an incident integration metadata.", "properties": { "data": { - "description": "An array of incident attachments. An attachment object without an \"id\" key indicates that you want to\ncreate that attachment. An attachment object without an \"attributes\" key indicates that you want to\ndelete that attachment. An attachment object with both the \"id\" key and a populated \"attributes\" object\nindicates that you want to update that attachment.", - "example": [ - { - "attributes": { - "attachment": { - "documentUrl": "https://app.datadoghq.com/notebook/123", - "title": "Postmortem IR-123" + "description": "Incident integration metadata data for a create request.", + "properties": { + "attributes": { + "description": "Incident integration metadata's attributes for a create request.", + "properties": { + "created": { + "description": "Timestamp when the incident todo was created.", + "format": "date-time", + "readOnly": true, + "type": "string" }, - "attachment_type": "postmortem" - }, - "id": "00000000-abcd-0002-0000-000000000000", - "type": "incident_attachments" - }, - { - "attributes": { - "attachment": { - "documentUrl": "https://www.example.com/webstore-failure-runbook", - "title": "Runbook for webstore service failures" + "incident_id": { + "description": "UUID of the incident this integration metadata is connected to.", + "example": "00000000-aaaa-0000-0000-000000000000", + "type": "string" }, - "attachment_type": "link" - }, - "type": "incident_attachments" - }, - { - "id": "00000000-abcd-0003-0000-000000000000", - "type": "incident_attachments" - } - ], - "items": { - "description": "A single incident attachment.", - "properties": { - "attributes": { - "description": "Incident attachment attributes.", - "oneOf": [ - { - "description": "The attributes object for a postmortem attachment.", - "properties": { - "attachment": { - "description": "The postmortem attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this notebook attachment.", - "example": "https://app.datadoghq.com/notebook/123", - "type": "string" + "integration_type": { + "description": "A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.", + "example": 1, + "format": "int32", + "maximum": 9, + "type": "integer" + }, + "metadata": { + "description": "Incident integration metadata's metadata attribute.", + "oneOf": [ + { + "description": "Incident integration metadata for the Slack integration.", + "properties": { + "channels": { + "description": "Array of Slack channels in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Slack integration metadata channel array.", + "properties": { + "channel_id": { + "description": "Slack channel ID.", + "example": "C0123456789", + "type": "string" + }, + "channel_name": { + "description": "Name of the Slack channel.", + "example": "#example-channel-name", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Slack channel.", + "example": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", + "type": "string" + }, + "team_id": { + "description": "Slack team ID.", + "example": "T01234567", + "type": "string" + } + }, + "required": [ + "channel_id", + "channel_name", + "redirect_url" + ], + "type": "object" }, - "title": { - "description": "The title of this postmortem attachment.", - "example": "Postmortem IR-123", - "type": "string" - } - }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" + "type": "array" + } }, - "attachment_type": { - "default": "postmortem", - "description": "The type of postmortem attachment attributes.", - "enum": [ - "postmortem" - ], - "example": "postmortem", - "type": "string", - "x-enum-varnames": [ - "POSTMORTEM" - ] - } + "required": [ + "channels" + ], + "type": "object" }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - }, - { - "description": "The attributes object for a link attachment.", - "properties": { - "attachment": { - "description": "The link attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this link attachment.", - "example": "https://www.example.com/webstore-failure-runbook", - "type": "string" + { + "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" }, - "title": { - "description": "The title of this link attachment.", - "example": "Runbook for webstore service failures", - "type": "string" - } - }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" - }, - "attachment_type": { - "default": "link", - "description": "The type of link attachment attributes.", - "enum": [ - "link" - ], - "example": "link", - "type": "string", - "x-enum-varnames": [ - "LINK" - ] + "type": "array" + } }, - "modified": { - "description": "Timestamp when the incident attachment link was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - } + "required": [ + "issues" + ], + "type": "object" }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - } - ] - }, - "id": { - "description": "A unique identifier that represents the incident attachment.", - "example": "00000000-abcd-0001-0000-000000000000", - "type": "string" + { + "description": "Incident integration metadata for the Microsoft Teams integration.", + "properties": { + "teams": { + "description": "Array of Microsoft Teams in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Microsoft Teams integration metadata teams array.", + "properties": { + "ms_channel_id": { + "description": "Microsoft Teams channel ID.", + "example": "19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2", + "type": "string" + }, + "ms_channel_name": { + "description": "Microsoft Teams channel name.", + "example": "incident-0001-example", + "type": "string" + }, + "ms_tenant_id": { + "description": "Microsoft Teams tenant ID.", + "example": "00000000-abcd-0005-0000-000000000000", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Microsoft Teams channel.", + "example": "https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000", + "type": "string" + } + }, + "required": [ + "ms_tenant_id", + "ms_channel_id", + "ms_channel_name", + "redirect_url" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "teams" + ], + "type": "object" + } + ] + }, + "modified": { + "description": "Timestamp when the incident todo was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.", + "format": "int32", + "maximum": 5, + "type": "integer" + } }, - "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", - "enum": [ - "incident_attachments" - ], - "example": "incident_attachments", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" - ] - } + "required": [ + "integration_type", + "metadata" + ], + "type": "object" }, - "required": [ - "type" - ], - "type": "object" + "type": { + "default": "incident_integrations", + "description": "Integration metadata resource type.", + "enum": [ + "incident_integrations" + ], + "example": "incident_integrations", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_INTEGRATIONS" + ] + } }, - "type": "array" + "required": [ + "type", + "attributes" + ], + "type": "object" } }, "required": [ @@ -230863,233 +237193,316 @@ } } }, - "description": "Incident Attachment Payload.", + "description": "Incident integration metadata payload.", "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "description": "The response object containing the created or updated incident attachments.", + "description": "Response with an incident integration metadata.", "properties": { "data": { - "description": "An array of incident attachments. Only the attachments that were created or updated by the request are\nreturned.", - "example": [ - { - "attributes": { - "attachment": { - "documentUrl": "", - "title": "Postmortem IR-123" + "description": "Incident integration metadata from a response.", + "properties": { + "attributes": { + "description": "Incident integration metadata's attributes for a create request.", + "properties": { + "created": { + "description": "Timestamp when the incident todo was created.", + "format": "date-time", + "readOnly": true, + "type": "string" }, - "attachment_type": "postmortem" - }, - "id": "00000000-abcd-0002-0000-000000000000", - "relationships": { - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - } - }, - "type": "incident_attachments" - } - ], - "items": { - "description": "A single incident attachment.", - "example": { - "attributes": { - "attachment": { - "documentUrl": "", - "title": "Postmortem IR-123" + "incident_id": { + "description": "UUID of the incident this integration metadata is connected to.", + "example": "00000000-aaaa-0000-0000-000000000000", + "type": "string" }, - "attachment_type": "postmortem" - }, - "id": "00000000-abcd-0002-0000-000000000000", - "relationships": { - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - } - }, - "type": "incident_attachments" - }, - "properties": { - "attributes": { - "description": "The attributes object for an attachment.", - "oneOf": [ - { - "description": "The attributes object for a postmortem attachment.", - "properties": { - "attachment": { - "description": "The postmortem attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this notebook attachment.", - "example": "https://app.datadoghq.com/notebook/123", - "type": "string" + "integration_type": { + "description": "A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.", + "example": 1, + "format": "int32", + "maximum": 9, + "type": "integer" + }, + "metadata": { + "description": "Incident integration metadata's metadata attribute.", + "oneOf": [ + { + "description": "Incident integration metadata for the Slack integration.", + "properties": { + "channels": { + "description": "Array of Slack channels in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Slack integration metadata channel array.", + "properties": { + "channel_id": { + "description": "Slack channel ID.", + "example": "C0123456789", + "type": "string" + }, + "channel_name": { + "description": "Name of the Slack channel.", + "example": "#example-channel-name", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Slack channel.", + "example": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", + "type": "string" + }, + "team_id": { + "description": "Slack team ID.", + "example": "T01234567", + "type": "string" + } + }, + "required": [ + "channel_id", + "channel_name", + "redirect_url" + ], + "type": "object" }, - "title": { - "description": "The title of this postmortem attachment.", - "example": "Postmortem IR-123", - "type": "string" - } - }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" + "type": "array" + } }, - "attachment_type": { - "default": "postmortem", - "description": "The type of postmortem attachment attributes.", - "enum": [ - "postmortem" - ], - "example": "postmortem", - "type": "string", - "x-enum-varnames": [ - "POSTMORTEM" - ] - } + "required": [ + "channels" + ], + "type": "object" }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - }, - { - "description": "The attributes object for a link attachment.", - "properties": { - "attachment": { - "description": "The link attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this link attachment.", - "example": "https://www.example.com/webstore-failure-runbook", - "type": "string" + { + "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" }, - "title": { - "description": "The title of this link attachment.", - "example": "Runbook for webstore service failures", - "type": "string" - } + "type": "array" + } + }, + "required": [ + "issues" + ], + "type": "object" + }, + { + "description": "Incident integration metadata for the Microsoft Teams integration.", + "properties": { + "teams": { + "description": "Array of Microsoft Teams in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Microsoft Teams integration metadata teams array.", + "properties": { + "ms_channel_id": { + "description": "Microsoft Teams channel ID.", + "example": "19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2", + "type": "string" + }, + "ms_channel_name": { + "description": "Microsoft Teams channel name.", + "example": "incident-0001-example", + "type": "string" + }, + "ms_tenant_id": { + "description": "Microsoft Teams tenant ID.", + "example": "00000000-abcd-0005-0000-000000000000", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Microsoft Teams channel.", + "example": "https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000", + "type": "string" + } + }, + "required": [ + "ms_tenant_id", + "ms_channel_id", + "ms_channel_name", + "redirect_url" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "teams" + ], + "type": "object" + } + ] + }, + "modified": { + "description": "Timestamp when the incident todo was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.", + "format": "int32", + "maximum": 5, + "type": "integer" + } + }, + "required": [ + "integration_type", + "metadata" + ], + "type": "object" + }, + "id": { + "description": "The incident integration metadata's ID.", + "example": "00000000-0000-0000-1234-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident's integration relationships from a response.", + "properties": { + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" - }, - "attachment_type": { - "default": "link", - "description": "The type of link attachment attributes.", - "enum": [ - "link" - ], - "example": "link", - "type": "string", - "x-enum-varnames": [ - "LINK" - ] + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } }, - "modified": { - "description": "Timestamp when the incident attachment link was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false } - }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - } - ] - }, - "id": { - "description": "A unique identifier that represents the incident attachment.", - "example": "00000000-abcd-0001-0000-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident attachment's relationships.", - "properties": { - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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": [ + "data" + ], + "type": "object" + }, + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "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 } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } }, - "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", - "enum": [ - "incident_attachments" - ], - "example": "incident_attachments", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" - ] - } + "type": "object" }, - "required": [ - "type", - "attributes", - "id", - "relationships" - ], - "type": "object" + "type": { + "default": "incident_integrations", + "description": "Integration metadata resource type.", + "enum": [ + "incident_integrations" + ], + "example": "incident_integrations", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_INTEGRATIONS" + ] + } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" }, "included": { "description": "Included related resources that the user requested.", "items": { - "description": "An object related to an attachment that is included in the response.", + "description": "An object related to an incident integration metadata that is included in the response.", "oneOf": [ { "description": "User object returned by the API.", @@ -231346,6 +237759,7 @@ } ] }, + "readOnly": true, "type": "array" } }, @@ -231356,7 +237770,7 @@ } } }, - "description": "OK" + "description": "CREATED" }, "400": { "content": { @@ -231499,13 +237913,24 @@ "description": "Too many requests" } }, - "summary": "Create, update, and delete incident attachments", + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_write" + ] + } + ], + "summary": "Create an incident integration metadata", "tags": [ "Incidents" ], "x-codegen-request-body-name": "body", "x-given": { - "incident_attachment": { + "incident_integration_metadata": { "parameters": [ { "name": "incident_id", @@ -231513,13 +237938,13 @@ }, { "name": "body", - "value": "{\n \"data\": [\n {\n \"attributes\": {\n \"attachment_type\": \"link\",\n \"attachment\": {\n \"documentUrl\": \"https://www.example.com/doc\",\n \"title\": \"Important Doc\"\n }\n },\n \"type\": \"incident_attachments\"\n }\n ]\n}" + "value": "{\n \"data\": {\n \"attributes\": {\n \"integration_type\": 1,\n \"incident_id\": \"{{ incident.data.id }}\",\n \"status\": 2,\n \"metadata\": {\n \"channels\": [\n {\n \"channel_id\": \"C0123456789\",\n \"team_id\": \"T01234567\",\n \"channel_name\": \"#example-channel-name\",\n \"redirect_url\": \"https://slack.com/app_redirect?channel=C0123456789&team=T01234567\"\n }\n ]\n }\n },\n \"type\": \"incident_integrations\"\n }\n}" } ], - "step": "the \"incident\" has an \"incident_attachment\"" + "step": "the \"incident\" has an \"incident_integration_metadata\"" } }, - "x-menu-order": 8, + "x-menu-order": 10, "x-permission": { "operator": "OR", "permissions": [ @@ -231527,15 +237952,216 @@ ] }, "x-undo": { - "type": "idempotent" + "operationId": "DeleteIncidentIntegration", + "parameters": [ + { + "name": "incident_id", + "source": "data.attributes.incident_id" + }, + { + "name": "integration_metadata_id", + "source": "data.id" + } + ], + "type": "unsafe" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." } }, - "/api/v2/incidents/{incident_id}/relationships/integrations": { + "/api/v2/incidents/{incident_id}/relationships/integrations/{integration_metadata_id}": { + "delete": { + "description": "Delete an incident integration metadata.", + "operationId": "DeleteIncidentIntegration", + "parameters": [ + { + "description": "The UUID of the incident.", + "in": "path", + "name": "incident_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The UUID of the incident integration metadata.", + "in": "path", + "name": "integration_metadata_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "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": [ + "incident_write" + ] + } + ], + "summary": "Delete an incident integration metadata", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 13, + "x-undo": { + "type": "idempotent" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, "get": { - "description": "Get all integration metadata for an incident.", - "operationId": "ListIncidentIntegrations", + "description": "Get incident integration metadata details.", + "operationId": "GetIncidentIntegration", "parameters": [ { "description": "The UUID of the incident.", @@ -231545,6 +238171,15 @@ "schema": { "type": "string" } + }, + { + "description": "The UUID of the incident integration metadata.", + "in": "path", + "name": "integration_metadata_id", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { @@ -231552,307 +238187,303 @@ "content": { "application/json": { "schema": { - "description": "Response with a list of incident integration metadata.", + "description": "Response with an incident integration metadata.", "properties": { "data": { - "description": "An array of incident integration metadata.", - "items": { - "description": "Incident integration metadata from a response.", - "properties": { - "attributes": { - "description": "Incident integration metadata's attributes for a create request.", - "properties": { - "created": { - "description": "Timestamp when the incident todo was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "incident_id": { - "description": "UUID of the incident this integration metadata is connected to.", - "example": "00000000-aaaa-0000-0000-000000000000", - "type": "string" - }, - "integration_type": { - "description": "A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.", - "example": 1, - "format": "int32", - "maximum": 9, - "type": "integer" - }, - "metadata": { - "description": "Incident integration metadata's metadata attribute.", - "oneOf": [ - { - "description": "Incident integration metadata for the Slack integration.", - "properties": { - "channels": { - "description": "Array of Slack channels in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Slack integration metadata channel array.", - "properties": { - "channel_id": { - "description": "Slack channel ID.", - "example": "C0123456789", - "type": "string" - }, - "channel_name": { - "description": "Name of the Slack channel.", - "example": "#example-channel-name", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Slack channel.", - "example": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", - "type": "string" - }, - "team_id": { - "description": "Slack team ID.", - "example": "T01234567", - "type": "string" - } + "description": "Incident integration metadata from a response.", + "properties": { + "attributes": { + "description": "Incident integration metadata's attributes for a create request.", + "properties": { + "created": { + "description": "Timestamp when the incident todo was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "incident_id": { + "description": "UUID of the incident this integration metadata is connected to.", + "example": "00000000-aaaa-0000-0000-000000000000", + "type": "string" + }, + "integration_type": { + "description": "A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.", + "example": 1, + "format": "int32", + "maximum": 9, + "type": "integer" + }, + "metadata": { + "description": "Incident integration metadata's metadata attribute.", + "oneOf": [ + { + "description": "Incident integration metadata for the Slack integration.", + "properties": { + "channels": { + "description": "Array of Slack channels in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Slack integration metadata channel array.", + "properties": { + "channel_id": { + "description": "Slack channel ID.", + "example": "C0123456789", + "type": "string" }, - "required": [ - "channel_id", - "channel_name", - "redirect_url" - ], - "type": "object" + "channel_name": { + "description": "Name of the Slack channel.", + "example": "#example-channel-name", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Slack channel.", + "example": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", + "type": "string" + }, + "team_id": { + "description": "Slack team ID.", + "example": "T01234567", + "type": "string" + } }, - "type": "array" - } - }, - "required": [ - "channels" - ], - "type": "object" + "required": [ + "channel_id", + "channel_name", + "redirect_url" + ], + "type": "object" + }, + "type": "array" + } }, - { - "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": [ + "channels" + ], + "type": "object" + }, + { + "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" }, - "required": [ - "project_key", - "account" - ], - "type": "object" + "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" + } }, - "type": "array" - } - }, - "required": [ - "issues" - ], - "type": "object" + "required": [ + "project_key", + "account" + ], + "type": "object" + }, + "type": "array" + } }, - { - "description": "Incident integration metadata for the Microsoft Teams integration.", - "properties": { - "teams": { - "description": "Array of Microsoft Teams in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Microsoft Teams integration metadata teams array.", - "properties": { - "ms_channel_id": { - "description": "Microsoft Teams channel ID.", - "example": "19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2", - "type": "string" - }, - "ms_channel_name": { - "description": "Microsoft Teams channel name.", - "example": "incident-0001-example", - "type": "string" - }, - "ms_tenant_id": { - "description": "Microsoft Teams tenant ID.", - "example": "00000000-abcd-0005-0000-000000000000", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Microsoft Teams channel.", - "example": "https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000", - "type": "string" - } + "required": [ + "issues" + ], + "type": "object" + }, + { + "description": "Incident integration metadata for the Microsoft Teams integration.", + "properties": { + "teams": { + "description": "Array of Microsoft Teams in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Microsoft Teams integration metadata teams array.", + "properties": { + "ms_channel_id": { + "description": "Microsoft Teams channel ID.", + "example": "19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2", + "type": "string" }, - "required": [ - "ms_tenant_id", - "ms_channel_id", - "ms_channel_name", - "redirect_url" - ], - "type": "object" + "ms_channel_name": { + "description": "Microsoft Teams channel name.", + "example": "incident-0001-example", + "type": "string" + }, + "ms_tenant_id": { + "description": "Microsoft Teams tenant ID.", + "example": "00000000-abcd-0005-0000-000000000000", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Microsoft Teams channel.", + "example": "https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000", + "type": "string" + } }, - "type": "array" - } - }, - "required": [ - "teams" - ], - "type": "object" - } - ] - }, - "modified": { - "description": "Timestamp when the incident todo was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "status": { - "description": "A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.", - "format": "int32", - "maximum": 5, - "type": "integer" - } + "required": [ + "ms_tenant_id", + "ms_channel_id", + "ms_channel_name", + "redirect_url" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "teams" + ], + "type": "object" + } + ] }, - "required": [ - "integration_type", - "metadata" - ], - "type": "object" - }, - "id": { - "description": "The incident integration metadata's ID.", - "example": "00000000-0000-0000-1234-000000000000", - "type": "string" + "modified": { + "description": "Timestamp when the incident todo was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.", + "format": "int32", + "maximum": 5, + "type": "integer" + } }, - "relationships": { - "description": "The incident's integration relationships from a response.", - "properties": { - "created_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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": [ + "integration_type", + "metadata" + ], + "type": "object" + }, + "id": { + "description": "The incident integration metadata's ID.", + "example": "00000000-0000-0000-1234-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident's integration relationships from a response.", + "properties": { + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "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 } - }, - "required": [ - "data" - ], - "type": "object" + } }, - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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": [ + "data" + ], + "type": "object" + }, + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "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 } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } }, - "type": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", - "enum": [ - "incident_integrations" - ], - "example": "incident_integrations", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" - ] - } + "type": "object" }, - "required": [ - "id", - "type" - ], - "type": "object" + "type": { + "default": "incident_integrations", + "description": "Integration metadata resource type.", + "enum": [ + "incident_integrations" + ], + "example": "incident_integrations", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_INTEGRATIONS" + ] + } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" }, "included": { "description": "Included related resources that the user requested.", @@ -232116,37 +238747,6 @@ }, "readOnly": true, "type": "array" - }, - "meta": { - "description": "The metadata object containing pagination metadata.", - "properties": { - "pagination": { - "description": "Pagination properties.", - "properties": { - "next_offset": { - "description": "The index of the first element in the next page of results. Equal to page size added to the current offset.", - "example": 1000, - "format": "int64", - "type": "integer" - }, - "offset": { - "description": "The index of the first element in the results.", - "example": 10, - "format": "int64", - "type": "integer" - }, - "size": { - "description": "Maximum size of pages to return.", - "example": 1000, - "format": "int64", - "type": "integer" - } - }, - "type": "object" - } - }, - "readOnly": true, - "type": "object" } }, "required": [ @@ -232310,25 +238910,19 @@ ] } ], - "summary": "Get a list of an incident's integration metadata", + "summary": "Get incident integration metadata details", "tags": [ "Incidents" ], - "x-menu-order": 9, - "x-permission": { - "operator": "OR", - "permissions": [ - "incident_read" - ] - }, + "x-menu-order": 11, "x-undo": { "type": "safe" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." }, - "post": { - "description": "Create an incident integration metadata.", - "operationId": "CreateIncidentIntegration", + "patch": { + "description": "Update an existing incident integration metadata.", + "operationId": "UpdateIncidentIntegration", "parameters": [ { "description": "The UUID of the incident.", @@ -232338,16 +238932,25 @@ "schema": { "type": "string" } + }, + { + "description": "The UUID of the incident integration metadata.", + "in": "path", + "name": "integration_metadata_id", + "required": true, + "schema": { + "type": "string" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "description": "Create request for an incident integration metadata.", + "description": "Patch request for an incident integration metadata.", "properties": { "data": { - "description": "Incident integration metadata data for a create request.", + "description": "Incident integration metadata data for a patch request.", "properties": { "attributes": { "description": "Incident integration metadata's attributes for a create request.", @@ -232565,7 +239168,7 @@ "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { @@ -233138,7 +239741,7 @@ } } }, - "description": "CREATED" + "description": "OK" }, "400": { "content": { @@ -233292,54 +239895,22 @@ ] } ], - "summary": "Create an incident integration metadata", + "summary": "Update an existing incident integration metadata", "tags": [ "Incidents" ], "x-codegen-request-body-name": "body", - "x-given": { - "incident_integration_metadata": { - "parameters": [ - { - "name": "incident_id", - "source": "incident.data.id" - }, - { - "name": "body", - "value": "{\n \"data\": {\n \"attributes\": {\n \"integration_type\": 1,\n \"incident_id\": \"{{ incident.data.id }}\",\n \"status\": 2,\n \"metadata\": {\n \"channels\": [\n {\n \"channel_id\": \"C0123456789\",\n \"team_id\": \"T01234567\",\n \"channel_name\": \"#example-channel-name\",\n \"redirect_url\": \"https://slack.com/app_redirect?channel=C0123456789&team=T01234567\"\n }\n ]\n }\n },\n \"type\": \"incident_integrations\"\n }\n}" - } - ], - "step": "the \"incident\" has an \"incident_integration_metadata\"" - } - }, - "x-menu-order": 10, - "x-permission": { - "operator": "OR", - "permissions": [ - "incident_write" - ] - }, + "x-menu-order": 12, "x-undo": { - "operationId": "DeleteIncidentIntegration", - "parameters": [ - { - "name": "incident_id", - "source": "data.attributes.incident_id" - }, - { - "name": "integration_metadata_id", - "source": "data.id" - } - ], - "type": "unsafe" + "type": "idempotent" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." } }, - "/api/v2/incidents/{incident_id}/relationships/integrations/{integration_metadata_id}": { - "delete": { - "description": "Delete an incident integration metadata.", - "operationId": "DeleteIncidentIntegration", + "/api/v2/incidents/{incident_id}/relationships/todos": { + "get": { + "description": "Get all todos for an incident.", + "operationId": "ListIncidentTodos", "parameters": [ { "description": "The UUID of the incident.", @@ -233349,19 +239920,535 @@ "schema": { "type": "string" } - }, - { - "description": "The UUID of the incident integration metadata.", - "in": "path", - "name": "integration_metadata_id", - "required": true, - "schema": { - "type": "string" - } } ], "responses": { - "204": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response with a list of incident todos.", + "properties": { + "data": { + "description": "An array of incident todos.", + "items": { + "description": "Incident todo response data.", + "properties": { + "attributes": { + "description": "Incident todo's attributes.", + "properties": { + "assignees": { + "description": "Array of todo assignees.", + "example": [ + "@test.user@test.com" + ], + "items": { + "description": "A todo assignee.", + "example": "@test.user@test.com", + "oneOf": [ + { + "description": "Assignee's @-handle.", + "example": "@test.user@test.com", + "type": "string" + }, + { + "description": "Anonymous assignee entity.", + "properties": { + "icon": { + "description": "URL for assignee's icon.", + "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", + "type": "string" + }, + "id": { + "description": "Anonymous assignee's ID.", + "example": "USLACKBOT", + "type": "string" + }, + "name": { + "description": "Assignee's name.", + "example": "Slackbot", + "type": "string" + }, + "source": { + "default": "slack", + "description": "The source of the anonymous assignee.", + "enum": [ + "slack", + "microsoft_teams" + ], + "example": "slack", + "type": "string", + "x-enum-varnames": [ + "SLACK", + "MICROSOFT_TEAMS" + ] + } + }, + "required": [ + "id", + "icon", + "name", + "source" + ], + "type": "object" + } + ] + }, + "type": "array" + }, + "completed": { + "description": "Timestamp when the todo was completed.", + "example": "2023-03-06T22:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "content": { + "description": "The follow-up task's content.", + "example": "Restore lost data.", + "type": "string" + }, + "created": { + "description": "Timestamp when the incident todo was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "due_date": { + "description": "Timestamp when the todo should be completed by.", + "example": "2023-07-10T05:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "incident_id": { + "description": "UUID of the incident this todo is connected to.", + "example": "00000000-aaaa-0000-0000-000000000000", + "type": "string" + }, + "modified": { + "description": "Timestamp when the incident todo was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "content", + "assignees" + ], + "type": "object" + }, + "id": { + "description": "The incident todo's ID.", + "example": "00000000-0000-0000-1234-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident's relationships from a response.", + "properties": { + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "incident_todos", + "description": "Todo resource type.", + "enum": [ + "incident_todos" + ], + "example": "incident_todos", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TODOS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Included related resources that the user requested.", + "items": { + "description": "An object related to an incident todo that is included in the response.", + "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 + } + } + ] + }, + "readOnly": true, + "type": "array" + }, + "meta": { + "description": "The metadata object containing pagination metadata.", + "properties": { + "pagination": { + "description": "Pagination properties.", + "properties": { + "next_offset": { + "description": "The index of the first element in the next page of results. Equal to page size added to the current offset.", + "example": 1000, + "format": "int64", + "type": "integer" + }, + "offset": { + "description": "The index of the first element in the results.", + "example": 10, + "format": "int64", + "type": "integer" + }, + "size": { + "description": "Maximum size of pages to return.", + "example": 1000, + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "readOnly": true, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, "description": "OK" }, "400": { @@ -233512,24 +240599,29 @@ }, { "AuthZ": [ - "incident_write" + "incident_read" ] } ], - "summary": "Delete an incident integration metadata", + "summary": "Get a list of an incident's todos", "tags": [ "Incidents" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 13, + "x-menu-order": 14, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_read" + ] + }, "x-undo": { - "type": "idempotent" + "type": "safe" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." }, - "get": { - "description": "Get incident integration metadata details.", - "operationId": "GetIncidentIntegration", + "post": { + "description": "Create an incident todo.", + "operationId": "CreateIncidentTodo", "parameters": [ { "description": "The UUID of the incident.", @@ -233539,219 +240631,270 @@ "schema": { "type": "string" } - }, - { - "description": "The UUID of the incident integration metadata.", - "in": "path", - "name": "integration_metadata_id", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Create request for an incident todo.", + "properties": { + "data": { + "description": "Incident todo data for a create request.", + "properties": { + "attributes": { + "description": "Incident todo's attributes.", + "properties": { + "assignees": { + "description": "Array of todo assignees.", + "example": [ + "@test.user@test.com" + ], + "items": { + "description": "A todo assignee.", + "example": "@test.user@test.com", + "oneOf": [ + { + "description": "Assignee's @-handle.", + "example": "@test.user@test.com", + "type": "string" + }, + { + "description": "Anonymous assignee entity.", + "properties": { + "icon": { + "description": "URL for assignee's icon.", + "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", + "type": "string" + }, + "id": { + "description": "Anonymous assignee's ID.", + "example": "USLACKBOT", + "type": "string" + }, + "name": { + "description": "Assignee's name.", + "example": "Slackbot", + "type": "string" + }, + "source": { + "default": "slack", + "description": "The source of the anonymous assignee.", + "enum": [ + "slack", + "microsoft_teams" + ], + "example": "slack", + "type": "string", + "x-enum-varnames": [ + "SLACK", + "MICROSOFT_TEAMS" + ] + } + }, + "required": [ + "id", + "icon", + "name", + "source" + ], + "type": "object" + } + ] + }, + "type": "array" + }, + "completed": { + "description": "Timestamp when the todo was completed.", + "example": "2023-03-06T22:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "content": { + "description": "The follow-up task's content.", + "example": "Restore lost data.", + "type": "string" + }, + "created": { + "description": "Timestamp when the incident todo was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "due_date": { + "description": "Timestamp when the todo should be completed by.", + "example": "2023-07-10T05:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "incident_id": { + "description": "UUID of the incident this todo is connected to.", + "example": "00000000-aaaa-0000-0000-000000000000", + "type": "string" + }, + "modified": { + "description": "Timestamp when the incident todo was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "content", + "assignees" + ], + "type": "object" + }, + "type": { + "default": "incident_todos", + "description": "Todo resource type.", + "enum": [ + "incident_todos" + ], + "example": "incident_todos", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TODOS" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Incident todo payload.", + "required": true + }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "description": "Response with an incident integration metadata.", + "description": "Response with an incident todo.", "properties": { "data": { - "description": "Incident integration metadata from a response.", + "description": "Incident todo response data.", "properties": { "attributes": { - "description": "Incident integration metadata's attributes for a create request.", + "description": "Incident todo's attributes.", "properties": { + "assignees": { + "description": "Array of todo assignees.", + "example": [ + "@test.user@test.com" + ], + "items": { + "description": "A todo assignee.", + "example": "@test.user@test.com", + "oneOf": [ + { + "description": "Assignee's @-handle.", + "example": "@test.user@test.com", + "type": "string" + }, + { + "description": "Anonymous assignee entity.", + "properties": { + "icon": { + "description": "URL for assignee's icon.", + "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", + "type": "string" + }, + "id": { + "description": "Anonymous assignee's ID.", + "example": "USLACKBOT", + "type": "string" + }, + "name": { + "description": "Assignee's name.", + "example": "Slackbot", + "type": "string" + }, + "source": { + "default": "slack", + "description": "The source of the anonymous assignee.", + "enum": [ + "slack", + "microsoft_teams" + ], + "example": "slack", + "type": "string", + "x-enum-varnames": [ + "SLACK", + "MICROSOFT_TEAMS" + ] + } + }, + "required": [ + "id", + "icon", + "name", + "source" + ], + "type": "object" + } + ] + }, + "type": "array" + }, + "completed": { + "description": "Timestamp when the todo was completed.", + "example": "2023-03-06T22:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "content": { + "description": "The follow-up task's content.", + "example": "Restore lost data.", + "type": "string" + }, "created": { "description": "Timestamp when the incident todo was created.", "format": "date-time", "readOnly": true, "type": "string" }, + "due_date": { + "description": "Timestamp when the todo should be completed by.", + "example": "2023-07-10T05:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, "incident_id": { - "description": "UUID of the incident this integration metadata is connected to.", + "description": "UUID of the incident this todo is connected to.", "example": "00000000-aaaa-0000-0000-000000000000", "type": "string" }, - "integration_type": { - "description": "A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.", - "example": 1, - "format": "int32", - "maximum": 9, - "type": "integer" - }, - "metadata": { - "description": "Incident integration metadata's metadata attribute.", - "oneOf": [ - { - "description": "Incident integration metadata for the Slack integration.", - "properties": { - "channels": { - "description": "Array of Slack channels in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Slack integration metadata channel array.", - "properties": { - "channel_id": { - "description": "Slack channel ID.", - "example": "C0123456789", - "type": "string" - }, - "channel_name": { - "description": "Name of the Slack channel.", - "example": "#example-channel-name", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Slack channel.", - "example": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", - "type": "string" - }, - "team_id": { - "description": "Slack team ID.", - "example": "T01234567", - "type": "string" - } - }, - "required": [ - "channel_id", - "channel_name", - "redirect_url" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "channels" - ], - "type": "object" - }, - { - "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" - }, - { - "description": "Incident integration metadata for the Microsoft Teams integration.", - "properties": { - "teams": { - "description": "Array of Microsoft Teams in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Microsoft Teams integration metadata teams array.", - "properties": { - "ms_channel_id": { - "description": "Microsoft Teams channel ID.", - "example": "19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2", - "type": "string" - }, - "ms_channel_name": { - "description": "Microsoft Teams channel name.", - "example": "incident-0001-example", - "type": "string" - }, - "ms_tenant_id": { - "description": "Microsoft Teams tenant ID.", - "example": "00000000-abcd-0005-0000-000000000000", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Microsoft Teams channel.", - "example": "https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000", - "type": "string" - } - }, - "required": [ - "ms_tenant_id", - "ms_channel_id", - "ms_channel_name", - "redirect_url" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "teams" - ], - "type": "object" - } - ] - }, "modified": { "description": "Timestamp when the incident todo was last modified.", "format": "date-time", "readOnly": true, "type": "string" - }, - "status": { - "description": "A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.", - "format": "int32", - "maximum": 5, - "type": "integer" } }, "required": [ - "integration_type", - "metadata" + "content", + "assignees" ], "type": "object" }, "id": { - "description": "The incident integration metadata's ID.", + "description": "The incident todo's ID.", "example": "00000000-0000-0000-1234-000000000000", "type": "string" }, "relationships": { - "description": "The incident's integration relationships from a response.", + "description": "The incident's relationships from a response.", "properties": { "created_by_user": { "description": "Relationship to user.", @@ -233835,15 +240978,15 @@ "type": "object" }, "type": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", + "default": "incident_todos", + "description": "Todo resource type.", "enum": [ - "incident_integrations" + "incident_todos" ], - "example": "incident_integrations", + "example": "incident_todos", "type": "string", "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" + "INCIDENT_TODOS" ] } }, @@ -233856,7 +240999,7 @@ "included": { "description": "Included related resources that the user requested.", "items": { - "description": "An object related to an incident integration metadata that is included in the response.", + "description": "An object related to an incident todo that is included in the response.", "oneOf": [ { "description": "User object returned by the API.", @@ -234124,7 +241267,7 @@ } } }, - "description": "OK" + "description": "CREATED" }, "400": { "content": { @@ -234274,23 +241417,58 @@ }, { "AuthZ": [ - "incident_read" + "incident_write" ] } ], - "summary": "Get incident integration metadata details", + "summary": "Create an incident todo", "tags": [ "Incidents" ], - "x-menu-order": 11, + "x-codegen-request-body-name": "body", + "x-given": { + "incident_todo": { + "parameters": [ + { + "name": "incident_id", + "source": "incident.data.id" + }, + { + "name": "body", + "value": "{\n \"data\": {\n \"attributes\": {\n \"content\": \"Follow up with customer about the impact they saw.\",\n \"assignees\": [\n \"@test.user@test.com\",\n {\n \"icon\": \"https://a.slack-edge.com/80588/img/slackbot_48.png\",\n \"id\": \"USLACKBOT\",\n \"name\": \"Slackbot\",\n \"source\": \"slack\"\n }\n ]\n },\n \"type\": \"incident_todos\"\n }\n}" + } + ], + "step": "the \"incident\" has an \"incident_todo\"" + } + }, + "x-menu-order": 15, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_write" + ] + }, "x-undo": { - "type": "safe" + "operationId": "DeleteIncidentTodo", + "parameters": [ + { + "name": "incident_id", + "source": "data.attributes.incident_id" + }, + { + "name": "todo_id", + "source": "data.id" + } + ], + "type": "unsafe" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - }, - "patch": { - "description": "Update an existing incident integration metadata.", - "operationId": "UpdateIncidentIntegration", + } + }, + "/api/v2/incidents/{incident_id}/relationships/todos/{todo_id}": { + "delete": { + "description": "Delete an incident todo.", + "operationId": "DeleteIncidentTodo", "parameters": [ { "description": "The UUID of the incident.", @@ -234302,441 +241480,330 @@ } }, { - "description": "The UUID of the incident integration metadata.", + "description": "The UUID of the incident todo.", "in": "path", - "name": "integration_metadata_id", + "name": "todo_id", "required": true, "schema": { "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Patch request for an incident integration metadata.", - "properties": { - "data": { - "description": "Incident integration metadata data for a patch request.", - "properties": { - "attributes": { - "description": "Incident integration metadata's attributes for a create request.", - "properties": { - "created": { - "description": "Timestamp when the incident todo was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "incident_id": { - "description": "UUID of the incident this integration metadata is connected to.", - "example": "00000000-aaaa-0000-0000-000000000000", - "type": "string" - }, - "integration_type": { - "description": "A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.", - "example": 1, - "format": "int32", - "maximum": 9, - "type": "integer" - }, - "metadata": { - "description": "Incident integration metadata's metadata attribute.", - "oneOf": [ - { - "description": "Incident integration metadata for the Slack integration.", - "properties": { - "channels": { - "description": "Array of Slack channels in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Slack integration metadata channel array.", - "properties": { - "channel_id": { - "description": "Slack channel ID.", - "example": "C0123456789", - "type": "string" - }, - "channel_name": { - "description": "Name of the Slack channel.", - "example": "#example-channel-name", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Slack channel.", - "example": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", - "type": "string" - }, - "team_id": { - "description": "Slack team ID.", - "example": "T01234567", - "type": "string" - } - }, - "required": [ - "channel_id", - "channel_name", - "redirect_url" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "channels" - ], - "type": "object" - }, - { - "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" - }, - { - "description": "Incident integration metadata for the Microsoft Teams integration.", - "properties": { - "teams": { - "description": "Array of Microsoft Teams in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Microsoft Teams integration metadata teams array.", - "properties": { - "ms_channel_id": { - "description": "Microsoft Teams channel ID.", - "example": "19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2", - "type": "string" - }, - "ms_channel_name": { - "description": "Microsoft Teams channel name.", - "example": "incident-0001-example", - "type": "string" - }, - "ms_tenant_id": { - "description": "Microsoft Teams tenant ID.", - "example": "00000000-abcd-0005-0000-000000000000", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Microsoft Teams channel.", - "example": "https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000", - "type": "string" - } - }, - "required": [ - "ms_tenant_id", - "ms_channel_id", - "ms_channel_name", - "redirect_url" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "teams" - ], - "type": "object" - } - ] - }, - "modified": { - "description": "Timestamp when the incident todo was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "status": { - "description": "A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.", - "format": "int32", - "maximum": 5, - "type": "integer" - } - }, - "required": [ - "integration_type", - "metadata" - ], - "type": "object" + "responses": { + "204": { + "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": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", - "enum": [ - "incident_integrations" - ], - "example": "incident_integrations", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" - ] - } - }, - "required": [ - "type", - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } } - } + }, + "description": "Unauthorized" }, - "description": "Incident integration metadata payload.", - "required": true + "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": [ + "incident_write" + ] + } + ], + "summary": "Delete an incident todo", + "tags": [ + "Incidents" + ], + "x-menu-order": 18, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_write" + ] + }, + "x-undo": { + "type": "idempotent" }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "get": { + "description": "Get incident todo details.", + "operationId": "GetIncidentTodo", + "parameters": [ + { + "description": "The UUID of the incident.", + "in": "path", + "name": "incident_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The UUID of the incident todo.", + "in": "path", + "name": "todo_id", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "content": { "application/json": { "schema": { - "description": "Response with an incident integration metadata.", + "description": "Response with an incident todo.", "properties": { "data": { - "description": "Incident integration metadata from a response.", + "description": "Incident todo response data.", "properties": { "attributes": { - "description": "Incident integration metadata's attributes for a create request.", + "description": "Incident todo's attributes.", "properties": { + "assignees": { + "description": "Array of todo assignees.", + "example": [ + "@test.user@test.com" + ], + "items": { + "description": "A todo assignee.", + "example": "@test.user@test.com", + "oneOf": [ + { + "description": "Assignee's @-handle.", + "example": "@test.user@test.com", + "type": "string" + }, + { + "description": "Anonymous assignee entity.", + "properties": { + "icon": { + "description": "URL for assignee's icon.", + "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", + "type": "string" + }, + "id": { + "description": "Anonymous assignee's ID.", + "example": "USLACKBOT", + "type": "string" + }, + "name": { + "description": "Assignee's name.", + "example": "Slackbot", + "type": "string" + }, + "source": { + "default": "slack", + "description": "The source of the anonymous assignee.", + "enum": [ + "slack", + "microsoft_teams" + ], + "example": "slack", + "type": "string", + "x-enum-varnames": [ + "SLACK", + "MICROSOFT_TEAMS" + ] + } + }, + "required": [ + "id", + "icon", + "name", + "source" + ], + "type": "object" + } + ] + }, + "type": "array" + }, + "completed": { + "description": "Timestamp when the todo was completed.", + "example": "2023-03-06T22:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "content": { + "description": "The follow-up task's content.", + "example": "Restore lost data.", + "type": "string" + }, "created": { "description": "Timestamp when the incident todo was created.", "format": "date-time", "readOnly": true, "type": "string" }, + "due_date": { + "description": "Timestamp when the todo should be completed by.", + "example": "2023-07-10T05:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, "incident_id": { - "description": "UUID of the incident this integration metadata is connected to.", + "description": "UUID of the incident this todo is connected to.", "example": "00000000-aaaa-0000-0000-000000000000", "type": "string" }, - "integration_type": { - "description": "A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.", - "example": 1, - "format": "int32", - "maximum": 9, - "type": "integer" - }, - "metadata": { - "description": "Incident integration metadata's metadata attribute.", - "oneOf": [ - { - "description": "Incident integration metadata for the Slack integration.", - "properties": { - "channels": { - "description": "Array of Slack channels in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Slack integration metadata channel array.", - "properties": { - "channel_id": { - "description": "Slack channel ID.", - "example": "C0123456789", - "type": "string" - }, - "channel_name": { - "description": "Name of the Slack channel.", - "example": "#example-channel-name", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Slack channel.", - "example": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", - "type": "string" - }, - "team_id": { - "description": "Slack team ID.", - "example": "T01234567", - "type": "string" - } - }, - "required": [ - "channel_id", - "channel_name", - "redirect_url" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "channels" - ], - "type": "object" - }, - { - "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" - }, - { - "description": "Incident integration metadata for the Microsoft Teams integration.", - "properties": { - "teams": { - "description": "Array of Microsoft Teams in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Microsoft Teams integration metadata teams array.", - "properties": { - "ms_channel_id": { - "description": "Microsoft Teams channel ID.", - "example": "19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2", - "type": "string" - }, - "ms_channel_name": { - "description": "Microsoft Teams channel name.", - "example": "incident-0001-example", - "type": "string" - }, - "ms_tenant_id": { - "description": "Microsoft Teams tenant ID.", - "example": "00000000-abcd-0005-0000-000000000000", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Microsoft Teams channel.", - "example": "https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000", - "type": "string" - } - }, - "required": [ - "ms_tenant_id", - "ms_channel_id", - "ms_channel_name", - "redirect_url" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "teams" - ], - "type": "object" - } - ] - }, "modified": { "description": "Timestamp when the incident todo was last modified.", "format": "date-time", "readOnly": true, "type": "string" - }, - "status": { - "description": "A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.", - "format": "int32", - "maximum": 5, - "type": "integer" } }, "required": [ - "integration_type", - "metadata" + "content", + "assignees" ], "type": "object" }, "id": { - "description": "The incident integration metadata's ID.", + "description": "The incident todo's ID.", "example": "00000000-0000-0000-1234-000000000000", "type": "string" }, "relationships": { - "description": "The incident's integration relationships from a response.", + "description": "The incident's relationships from a response.", "properties": { "created_by_user": { "description": "Relationship to user.", @@ -234820,15 +241887,15 @@ "type": "object" }, "type": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", + "default": "incident_todos", + "description": "Todo resource type.", "enum": [ - "incident_integrations" + "incident_todos" ], - "example": "incident_integrations", + "example": "incident_todos", "type": "string", "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" + "INCIDENT_TODOS" ] } }, @@ -234841,7 +241908,7 @@ "included": { "description": "Included related resources that the user requested.", "items": { - "description": "An object related to an incident integration metadata that is included in the response.", + "description": "An object related to an incident todo that is included in the response.", "oneOf": [ { "description": "User object returned by the API.", @@ -235259,26 +242326,29 @@ }, { "AuthZ": [ - "incident_write" + "incident_read" ] } ], - "summary": "Update an existing incident integration metadata", + "summary": "Get incident todo details", "tags": [ "Incidents" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 12, + "x-menu-order": 16, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_read" + ] + }, "x-undo": { - "type": "idempotent" + "type": "safe" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - } - }, - "/api/v2/incidents/{incident_id}/relationships/todos": { - "get": { - "description": "Get all todos for an incident.", - "operationId": "ListIncidentTodos", + }, + "patch": { + "description": "Update an incident todo.", + "operationId": "UpdateIncidentTodo", "parameters": [ { "description": "The UUID of the incident.", @@ -235288,232 +242358,379 @@ "schema": { "type": "string" } + }, + { + "description": "The UUID of the incident todo.", + "in": "path", + "name": "todo_id", + "required": true, + "schema": { + "type": "string" + } } ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "Response with a list of incident todos.", - "properties": { - "data": { - "description": "An array of incident todos.", - "items": { - "description": "Incident todo response data.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Patch request for an incident todo.", + "properties": { + "data": { + "description": "Incident todo data for a patch request.", + "properties": { + "attributes": { + "description": "Incident todo's attributes.", "properties": { - "attributes": { - "description": "Incident todo's attributes.", - "properties": { - "assignees": { - "description": "Array of todo assignees.", - "example": [ - "@test.user@test.com" - ], - "items": { - "description": "A todo assignee.", + "assignees": { + "description": "Array of todo assignees.", + "example": [ + "@test.user@test.com" + ], + "items": { + "description": "A todo assignee.", + "example": "@test.user@test.com", + "oneOf": [ + { + "description": "Assignee's @-handle.", "example": "@test.user@test.com", - "oneOf": [ - { - "description": "Assignee's @-handle.", - "example": "@test.user@test.com", + "type": "string" + }, + { + "description": "Anonymous assignee entity.", + "properties": { + "icon": { + "description": "URL for assignee's icon.", + "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", "type": "string" }, - { - "description": "Anonymous assignee entity.", - "properties": { - "icon": { - "description": "URL for assignee's icon.", - "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", - "type": "string" - }, - "id": { - "description": "Anonymous assignee's ID.", - "example": "USLACKBOT", - "type": "string" - }, - "name": { - "description": "Assignee's name.", - "example": "Slackbot", - "type": "string" - }, - "source": { - "default": "slack", - "description": "The source of the anonymous assignee.", - "enum": [ - "slack", - "microsoft_teams" - ], - "example": "slack", - "type": "string", - "x-enum-varnames": [ - "SLACK", - "MICROSOFT_TEAMS" - ] - } - }, - "required": [ - "id", - "icon", - "name", - "source" + "id": { + "description": "Anonymous assignee's ID.", + "example": "USLACKBOT", + "type": "string" + }, + "name": { + "description": "Assignee's name.", + "example": "Slackbot", + "type": "string" + }, + "source": { + "default": "slack", + "description": "The source of the anonymous assignee.", + "enum": [ + "slack", + "microsoft_teams" ], - "type": "object" + "example": "slack", + "type": "string", + "x-enum-varnames": [ + "SLACK", + "MICROSOFT_TEAMS" + ] } - ] - }, - "type": "array" - }, - "completed": { - "description": "Timestamp when the todo was completed.", - "example": "2023-03-06T22:00:00.000000+00:00", - "nullable": true, - "type": "string" - }, - "content": { - "description": "The follow-up task's content.", - "example": "Restore lost data.", - "type": "string" - }, - "created": { - "description": "Timestamp when the incident todo was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "due_date": { - "description": "Timestamp when the todo should be completed by.", - "example": "2023-07-10T05:00:00.000000+00:00", - "nullable": true, - "type": "string" - }, - "incident_id": { - "description": "UUID of the incident this todo is connected to.", - "example": "00000000-aaaa-0000-0000-000000000000", - "type": "string" - }, - "modified": { - "description": "Timestamp when the incident todo was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - } + }, + "required": [ + "id", + "icon", + "name", + "source" + ], + "type": "object" + } + ] }, - "required": [ - "content", - "assignees" - ], - "type": "object" + "type": "array" }, - "id": { - "description": "The incident todo's ID.", - "example": "00000000-0000-0000-1234-000000000000", + "completed": { + "description": "Timestamp when the todo was completed.", + "example": "2023-03-06T22:00:00.000000+00:00", + "nullable": true, "type": "string" }, - "relationships": { - "description": "The incident's relationships from a response.", - "properties": { - "created_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "description": "Relationship to user object.", + "content": { + "description": "The follow-up task's content.", + "example": "Restore lost data.", + "type": "string" + }, + "created": { + "description": "Timestamp when the incident todo was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "due_date": { + "description": "Timestamp when the todo should be completed by.", + "example": "2023-07-10T05:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "incident_id": { + "description": "UUID of the incident this todo is connected to.", + "example": "00000000-aaaa-0000-0000-000000000000", + "type": "string" + }, + "modified": { + "description": "Timestamp when the incident todo was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "content", + "assignees" + ], + "type": "object" + }, + "type": { + "default": "incident_todos", + "description": "Todo resource type.", + "enum": [ + "incident_todos" + ], + "example": "incident_todos", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TODOS" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Incident todo payload.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response with an incident todo.", + "properties": { + "data": { + "description": "Incident todo response data.", + "properties": { + "attributes": { + "description": "Incident todo's attributes.", + "properties": { + "assignees": { + "description": "Array of todo assignees.", + "example": [ + "@test.user@test.com" + ], + "items": { + "description": "A todo assignee.", + "example": "@test.user@test.com", + "oneOf": [ + { + "description": "Assignee's @-handle.", + "example": "@test.user@test.com", + "type": "string" + }, + { + "description": "Anonymous assignee entity.", "properties": { + "icon": { + "description": "URL for assignee's icon.", + "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", + "type": "string" + }, "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", + "description": "Anonymous assignee's ID.", + "example": "USLACKBOT", "type": "string" }, - "type": { - "default": "users", - "description": "Users resource type.", + "name": { + "description": "Assignee's name.", + "example": "Slackbot", + "type": "string" + }, + "source": { + "default": "slack", + "description": "The source of the anonymous assignee.", "enum": [ - "users" + "slack", + "microsoft_teams" ], - "example": "users", + "example": "slack", "type": "string", "x-enum-varnames": [ - "USERS" + "SLACK", + "MICROSOFT_TEAMS" ] } }, "required": [ "id", - "type" + "icon", + "name", + "source" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } - }, - "required": [ - "data" - ], - "type": "object" + ] }, - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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" - ] - } + "type": "array" + }, + "completed": { + "description": "Timestamp when the todo was completed.", + "example": "2023-03-06T22:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "content": { + "description": "The follow-up task's content.", + "example": "Restore lost data.", + "type": "string" + }, + "created": { + "description": "Timestamp when the incident todo was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "due_date": { + "description": "Timestamp when the todo should be completed by.", + "example": "2023-07-10T05:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "incident_id": { + "description": "UUID of the incident this todo is connected to.", + "example": "00000000-aaaa-0000-0000-000000000000", + "type": "string" + }, + "modified": { + "description": "Timestamp when the incident todo was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "content", + "assignees" + ], + "type": "object" + }, + "id": { + "description": "The incident todo's ID.", + "example": "00000000-0000-0000-1234-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident's relationships from a response.", + "properties": { + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "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 } - }, - "required": [ - "data" - ], - "type": "object" - } + } + }, + "required": [ + "data" + ], + "type": "object" }, - "type": "object" + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + } }, - "type": { - "default": "incident_todos", - "description": "Todo resource type.", - "enum": [ - "incident_todos" - ], - "example": "incident_todos", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_TODOS" - ] - } + "type": "object" }, - "required": [ - "id", - "type" - ], - "type": "object" + "type": { + "default": "incident_todos", + "description": "Todo resource type.", + "enum": [ + "incident_todos" + ], + "example": "incident_todos", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TODOS" + ] + } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" }, "included": { "description": "Included related resources that the user requested.", @@ -235762,52 +242979,21 @@ "users" ], "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - ] - }, - "readOnly": true, - "type": "array" - }, - "meta": { - "description": "The metadata object containing pagination metadata.", - "properties": { - "pagination": { - "description": "Pagination properties.", - "properties": { - "next_offset": { - "description": "The index of the first element in the next page of results. Equal to page size added to the current offset.", - "example": 1000, - "format": "int64", - "type": "integer" - }, - "offset": { - "description": "The index of the first element in the results.", - "example": 10, - "format": "int64", - "type": "integer" + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } }, - "size": { - "description": "Maximum size of pages to return.", - "example": 1000, - "format": "int64", - "type": "integer" + "type": "object", + "x-merge-override": { + "required": false } - }, - "type": "object" - } + } + ] }, "readOnly": true, - "type": "object" + "type": "array" } }, "required": [ @@ -235967,168 +243153,867 @@ }, { "AuthZ": [ - "incident_read" + "incident_write" ] } ], - "summary": "Get a list of an incident's todos", + "summary": "Update an incident todo", "tags": [ "Incidents" ], - "x-menu-order": 14, + "x-codegen-request-body-name": "body", + "x-menu-order": 17, "x-permission": { "operator": "OR", "permissions": [ - "incident_read" + "incident_write" ] }, "x-undo": { - "type": "safe" + "type": "idempotent" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - }, - "post": { - "description": "Create an incident todo.", - "operationId": "CreateIncidentTodo", + } + }, + "/api/v2/integration/aws/accounts": { + "get": { + "description": "Get a list of AWS Account Integration Configs.", + "operationId": "ListAWSAccounts", "parameters": [ { - "description": "The UUID of the incident.", - "in": "path", - "name": "incident_id", - "required": true, + "description": "Optional query filter accounts by AWS Account ID", + "example": "123456789012", + "in": "query", + "name": "aws_account_id", + "required": false, "schema": { "type": "string" } } ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "AWS Accounts response body", + "properties": { + "data": { + "description": "List of AWS Account Integration Configs", + "items": { + "description": "AWS Account Response body", + "properties": { + "attributes": { + "description": "The AWS Account Integration Config", + "properties": { + "account_tags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" + } + ] + }, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "created_at": { + "description": "Timestamp of when the account integration was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "logs_config": { + "description": "AWS Logs config", + "properties": { + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "metrics_config": { + "description": "AWS Metrics config", + "properties": { + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "modified_at": { + "description": "Timestamp of when the account integration was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + } + }, + "type": "object" + } + }, + "required": [ + "aws_account_id" + ], + "type": "object" + }, + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "type": { + "default": "account", + "description": "AWS Account resource type.", + "enum": [ + "account" + ], + "example": "account", + "type": "string", + "x-enum-varnames": [ + "ACCOUNT" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "AWS Accounts List object" + }, + "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": { + "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" + } + }, + "summary": "List all AWS integrations", + "tags": [ + "AWS Integration" + ], + "x-menu-order": 1, + "x-permission": { + "operator": "OR", + "permissions": [ + "aws_configuration_read" + ] + }, + "x-undo": { + "type": "safe" + }, + "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + }, + "post": { + "description": "Create a new AWS Account Integration Config.", + "operationId": "CreateAWSAccount", "requestBody": { "content": { "application/json": { "schema": { - "description": "Create request for an incident todo.", + "description": "AWS Account Create Request body", "properties": { "data": { - "description": "Incident todo data for a create request.", + "description": "AWS Account Create Request data", "properties": { "attributes": { - "description": "Incident todo's attributes.", + "description": "The AWS Account Integration Config to be created", "properties": { - "assignees": { - "description": "Array of todo assignees.", - "example": [ - "@test.user@test.com" - ], + "account_tags": { + "description": "Tags to apply to all metrics in the account", "items": { - "description": "A todo assignee.", - "example": "@test.user@test.com", - "oneOf": [ - { - "description": "Assignee's @-handle.", - "example": "@test.user@test.com", - "type": "string" + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } }, - { - "description": "Anonymous assignee entity.", - "properties": { - "icon": { - "description": "URL for assignee's icon.", - "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" + } + ] + }, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", "type": "string" }, - "id": { - "description": "Anonymous assignee's ID.", - "example": "USLACKBOT", + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "logs_config": { + "description": "AWS Logs config", + "properties": { + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" }, - "name": { - "description": "Assignee's name.", - "example": "Slackbot", + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", "type": "string" }, - "source": { - "default": "slack", - "description": "The source of the anonymous assignee.", - "enum": [ - "slack", - "microsoft_teams" - ], - "example": "slack", - "type": "string", - "x-enum-varnames": [ - "SLACK", - "MICROSOFT_TEAMS" - ] + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "metrics_config": { + "description": "AWS Metrics config", + "properties": { + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" } }, - "required": [ - "id", - "icon", - "name", - "source" - ], "type": "object" - } - ] + }, + "type": "array" + } }, - "type": "array" - }, - "completed": { - "description": "Timestamp when the todo was completed.", - "example": "2023-03-06T22:00:00.000000+00:00", - "nullable": true, - "type": "string" - }, - "content": { - "description": "The follow-up task's content.", - "example": "Restore lost data.", - "type": "string" - }, - "created": { - "description": "Timestamp when the incident todo was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "due_date": { - "description": "Timestamp when the todo should be completed by.", - "example": "2023-07-10T05:00:00.000000+00:00", - "nullable": true, - "type": "string" + "type": "object" }, - "incident_id": { - "description": "UUID of the incident this todo is connected to.", - "example": "00000000-aaaa-0000-0000-000000000000", - "type": "string" + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" }, - "modified": { - "description": "Timestamp when the incident todo was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + } + }, + "type": "object" } }, "required": [ - "content", - "assignees" + "aws_account_id", + "aws_partition", + "auth_config" ], "type": "object" }, "type": { - "default": "incident_todos", - "description": "Todo resource type.", + "default": "account", + "description": "AWS Account resource type.", "enum": [ - "incident_todos" + "account" ], - "example": "incident_todos", + "example": "account", "type": "string", "x-enum-varnames": [ - "INCIDENT_TODOS" + "ACCOUNT" ] } }, "required": [ - "type", - "attributes" + "attributes", + "type" ], "type": "object" } @@ -236140,492 +244025,383 @@ } } }, - "description": "Incident todo payload.", "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "description": "Response with an incident todo.", + "description": "AWS Account response body", "properties": { "data": { - "description": "Incident todo response data.", + "description": "AWS Account Response body", "properties": { "attributes": { - "description": "Incident todo's attributes.", + "description": "The AWS Account Integration Config", "properties": { - "assignees": { - "description": "Array of todo assignees.", - "example": [ - "@test.user@test.com" - ], + "account_tags": { + "description": "Tags to apply to all metrics in the account", "items": { - "description": "A todo assignee.", - "example": "@test.user@test.com", - "oneOf": [ - { - "description": "Assignee's @-handle.", - "example": "@test.user@test.com", - "type": "string" - }, - { - "description": "Anonymous assignee entity.", - "properties": { - "icon": { - "description": "URL for assignee's icon.", - "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", - "type": "string" - }, - "id": { - "description": "Anonymous assignee's ID.", - "example": "USLACKBOT", - "type": "string" - }, - "name": { - "description": "Assignee's name.", - "example": "Slackbot", - "type": "string" - }, - "source": { - "default": "slack", - "description": "The source of the anonymous assignee.", - "enum": [ - "slack", - "microsoft_teams" - ], - "example": "slack", - "type": "string", - "x-enum-varnames": [ - "SLACK", - "MICROSOFT_TEAMS" - ] - } - }, - "required": [ - "id", - "icon", - "name", - "source" - ], - "type": "object" - } - ] + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" }, - "type": "array" - }, - "completed": { - "description": "Timestamp when the todo was completed.", - "example": "2023-03-06T22:00:00.000000+00:00", - "nullable": true, - "type": "string" - }, - "content": { - "description": "The follow-up task's content.", - "example": "Restore lost data.", - "type": "string" - }, - "created": { - "description": "Timestamp when the incident todo was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "due_date": { - "description": "Timestamp when the todo should be completed by.", - "example": "2023-07-10T05:00:00.000000+00:00", "nullable": true, - "type": "string" - }, - "incident_id": { - "description": "UUID of the incident this todo is connected to.", - "example": "00000000-aaaa-0000-0000-000000000000", - "type": "string" + "type": "array" }, - "modified": { - "description": "Timestamp when the incident todo was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - } - }, - "required": [ - "content", - "assignees" - ], - "type": "object" - }, - "id": { - "description": "The incident todo's ID.", - "example": "00000000-0000-0000-1234-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident's relationships from a response.", - "properties": { - "created_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "description": "Relationship to user object.", + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "writeOnly": true } }, "required": [ - "id", - "type" + "access_key_id" ], - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "description": "Relationship to user object.", + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", + "external_id": { + "description": "AWS IAM External ID for associated role", "type": "string" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" } }, "required": [ - "id", - "type" + "role_name" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } - }, - "required": [ - "data" + ] + }, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "incident_todos", - "description": "Todo resource type.", - "enum": [ - "incident_todos" - ], - "example": "incident_todos", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_TODOS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "included": { - "description": "Included related resources that the user requested.", - "items": { - "description": "An object related to an incident todo that is included in the response.", - "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" + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } }, - "status": { - "description": "Status of the user.", - "type": "string" + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } }, - "title": { - "description": "Title of the user.", - "nullable": true, - "type": "string" + "required": [ + "include_only" + ] + } + ] + }, + "created_at": { + "description": "Timestamp of when the account integration was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "logs_config": { + "description": "AWS Logs config", + "properties": { + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" + } }, - "verified": { - "description": "Whether the user is verified.", - "type": "boolean" - } - }, - "type": "object" - }, - "id": { - "description": "ID of the user.", - "type": "string" + "type": "object" + } }, - "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": "object" + }, + "metrics_config": { + "description": "AWS Metrics config", + "properties": { + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", "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": [ + "exclude_only" + ] }, - "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" - } + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] }, - "required": [ - "data" - ], - "type": "object" - }, - "other_users": { - "description": "Relationship to users.", + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", "properties": { - "data": { - "description": "Relationships to user objects.", - "example": [], + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", "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 - } + "example": "key:value", + "type": "string" }, + "nullable": true, "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": "array" + } + }, + "type": "object" + }, + "modified_at": { + "description": "Timestamp of when the account integration was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" }, - "type": "object", - "x-merge-override": { - "properties": false + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" } }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } + "type": "object" }, - "type": "object", - "x-merge-override": { - "required": false + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + } + }, + "type": "object" } - } - ] + }, + "required": [ + "aws_account_id" + ], + "type": "object" + }, + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "type": { + "default": "account", + "description": "AWS Account resource type.", + "enum": [ + "account" + ], + "example": "account", + "type": "string", + "x-enum-varnames": [ + "ACCOUNT" + ] + } }, - "readOnly": true, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, "required": [ @@ -236635,7 +244411,7 @@ } } }, - "description": "CREATED" + "description": "AWS Account object" }, "400": { "content": { @@ -236665,34 +244441,6 @@ }, "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": { @@ -236721,7 +244469,7 @@ }, "description": "Forbidden" }, - "404": { + "409": { "content": { "application/json": { "schema": { @@ -236747,7 +244495,7 @@ } } }, - "description": "Not Found" + "description": "Conflict" }, "429": { "content": { @@ -236778,79 +244526,51 @@ "description": "Too many requests" } }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "incident_write" - ] - } - ], - "summary": "Create an incident todo", + "summary": "Create an AWS integration", "tags": [ - "Incidents" + "AWS Integration" ], "x-codegen-request-body-name": "body", "x-given": { - "incident_todo": { + "aws_account_v2": { "parameters": [ - { - "name": "incident_id", - "source": "incident.data.id" - }, { "name": "body", - "value": "{\n \"data\": {\n \"attributes\": {\n \"content\": \"Follow up with customer about the impact they saw.\",\n \"assignees\": [\n \"@test.user@test.com\",\n {\n \"icon\": \"https://a.slack-edge.com/80588/img/slackbot_48.png\",\n \"id\": \"USLACKBOT\",\n \"name\": \"Slackbot\",\n \"source\": \"slack\"\n }\n ]\n },\n \"type\": \"incident_todos\"\n }\n}" + "value": "{\n \"data\": {\n \"type\": \"account\",\n \"attributes\": {\n \"account_tags\": [\n \"key:value\"\n ],\n \"auth_config\": {\n \"role_name\": \"DatadogIntegrationRole\"\n },\n \"aws_account_id\": \"123456789012\",\n \"aws_partition\": \"aws\",\n \"aws_regions\": {\n \"include_only\": [\n \"us-east-1\"\n ]\n },\n \"logs_config\": {\n \"lambda_forwarder\": {\n \"lambdas\": [\n \"arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder\"\n ],\n \"sources\": [\n \"s3\"\n ]\n }\n },\n \"metrics_config\": {\n \"enabled\": true,\n \"automute_enabled\": true,\n \"collect_custom_metrics\": false,\n \"collect_cloudwatch_alarms\": false,\n \"tag_filters\": [\n {\n \"namespace\": \"AWS/EC2\",\n \"tags\": [\n \"key:value\"\n ]\n }\n ],\n \"namespace_filters\": {\n \"include_only\": [\n \"AWS/EC2\"\n ]\n }\n },\n \"resources_config\": {\n \"cloud_security_posture_management_collection\": false,\n \"extended_collection\": false\n },\n \"traces_config\": {\n \"xray_services\": {\n \"include_only\": [\n \"AWS/AppSync\"\n ]\n }\n }\n }\n }\n}" } ], - "step": "the \"incident\" has an \"incident_todo\"" + "step": "there is a valid \"aws_account_v2\" in the system" } }, - "x-menu-order": 15, + "x-menu-order": 2, "x-permission": { "operator": "OR", "permissions": [ - "incident_write" + "aws_configurations_manage" ] }, "x-undo": { - "operationId": "DeleteIncidentTodo", + "operationId": "DeleteAWSAccount", "parameters": [ { - "name": "incident_id", - "source": "data.attributes.incident_id" - }, - { - "name": "todo_id", + "name": "aws_account_config_id", "source": "data.id" } ], "type": "unsafe" }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" } }, - "/api/v2/incidents/{incident_id}/relationships/todos/{todo_id}": { + "/api/v2/integration/aws/accounts/{aws_account_config_id}": { "delete": { - "description": "Delete an incident todo.", - "operationId": "DeleteIncidentTodo", + "description": "Delete an AWS Account Integration Config", + "operationId": "DeleteAWSAccount", "parameters": [ { - "description": "The UUID of the incident.", - "in": "path", - "name": "incident_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The UUID of the incident todo.", + "description": "Unique Datadog ID of the AWS Account Integration Config", "in": "path", - "name": "todo_id", + "name": "aws_account_config_id", "required": true, "schema": { "type": "string" @@ -236859,7 +244579,7 @@ ], "responses": { "204": { - "description": "OK" + "description": "No Content" }, "400": { "content": { @@ -236889,34 +244609,6 @@ }, "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": { @@ -237002,50 +244694,30 @@ "description": "Too many requests" } }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "incident_write" - ] - } - ], - "summary": "Delete an incident todo", + "summary": "Delete an AWS integration", "tags": [ - "Incidents" + "AWS Integration" ], - "x-menu-order": 18, + "x-menu-order": 4, "x-permission": { "operator": "OR", "permissions": [ - "incident_write" + "aws_configurations_manage" ] }, "x-undo": { "type": "idempotent" }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" }, "get": { - "description": "Get incident todo details.", - "operationId": "GetIncidentTodo", + "description": "Get an AWS Account Integration Config", + "operationId": "GetAWSAccount", "parameters": [ { - "description": "The UUID of the incident.", - "in": "path", - "name": "incident_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The UUID of the incident todo.", + "description": "Unique Datadog ID of the AWS Account Integration Config", "in": "path", - "name": "todo_id", + "name": "aws_account_config_id", "required": true, "schema": { "type": "string" @@ -237057,213 +244729,368 @@ "content": { "application/json": { "schema": { - "description": "Response with an incident todo.", + "description": "AWS Account response body", "properties": { "data": { - "description": "Incident todo response data.", + "description": "AWS Account Response body", "properties": { "attributes": { - "description": "Incident todo's attributes.", + "description": "The AWS Account Integration Config", "properties": { - "assignees": { - "description": "Array of todo assignees.", - "example": [ - "@test.user@test.com" - ], + "account_tags": { + "description": "Tags to apply to all metrics in the account", "items": { - "description": "A todo assignee.", - "example": "@test.user@test.com", - "oneOf": [ - { - "description": "Assignee's @-handle.", - "example": "@test.user@test.com", - "type": "string" - }, - { - "description": "Anonymous assignee entity.", - "properties": { - "icon": { - "description": "URL for assignee's icon.", - "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", - "type": "string" - }, - "id": { - "description": "Anonymous assignee's ID.", - "example": "USLACKBOT", - "type": "string" - }, - "name": { - "description": "Assignee's name.", - "example": "Slackbot", - "type": "string" - }, - "source": { - "default": "slack", - "description": "The source of the anonymous assignee.", - "enum": [ - "slack", - "microsoft_teams" - ], - "example": "slack", - "type": "string", - "x-enum-varnames": [ - "SLACK", - "MICROSOFT_TEAMS" - ] - } - }, - "required": [ - "id", - "icon", - "name", - "source" - ], - "type": "object" - } - ] + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" }, - "type": "array" - }, - "completed": { - "description": "Timestamp when the todo was completed.", - "example": "2023-03-06T22:00:00.000000+00:00", "nullable": true, - "type": "string" + "type": "array" }, - "content": { - "description": "The follow-up task's content.", - "example": "Restore lost data.", - "type": "string" + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" + } + ] }, - "created": { - "description": "Timestamp when the incident todo was created.", - "format": "date-time", - "readOnly": true, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", "type": "string" }, - "due_date": { - "description": "Timestamp when the todo should be completed by.", - "example": "2023-07-10T05:00:00.000000+00:00", - "nullable": true, - "type": "string" + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] }, - "incident_id": { - "description": "UUID of the incident this todo is connected to.", - "example": "00000000-aaaa-0000-0000-000000000000", - "type": "string" + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] }, - "modified": { - "description": "Timestamp when the incident todo was last modified.", + "created_at": { + "description": "Timestamp of when the account integration was created", "format": "date-time", "readOnly": true, "type": "string" - } - }, - "required": [ - "content", - "assignees" - ], - "type": "object" - }, - "id": { - "description": "The incident todo's ID.", - "example": "00000000-0000-0000-1234-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident's relationships from a response.", - "properties": { - "created_by_user": { - "description": "Relationship to user.", + }, + "logs_config": { + "description": "AWS Logs config", "properties": { - "data": { - "description": "Relationship to user object.", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, - "required": [ - "data" - ], "type": "object" }, - "last_modified_by_user": { - "description": "Relationship to user.", + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "data": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" ] } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" + } + }, + "type": "object" + }, + "modified_at": { + "description": "Timestamp of when the account integration was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] } }, - "required": [ - "data" - ], "type": "object" } }, + "required": [ + "aws_account_id" + ], "type": "object" }, + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, "type": { - "default": "incident_todos", - "description": "Todo resource type.", + "default": "account", + "description": "AWS Account resource type.", "enum": [ - "incident_todos" + "account" ], - "example": "incident_todos", + "example": "account", "type": "string", "x-enum-varnames": [ - "INCIDENT_TODOS" + "ACCOUNT" ] } }, @@ -237272,269 +245099,6 @@ "type" ], "type": "object" - }, - "included": { - "description": "Included related resources that the user requested.", - "items": { - "description": "An object related to an incident todo that is included in the response.", - "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 - } - } - ] - }, - "readOnly": true, - "type": "array" } }, "required": [ @@ -237544,7 +245108,7 @@ } } }, - "description": "OK" + "description": "AWS Account object" }, "400": { "content": { @@ -237574,34 +245138,6 @@ }, "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": { @@ -237687,50 +245223,30 @@ "description": "Too many requests" } }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "incident_read" - ] - } - ], - "summary": "Get incident todo details", + "summary": "Get an AWS integration by config ID", "tags": [ - "Incidents" + "AWS Integration" ], - "x-menu-order": 16, + "x-menu-order": 3, "x-permission": { "operator": "OR", "permissions": [ - "incident_read" + "aws_configuration_read" ] }, "x-undo": { "type": "safe" }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" }, "patch": { - "description": "Update an incident todo.", - "operationId": "UpdateIncidentTodo", + "description": "Update an AWS Account Integration Config", + "operationId": "UpdateAWSAccount", "parameters": [ { - "description": "The UUID of the incident.", - "in": "path", - "name": "incident_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The UUID of the incident todo.", + "description": "Unique Datadog ID of the AWS Account Integration Config", "in": "path", - "name": "todo_id", + "name": "aws_account_config_id", "required": true, "schema": { "type": "string" @@ -237741,130 +245257,362 @@ "content": { "application/json": { "schema": { - "description": "Patch request for an incident todo.", + "description": "AWS Account Update Request body", "properties": { "data": { - "description": "Incident todo data for a patch request.", + "description": "AWS Account Update Request data", "properties": { "attributes": { - "description": "Incident todo's attributes.", + "description": "The AWS Account Integration Config to be updated", "properties": { - "assignees": { - "description": "Array of todo assignees.", - "example": [ - "@test.user@test.com" - ], + "account_tags": { + "description": "Tags to apply to all metrics in the account", "items": { - "description": "A todo assignee.", - "example": "@test.user@test.com", - "oneOf": [ - { - "description": "Assignee's @-handle.", - "example": "@test.user@test.com", - "type": "string" + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } }, - { - "description": "Anonymous assignee entity.", - "properties": { - "icon": { - "description": "URL for assignee's icon.", - "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" + } + ] + }, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", "type": "string" }, - "id": { - "description": "Anonymous assignee's ID.", - "example": "USLACKBOT", + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "logs_config": { + "description": "AWS Logs config", + "properties": { + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" }, - "name": { - "description": "Assignee's name.", - "example": "Slackbot", + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", "type": "string" }, - "source": { - "default": "slack", - "description": "The source of the anonymous assignee.", - "enum": [ - "slack", - "microsoft_teams" - ], - "example": "slack", - "type": "string", - "x-enum-varnames": [ - "SLACK", - "MICROSOFT_TEAMS" - ] + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "metrics_config": { + "description": "AWS Metrics config", + "properties": { + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" } }, - "required": [ - "id", - "icon", - "name", - "source" - ], "type": "object" - } - ] + }, + "type": "array" + } }, - "type": "array" - }, - "completed": { - "description": "Timestamp when the todo was completed.", - "example": "2023-03-06T22:00:00.000000+00:00", - "nullable": true, - "type": "string" - }, - "content": { - "description": "The follow-up task's content.", - "example": "Restore lost data.", - "type": "string" - }, - "created": { - "description": "Timestamp when the incident todo was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "due_date": { - "description": "Timestamp when the todo should be completed by.", - "example": "2023-07-10T05:00:00.000000+00:00", - "nullable": true, - "type": "string" + "type": "object" }, - "incident_id": { - "description": "UUID of the incident this todo is connected to.", - "example": "00000000-aaaa-0000-0000-000000000000", - "type": "string" + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" }, - "modified": { - "description": "Timestamp when the incident todo was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + } + }, + "type": "object" } }, "required": [ - "content", - "assignees" + "aws_account_id" ], "type": "object" }, + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, "type": { - "default": "incident_todos", - "description": "Todo resource type.", + "default": "account", + "description": "AWS Account resource type.", "enum": [ - "incident_todos" + "account" ], - "example": "incident_todos", + "example": "account", "type": "string", "x-enum-varnames": [ - "INCIDENT_TODOS" + "ACCOUNT" ] } }, "required": [ - "type", - "attributes" + "attributes", + "type" ], "type": "object" } @@ -237876,7 +245624,6 @@ } } }, - "description": "Incident todo payload.", "required": true }, "responses": { @@ -237884,213 +245631,368 @@ "content": { "application/json": { "schema": { - "description": "Response with an incident todo.", + "description": "AWS Account response body", "properties": { "data": { - "description": "Incident todo response data.", + "description": "AWS Account Response body", "properties": { "attributes": { - "description": "Incident todo's attributes.", + "description": "The AWS Account Integration Config", "properties": { - "assignees": { - "description": "Array of todo assignees.", - "example": [ - "@test.user@test.com" - ], + "account_tags": { + "description": "Tags to apply to all metrics in the account", "items": { - "description": "A todo assignee.", - "example": "@test.user@test.com", - "oneOf": [ - { - "description": "Assignee's @-handle.", - "example": "@test.user@test.com", - "type": "string" - }, - { - "description": "Anonymous assignee entity.", - "properties": { - "icon": { - "description": "URL for assignee's icon.", - "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", - "type": "string" - }, - "id": { - "description": "Anonymous assignee's ID.", - "example": "USLACKBOT", - "type": "string" - }, - "name": { - "description": "Assignee's name.", - "example": "Slackbot", - "type": "string" - }, - "source": { - "default": "slack", - "description": "The source of the anonymous assignee.", - "enum": [ - "slack", - "microsoft_teams" - ], - "example": "slack", - "type": "string", - "x-enum-varnames": [ - "SLACK", - "MICROSOFT_TEAMS" - ] - } - }, - "required": [ - "id", - "icon", - "name", - "source" - ], - "type": "object" - } - ] + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" }, - "type": "array" - }, - "completed": { - "description": "Timestamp when the todo was completed.", - "example": "2023-03-06T22:00:00.000000+00:00", "nullable": true, - "type": "string" + "type": "array" }, - "content": { - "description": "The follow-up task's content.", - "example": "Restore lost data.", - "type": "string" + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" + } + ] }, - "created": { - "description": "Timestamp when the incident todo was created.", - "format": "date-time", - "readOnly": true, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", "type": "string" }, - "due_date": { - "description": "Timestamp when the todo should be completed by.", - "example": "2023-07-10T05:00:00.000000+00:00", - "nullable": true, - "type": "string" + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] }, - "incident_id": { - "description": "UUID of the incident this todo is connected to.", - "example": "00000000-aaaa-0000-0000-000000000000", - "type": "string" + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] }, - "modified": { - "description": "Timestamp when the incident todo was last modified.", + "created_at": { + "description": "Timestamp of when the account integration was created", "format": "date-time", "readOnly": true, "type": "string" - } - }, - "required": [ - "content", - "assignees" - ], - "type": "object" - }, - "id": { - "description": "The incident todo's ID.", - "example": "00000000-0000-0000-1234-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident's relationships from a response.", - "properties": { - "created_by_user": { - "description": "Relationship to user.", + }, + "logs_config": { + "description": "AWS Logs config", "properties": { - "data": { - "description": "Relationship to user object.", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, - "required": [ - "data" - ], "type": "object" }, - "last_modified_by_user": { - "description": "Relationship to user.", + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "data": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" ] } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" + } + }, + "type": "object" + }, + "modified_at": { + "description": "Timestamp of when the account integration was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] } }, - "required": [ - "data" - ], "type": "object" } }, + "required": [ + "aws_account_id" + ], "type": "object" }, + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, "type": { - "default": "incident_todos", - "description": "Todo resource type.", + "default": "account", + "description": "AWS Account resource type.", "enum": [ - "incident_todos" + "account" ], - "example": "incident_todos", + "example": "account", "type": "string", "x-enum-varnames": [ - "INCIDENT_TODOS" + "ACCOUNT" ] } }, @@ -238099,281 +246001,74 @@ "type" ], "type": "object" - }, - "included": { - "description": "Included related resources that the user requested.", + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "AWS Account object" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], "items": { - "description": "An object related to an incident todo that is included in the response.", - "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": "A list of items.", + "example": "Bad Request", + "type": "string" }, - "readOnly": true, "type": "array" } }, "required": [ - "data" + "errors" ], "type": "object" } } }, - "description": "OK" + "description": "Bad Request" }, - "400": { + "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": { @@ -238399,9 +246094,9 @@ } } }, - "description": "Bad Request" + "description": "Not Found" }, - "401": { + "429": { "content": { "application/json": { "schema": { @@ -238427,7 +246122,95 @@ } } }, - "description": "Unauthorized" + "description": "Too many requests" + } + }, + "summary": "Update an AWS integration", + "tags": [ + "AWS Integration" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 5, + "x-permission": { + "operator": "OR", + "permissions": [ + "aws_configuration_edit" + ] + }, + "x-undo": { + "type": "idempotent" + }, + "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + } + }, + "/api/v2/integration/aws/available_namespaces": { + "get": { + "description": "Get a list of available AWS CloudWatch namespaces that can send metrics to Datadog.", + "operationId": "ListAWSNamespaces", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "AWS Namespaces response body", + "properties": { + "data": { + "description": "AWS Namespaces response body", + "properties": { + "attributes": { + "description": "AWS Namespaces response body", + "properties": { + "namespaces": { + "description": "AWS CloudWatch namespace", + "example": [ + "AWS/ApiGateway" + ], + "items": { + "example": "AWS/ApiGateway", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "namespaces" + ], + "type": "object" + }, + "id": { + "default": "namespaces", + "description": "The `AWSNamespacesResponseData` `id`.", + "example": "namespaces", + "type": "string" + }, + "type": { + "default": "namespaces", + "description": "The `AWSNamespacesResponseData` `type`.", + "enum": [ + "namespaces" + ], + "example": "namespaces", + "type": "string", + "x-enum-varnames": [ + "NAMESPACES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "AWS Namespaces List object" }, "403": { "content": { @@ -238457,7 +246240,7 @@ }, "description": "Forbidden" }, - "404": { + "429": { "content": { "application/json": { "schema": { @@ -238483,7 +246266,116 @@ } } }, - "description": "Not Found" + "description": "Too many requests" + } + }, + "summary": "List available namespaces", + "tags": [ + "AWS Integration" + ], + "x-menu-order": 1, + "x-permission": { + "operator": "OR", + "permissions": [ + "aws_configuration_read" + ] + }, + "x-undo": { + "type": "safe" + }, + "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + } + }, + "/api/v2/integration/aws/generate_new_external_id": { + "post": { + "description": "Generate a new external ID for AWS role-based authentication.", + "operationId": "CreateNewAWSExternalID", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "AWS External ID response body", + "properties": { + "data": { + "description": "AWS External ID response body", + "properties": { + "attributes": { + "description": "AWS External ID response body", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "example": "acb8f6b8a844443dbb726d07dcb1a870", + "type": "string" + } + }, + "required": [ + "external_id" + ], + "type": "object" + }, + "id": { + "default": "external_id", + "description": "The `AWSNewExternalIDResponseData` `id`.", + "example": "external_id", + "type": "string" + }, + "type": { + "default": "external_id", + "description": "The `AWSNewExternalIDResponseData` `type`.", + "enum": [ + "external_id" + ], + "example": "external_id", + "type": "string", + "x-enum-varnames": [ + "EXTERNAL_ID" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "AWS External ID object" + }, + "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": { "content": { @@ -238514,33 +246406,164 @@ "description": "Too many requests" } }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] + "summary": "Generate a new external ID", + "tags": [ + "AWS Integration" + ], + "x-menu-order": 2, + "x-permission": { + "operator": "OR", + "permissions": [ + "aws_configuration_edit" + ] + }, + "x-undo": { + "type": "safe" + }, + "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + } + }, + "/api/v2/integration/aws/logs/services": { + "get": { + "description": "Get a list of AWS services that can send logs to Datadog.", + "operationId": "ListAWSLogsServices", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "AWS Logs Services response body", + "properties": { + "data": { + "description": "AWS Logs Services response body", + "properties": { + "attributes": { + "description": "AWS Logs Services response body", + "properties": { + "logs_services": { + "description": "List of AWS services that can send logs to Datadog", + "example": [ + "s3" + ], + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "logs_services" + ], + "type": "object" + }, + "id": { + "default": "logs_services", + "description": "The `AWSLogsServicesResponseData` `id`.", + "example": "logs_services", + "type": "string" + }, + "type": { + "default": "logs_services", + "description": "The `AWSLogsServicesResponseData` `type`.", + "enum": [ + "logs_services" + ], + "example": "logs_services", + "type": "string", + "x-enum-varnames": [ + "LOGS_SERVICES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "AWS Logs Services List object" }, - { - "AuthZ": [ - "incident_write" - ] + "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": { + "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" } - ], - "summary": "Update an incident todo", + }, + "summary": "Get list of AWS log ready services", "tags": [ - "Incidents" + "AWS Logs Integration" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 17, + "x-menu-order": 1, "x-permission": { "operator": "OR", "permissions": [ - "incident_write" + "aws_configuration_read" ] }, "x-undo": { - "type": "idempotent" + "type": "safe" }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" } }, "/api/v2/integration/gcp/accounts": { @@ -346634,6 +354657,17 @@ }, "name": "APM Retention Filters" }, + { + "description": "Configure your Datadog-AWS integration directly through the Datadog API.\nFor more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services).", + "name": "AWS Integration" + }, + { + "description": "Configure your Datadog-AWS-Logs integration directly through Datadog API.\nFor more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection).", + "externalDocs": { + "url": "https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection" + }, + "name": "AWS Logs Integration" + }, { "description": "Search your Audit Logs events over HTTP.", "name": "Audit" diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 8008a9b37d5a1..6309d996cea90 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -563,6 +563,42 @@ "request_description": "Incident todo payload.", "request_schema_description": "Patch request for an incident todo." }, + "ListAWSAccounts": { + "description": "Get a list of AWS Account Integration Configs.", + "summary": "List all AWS integrations" + }, + "CreateAWSAccount": { + "description": "Create a new AWS Account Integration Config.", + "summary": "Create an AWS integration", + "request_description": "", + "request_schema_description": "AWS Account Create Request body" + }, + "DeleteAWSAccount": { + "description": "Delete an AWS Account Integration Config", + "summary": "Delete an AWS integration" + }, + "GetAWSAccount": { + "description": "Get an AWS Account Integration Config", + "summary": "Get an AWS integration by config ID" + }, + "UpdateAWSAccount": { + "description": "Update an AWS Account Integration Config", + "summary": "Update an AWS integration", + "request_description": "", + "request_schema_description": "AWS Account Update Request body" + }, + "ListAWSNamespaces": { + "description": "Get a list of available AWS CloudWatch namespaces that can send metrics to Datadog.", + "summary": "List available namespaces" + }, + "CreateNewAWSExternalID": { + "description": "Generate a new external ID for AWS role-based authentication.", + "summary": "Generate a new external ID" + }, + "ListAWSLogsServices": { + "description": "Get a list of AWS services that can send logs to Datadog.", + "summary": "Get list of AWS log ready services" + }, "ListGCPSTSAccounts": { "description": "List all GCP STS-enabled service accounts configured in your Datadog account.", "summary": "List all GCP STS-enabled service accounts" diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index 0990b0c4bb5e5..7f6a0be1f0847 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -7,6 +7,14 @@ "name": "APM Retention Filters", "description": "Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters) for your organization. You need an API and application key with Admin rights to interact with this endpoint. See [retention filters](https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/#retention-filters) on the Trace Retention page for more information." }, + "aws-integration": { + "name": "AWS Integration", + "description": "Configure your Datadog-AWS integration directly through the Datadog API.\nFor more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services)." + }, + "aws-logs-integration": { + "name": "AWS Logs Integration", + "description": "Configure your Datadog-AWS-Logs integration directly through Datadog API.\nFor more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection)." + }, "audit": { "name": "Audit", "description": "Search your Audit Logs events over HTTP." diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index 7d074e1167bdf..c04c37753b74d 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -134,6 +134,15 @@ ] } }, + "AWSAccountConfigIDPathParameter": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "in": "path", + "name": "aws_account_config_id", + "required": true, + "schema": { + "type": "string" + } + }, "ApplicationKeyFilterCreatedAtEndParameter": { "description": "Only include application keys created on or before the specified date.", "in": "query", @@ -3375,1763 +3384,1720 @@ "API_KEYS" ] }, - "ActiveBillingDimensionsAttributes": { - "description": "List of active billing dimensions.", - "properties": { - "month": { - "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.", - "format": "date-time", - "type": "string" - }, - "values": { - "description": "List of active billing dimensions. Example: `[infra_host, apm_host, serverless_infra]`.", - "items": { - "description": "A given billing dimension in a list.", - "example": "infra_host", - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ActiveBillingDimensionsBody": { - "description": "Active billing dimensions data.", - "properties": { - "attributes": { - "description": "List of active billing dimensions.", - "properties": { - "month": { - "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.", - "format": "date-time", - "type": "string" - }, - "values": { - "description": "List of active billing dimensions. Example: `[infra_host, apm_host, serverless_infra]`.", - "items": { - "description": "A given billing dimension in a list.", - "example": "infra_host", - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "id": { - "description": "Unique ID of the response.", - "type": "string" - }, - "type": { - "default": "billing_dimensions", - "description": "Type of active billing dimensions data.", - "enum": [ - "billing_dimensions" - ], - "type": "string", - "x-enum-varnames": [ - "BILLING_DIMENSIONS" - ] - } - }, - "type": "object" + "AWSAccountConfigID": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" }, - "ActiveBillingDimensionsResponse": { - "description": "Active billing dimensions response.", + "AWSAccountCreateRequest": { + "description": "AWS Account Create Request body", "properties": { "data": { - "description": "Active billing dimensions data.", + "description": "AWS Account Create Request data", "properties": { "attributes": { - "description": "List of active billing dimensions.", + "description": "The AWS Account Integration Config to be created", "properties": { - "month": { - "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.", - "format": "date-time", - "type": "string" - }, - "values": { - "description": "List of active billing dimensions. Example: `[infra_host, apm_host, serverless_infra]`.", + "account_tags": { + "description": "Tags to apply to all metrics in the account", "items": { - "description": "A given billing dimension in a list.", - "example": "infra_host", + "description": "Tag to apply to all metrics in the account", + "example": "key:value", "type": "string" }, + "nullable": true, "type": "array" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" + } + ] + }, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "logs_config": { + "description": "AWS Logs config", + "properties": { + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "metrics_config": { + "description": "AWS Metrics config", + "properties": { + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + } + }, + "type": "object" } }, + "required": [ + "aws_account_id", + "aws_partition", + "auth_config" + ], "type": "object" }, - "id": { - "description": "Unique ID of the response.", - "type": "string" - }, "type": { - "default": "billing_dimensions", - "description": "Type of active billing dimensions data.", + "default": "account", + "description": "AWS Account resource type.", "enum": [ - "billing_dimensions" + "account" ], + "example": "account", "type": "string", "x-enum-varnames": [ - "BILLING_DIMENSIONS" + "ACCOUNT" ] } }, + "required": [ + "attributes", + "type" + ], "type": "object" } }, - "type": "object" - }, - "ActiveBillingDimensionsType": { - "default": "billing_dimensions", - "description": "Type of active billing dimensions data.", - "enum": [ - "billing_dimensions" - ], - "type": "string", - "x-enum-varnames": [ - "BILLING_DIMENSIONS" - ] - }, - "ApiID": { - "description": "API identifier.", - "example": "90646597-5fdb-4a17-a240-647003f8c028", - "format": "uuid", - "type": "string" - }, - "ApmRetentionFilterType": { - "default": "apm_retention_filter", - "description": "The type of the resource.", - "enum": [ - "apm_retention_filter" + "required": [ + "data" ], - "example": "apm_retention_filter", - "type": "string", - "x-enum-varnames": [ - "apm_retention_filter" - ] + "type": "object" }, - "ApplicationKeyCreateAttributes": { - "description": "Attributes used to create an application Key.", + "AWSAccountCreateRequestAttributes": { + "description": "The AWS Account Integration Config to be created", "properties": { - "name": { - "description": "Name of the application key.", - "example": "Application Key for managing dashboards", - "type": "string" - }, - "scopes": { - "description": "Array of scopes to grant the application key.", - "example": [ - "dashboards_read", - "dashboards_write", - "dashboards_public_share" - ], + "account_tags": { + "description": "Tags to apply to all metrics in the account", "items": { - "description": "Name of scope.", + "description": "Tag to apply to all metrics in the account", + "example": "key:value", "type": "string" }, "nullable": true, "type": "array" - } - }, - "required": [ - "name" - ], - "type": "object", - "x-merge-override": { - "properties": false - } - }, - "ApplicationKeyCreateData": { - "description": "Object used to create an application key.", - "properties": { - "attributes": { - "description": "Attributes used to create an application Key.", - "properties": { - "name": { - "description": "Name of the application key.", - "example": "Application Key for managing dashboards", - "type": "string" - }, - "scopes": { - "description": "Array of scopes to grant the application key.", - "example": [ - "dashboards_read", - "dashboards_write", - "dashboards_public_share" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" ], - "items": { - "description": "Name of scope.", - "type": "string" + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } }, - "nullable": true, - "type": "array" + "required": [ + "role_name" + ], + "type": "object" } - }, - "required": [ - "name" - ], - "type": "object", - "x-merge-override": { - "properties": false - } + ] }, - "type": { - "default": "application_keys", - "description": "Application Keys resource type.", + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", "enum": [ - "application_keys" + "aws", + "aws-cn", + "aws-us-gov" ], - "example": "application_keys", + "example": "aws", "type": "string", "x-enum-varnames": [ - "APPLICATION_KEYS" + "AWS", + "AWS_CN", + "AWS_US_GOV" ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "ApplicationKeyCreateRequest": { - "description": "Request used to create an application key.", - "properties": { - "data": { - "description": "Object used to create an application key.", - "properties": { - "attributes": { - "description": "Attributes used to create an application Key.", + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", "properties": { - "name": { - "description": "Name of the application key.", - "example": "Application Key for managing dashboards", - "type": "string" - }, - "scopes": { - "description": "Array of scopes to grant the application key.", + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", "example": [ - "dashboards_read", - "dashboards_write", - "dashboards_public_share" + "us-east-1" ], "items": { - "description": "Name of scope.", + "example": "us-east-1", "type": "string" }, - "nullable": true, "type": "array" } }, "required": [ - "name" - ], - "type": "object", - "x-merge-override": { - "properties": false - } - }, - "type": { - "default": "application_keys", - "description": "Application Keys resource type.", - "enum": [ - "application_keys" - ], - "example": "application_keys", - "type": "string", - "x-enum-varnames": [ - "APPLICATION_KEYS" + "include_only" ] } - }, - "required": [ - "attributes", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "ApplicationKeyRelationships": { - "description": "Resources related to the application key.", - "properties": { - "owned_by": { - "description": "Relationship to user.", + ] + }, + "logs_config": { + "description": "AWS Logs config", "properties": { - "data": { - "description": "Relationship to user object.", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, - "required": [ - "data" - ], "type": "object" - } - }, - "type": "object", - "x-merge-override": { - "properties": false - } - }, - "ApplicationKeyResponse": { - "description": "Response for retrieving an application key.", - "properties": { - "data": { - "description": "Datadog application key.", + }, + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "attributes": { - "description": "Attributes of a full application key.", - "properties": { - "created_at": { - "description": "Creation date of the application key.", - "example": "2020-11-23T10:00:00.000Z", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "key": { - "description": "The application key.", - "readOnly": true, - "type": "string", - "x-secret": true + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] }, - "last4": { - "description": "The last four characters of the application key.", - "example": "abcd", - "maxLength": 4, - "minLength": 4, - "readOnly": true, - "type": "string", - "x-secret": true + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] }, - "name": { - "description": "Name of the application key.", - "example": "Application Key for managing dashboards", - "type": "string" + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] }, - "scopes": { - "description": "Array of scopes to grant the application key.", - "example": [ - "dashboards_read", - "dashboards_write", - "dashboards_public_share" - ], - "items": { - "description": "Name of scope.", + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", "type": "string" }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", "nullable": true, - "type": "array" + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] } + ] + } + }, + "type": "object" + } + }, + "required": [ + "aws_account_id", + "aws_partition", + "auth_config" + ], + "type": "object" + }, + "AWSAccountCreateRequestData": { + "description": "AWS Account Create Request data", + "properties": { + "attributes": { + "description": "The AWS Account Integration Config to be created", + "properties": { + "account_tags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" }, - "type": "object", - "x-merge-override": { - "properties": false - } - }, - "id": { - "description": "ID of the application key.", - "type": "string" + "nullable": true, + "type": "array" }, - "relationships": { - "description": "Resources related to the application key.", - "properties": { - "owned_by": { - "description": "Relationship to user.", + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", "properties": { - "data": { - "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 - } + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true } }, "required": [ - "data" + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" ], "type": "object" } - }, - "type": "object", - "x-merge-override": { - "properties": false - } + ] }, - "type": { - "default": "application_keys", - "description": "Application Keys resource type.", + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", "enum": [ - "application_keys" + "aws", + "aws-cn", + "aws-us-gov" ], - "example": "application_keys", + "example": "aws", "type": "string", "x-enum-varnames": [ - "APPLICATION_KEYS" + "AWS", + "AWS_CN", + "AWS_US_GOV" ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - }, - "included": { - "description": "Array of objects related to the application key.", - "items": { - "description": "An object related to an application key.", - "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.", + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", "type": "string" }, - "handle": { - "description": "Handle of the user.", + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "logs_config": { + "description": "AWS Logs config", + "properties": { + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" }, - "icon": { - "description": "URL of the user's icon.", + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", "type": "string" }, - "mfa_enabled": { - "description": "If user has MFA enabled.", - "readOnly": true, - "type": "boolean" + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "metrics_config": { + "description": "AWS Metrics config", + "properties": { + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } }, - "modified_at": { - "description": "Time that the user was last modified.", - "format": "date-time", - "type": "string" + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } }, - "name": { - "description": "Name of the user.", - "nullable": true, - "type": "string" + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } }, - "service_account": { - "description": "Whether the user is a service account.", - "type": "boolean" + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } }, - "status": { - "description": "Status of the user.", + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", "type": "string" }, - "title": { - "description": "Title of the user.", + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, "nullable": true, - "type": "string" - }, - "verified": { - "description": "Whether the user is verified.", - "type": "boolean" + "type": "array" } }, "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" + "type": "array" + } + }, + "type": "object" + }, + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } }, - "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": "Role object returned by the API.", - "properties": { - "attributes": { - "description": "Attributes of the role.", - "properties": { - "created_at": { - "description": "Creation time of the role.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "modified_at": { - "description": "Time of last role modification.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", - "type": "string" - }, - "user_count": { - "description": "Number of users with that role.", - "format": "int64", - "readOnly": true, - "type": "integer" - } + "required": [ + "include_all" + ] }, - "type": "object" - }, - "id": { - "description": "The unique identifier of the role.", - "type": "string" - }, - "relationships": { - "description": "Relationships of the role object returned by the API.", - "properties": { - "permissions": { - "description": "Relationship to multiple permissions objects.", - "properties": { - "data": { - "description": "Relationships to permission objects.", - "items": { - "description": "Relationship to permission object.", - "properties": { - "id": { - "description": "ID of the permission.", - "type": "string" - }, - "type": { - "default": "permissions", - "description": "Permissions resource type.", - "enum": [ - "permissions" - ], - "example": "permissions", - "type": "string", - "x-enum-varnames": [ - "PERMISSIONS" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "type": "object", - "x-merge-override": { - "required": false + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" } - } - }, - "type": "object" - }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } - }, - "required": [ - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + }, + "required": [ + "include_only" + ] + } + ] } }, - { - "description": "The definition of LeakedKey object.", - "properties": { - "attributes": { - "description": "The definition of LeakedKeyAttributes object.", - "properties": { - "date": { - "description": "The LeakedKeyAttributes date.", - "example": "2017-07-21T17:32:28Z", - "format": "date-time", - "type": "string" - }, - "leak_source": { - "description": "The LeakedKeyAttributes leak_source.", - "type": "string" - } - }, - "required": [ - "date" - ], - "type": "object" - }, - "id": { - "description": "The LeakedKey id.", - "example": "id", - "type": "string" - }, - "type": { - "default": "leaked_keys", - "description": "The definition of LeakedKeyType object.", - "enum": [ - "leaked_keys" - ], - "example": "leaked_keys", - "type": "string", - "x-enum-varnames": [ - "LEAKED_KEYS" - ] - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - } - ] + "type": "object" + } }, - "type": "array" + "required": [ + "aws_account_id", + "aws_partition", + "auth_config" + ], + "type": "object" + }, + "type": { + "default": "account", + "description": "AWS Account resource type.", + "enum": [ + "account" + ], + "example": "account", + "type": "string", + "x-enum-varnames": [ + "ACCOUNT" + ] } }, + "required": [ + "attributes", + "type" + ], "type": "object" }, - "ApplicationKeyResponseIncludedItem": { - "description": "An object related to an application key.", - "oneOf": [ - { - "description": "User object returned by the API.", + "AWSAccountID": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "AWSAccountPartition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "AWSAccountResponse": { + "description": "AWS Account response body", + "properties": { + "data": { + "description": "AWS Account Response body", "properties": { "attributes": { - "description": "Attributes of user object returned by the API.", + "description": "The AWS Account Integration Config", "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.", + "account_tags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, "nullable": true, - "type": "string" + "type": "array" }, - "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.", + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, - "type": { - "default": "orgs", - "description": "Organizations resource type.", - "enum": [ - "orgs" - ], - "example": "orgs", + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, "type": "string", - "x-enum-varnames": [ - "ORGS" - ] + "writeOnly": true } }, "required": [ - "id", - "type" + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" ], "type": "object" } - }, - "required": [ - "data" + ] + }, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" ], - "type": "object" + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] }, - "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", + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", "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" + } }, - "type": "array" + "required": [ + "include_only" + ] } - }, - "required": [ - "data" - ], - "type": "object" + ] }, - "other_users": { - "description": "Relationship to users.", + "created_at": { + "description": "Timestamp of when the account integration was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "logs_config": { + "description": "AWS Logs config", "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", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } + "type": "array" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, - "type": "array" + "type": "object" } }, - "required": [ - "data" - ], "type": "object" }, - "roles": { - "description": "Relationship to roles.", + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "data": { - "description": "An array containing type and the unique identifier of a role.", + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", "items": { - "description": "Relationship to role object.", + "description": "AWS Metrics tag filters", "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", "type": "string" }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, "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": "Role object returned by the API.", - "properties": { - "attributes": { - "description": "Attributes of the role.", - "properties": { - "created_at": { - "description": "Creation time of the role.", - "format": "date-time", - "readOnly": true, - "type": "string" + "type": "object" }, "modified_at": { - "description": "Time of last role modification.", + "description": "Timestamp of when the account integration was updated", "format": "date-time", "readOnly": true, "type": "string" }, - "name": { - "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", - "type": "string" + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" }, - "user_count": { - "description": "Number of users with that role.", - "format": "int64", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "id": { - "description": "The unique identifier of the role.", - "type": "string" - }, - "relationships": { - "description": "Relationships of the role object returned by the API.", - "properties": { - "permissions": { - "description": "Relationship to multiple permissions objects.", + "traces_config": { + "description": "AWS Traces config", "properties": { - "data": { - "description": "Relationships to permission objects.", - "items": { - "description": "Relationship to permission object.", - "properties": { - "id": { - "description": "ID of the permission.", - "type": "string" + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } }, - "type": { - "default": "permissions", - "description": "Permissions resource type.", - "enum": [ - "permissions" - ], - "example": "permissions", - "type": "string", - "x-enum-varnames": [ - "PERMISSIONS" - ] - } + "required": [ + "include_all" + ] }, - "type": "object", - "x-merge-override": { - "required": false + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] } - }, - "type": "array" + ] } }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object" - }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } - }, - "required": [ - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - { - "description": "The definition of LeakedKey object.", - "properties": { - "attributes": { - "description": "The definition of LeakedKeyAttributes object.", - "properties": { - "date": { - "description": "The LeakedKeyAttributes date.", - "example": "2017-07-21T17:32:28Z", - "format": "date-time", - "type": "string" - }, - "leak_source": { - "description": "The LeakedKeyAttributes leak_source.", - "type": "string" + "type": "object" } }, "required": [ - "date" + "aws_account_id" ], "type": "object" }, "id": { - "description": "The LeakedKey id.", - "example": "id", + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, "type": { - "default": "leaked_keys", - "description": "The definition of LeakedKeyType object.", + "default": "account", + "description": "AWS Account resource type.", "enum": [ - "leaked_keys" + "account" ], - "example": "leaked_keys", + "example": "account", "type": "string", "x-enum-varnames": [ - "LEAKED_KEYS" + "ACCOUNT" ] } }, "required": [ - "attributes", "id", "type" ], "type": "object" } - ] - }, - "ApplicationKeyResponseMeta": { - "description": "Additional information related to the application key response.", - "properties": { - "max_allowed_per_user": { - "description": "Max allowed number of application keys per user.", - "format": "int64", - "type": "integer" - }, - "page": { - "description": "Additional information related to the application key response.", - "properties": { - "total_filtered_count": { - "description": "Total filtered application key count.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "ApplicationKeyResponseMetaPage": { - "description": "Additional information related to the application key response.", - "properties": { - "total_filtered_count": { - "description": "Total filtered application key count.", - "format": "int64", - "type": "integer" - } }, + "required": [ + "data" + ], "type": "object" }, - "ApplicationKeyUpdateAttributes": { - "description": "Attributes used to update an application Key.", + "AWSAccountResponseAttributes": { + "description": "The AWS Account Integration Config", "properties": { - "name": { - "description": "Name of the application key.", - "example": "Application Key for managing dashboards", - "type": "string" - }, - "scopes": { - "description": "Array of scopes to grant the application key.", - "example": [ - "dashboards_read", - "dashboards_write", - "dashboards_public_share" - ], + "account_tags": { + "description": "Tags to apply to all metrics in the account", "items": { - "description": "Name of scope.", + "description": "Tag to apply to all metrics in the account", + "example": "key:value", "type": "string" }, "nullable": true, "type": "array" - } - }, - "type": "object", - "x-merge-override": { - "properties": false - } - }, - "ApplicationKeyUpdateData": { - "description": "Object used to update an application key.", - "properties": { - "attributes": { - "description": "Attributes used to update an application Key.", - "properties": { - "name": { - "description": "Name of the application key.", - "example": "Application Key for managing dashboards", - "type": "string" - }, - "scopes": { - "description": "Array of scopes to grant the application key.", - "example": [ - "dashboards_read", - "dashboards_write", - "dashboards_public_share" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" ], - "items": { - "description": "Name of scope.", - "type": "string" + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } }, - "nullable": true, - "type": "array" + "required": [ + "role_name" + ], + "type": "object" } - }, - "type": "object", - "x-merge-override": { - "properties": false - } + ] }, - "id": { - "description": "ID of the application key.", - "example": "00112233-4455-6677-8899-aabbccddeeff", + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", "type": "string" }, - "type": { - "default": "application_keys", - "description": "Application Keys resource type.", + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", "enum": [ - "application_keys" + "aws", + "aws-cn", + "aws-us-gov" ], - "example": "application_keys", + "example": "aws", "type": "string", "x-enum-varnames": [ - "APPLICATION_KEYS" + "AWS", + "AWS_CN", + "AWS_US_GOV" ] - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "ApplicationKeyUpdateRequest": { - "description": "Request used to update an application key.", - "properties": { - "data": { - "description": "Object used to update an application key.", - "properties": { - "attributes": { - "description": "Attributes used to update an application Key.", + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", "properties": { - "name": { - "description": "Name of the application key.", - "example": "Application Key for managing dashboards", - "type": "string" - }, - "scopes": { - "description": "Array of scopes to grant the application key.", + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", "example": [ - "dashboards_read", - "dashboards_write", - "dashboards_public_share" + "us-east-1" ], "items": { - "description": "Name of scope.", + "example": "us-east-1", "type": "string" }, - "nullable": true, "type": "array" } }, - "type": "object", - "x-merge-override": { - "properties": false - } - }, - "id": { - "description": "ID of the application key.", - "example": "00112233-4455-6677-8899-aabbccddeeff", - "type": "string" - }, - "type": { - "default": "application_keys", - "description": "Application Keys resource type.", - "enum": [ - "application_keys" - ], - "example": "application_keys", - "type": "string", - "x-enum-varnames": [ - "APPLICATION_KEYS" + "required": [ + "include_only" ] } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "ApplicationKeysSort": { - "default": "name", - "description": "Sorting options", - "enum": [ - "created_at", - "-created_at", - "last4", - "-last4", - "name", - "-name" - ], - "type": "string", - "x-enum-varnames": [ - "CREATED_AT_ASCENDING", - "CREATED_AT_DESCENDING", - "LAST4_ASCENDING", - "LAST4_DESCENDING", - "NAME_ASCENDING", - "NAME_DESCENDING" - ] - }, - "ApplicationKeysType": { - "default": "application_keys", - "description": "Application Keys resource type.", - "enum": [ - "application_keys" - ], - "example": "application_keys", - "type": "string", - "x-enum-varnames": [ - "APPLICATION_KEYS" - ] - }, - "AuditLogsEvent": { - "description": "Object description of an Audit Logs event after it is processed and stored by Datadog.", - "properties": { - "attributes": { - "description": "JSON object containing all event attributes and their associated values.", - "properties": { - "attributes": { - "additionalProperties": {}, - "description": "JSON object of attributes from Audit Logs events.", - "example": { - "customAttribute": 123, - "duration": 2345 - }, - "type": "object" - }, - "message": { - "description": "Message of the event.", - "type": "string" - }, - "service": { - "description": "Name of the application or service generating Audit Logs events.\nThis name is used to correlate Audit Logs to APM, so make sure you specify the same\nvalue when you use both products.", - "example": "web-app", - "type": "string" - }, - "tags": { - "description": "Array of tags associated with your event.", - "example": [ - "team:A" - ], - "items": { - "description": "Tag associated with your event.", - "type": "string" - }, - "type": "array" - }, - "timestamp": { - "description": "Timestamp of your event.", - "example": "2019-01-02T09:42:36.320Z", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "Unique ID of the event.", - "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", - "type": "string" - }, - "type": { - "default": "audit", - "description": "Type of the event.", - "enum": [ - "audit" - ], - "example": "audit", - "type": "string", - "x-enum-varnames": [ - "Audit" ] - } - }, - "type": "object" - }, - "AuditLogsEventAttributes": { - "description": "JSON object containing all event attributes and their associated values.", - "properties": { - "attributes": { - "additionalProperties": {}, - "description": "JSON object of attributes from Audit Logs events.", - "example": { - "customAttribute": 123, - "duration": 2345 - }, - "type": "object" - }, - "message": { - "description": "Message of the event.", - "type": "string" - }, - "service": { - "description": "Name of the application or service generating Audit Logs events.\nThis name is used to correlate Audit Logs to APM, so make sure you specify the same\nvalue when you use both products.", - "example": "web-app", - "type": "string" - }, - "tags": { - "description": "Array of tags associated with your event.", - "example": [ - "team:A" - ], - "items": { - "description": "Tag associated with your event.", - "type": "string" - }, - "type": "array" }, - "timestamp": { - "description": "Timestamp of your event.", - "example": "2019-01-02T09:42:36.320Z", + "created_at": { + "description": "Timestamp of when the account integration was created", "format": "date-time", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "AuditLogsEventType": { - "default": "audit", - "description": "Type of the event.", - "enum": [ - "audit" - ], - "example": "audit", - "type": "string", - "x-enum-varnames": [ - "Audit" - ] - }, - "AuditLogsEventsResponse": { - "description": "Response object with all events matching the request and pagination information.", - "properties": { - "data": { - "description": "Array of events matching the request.", - "items": { - "description": "Object description of an Audit Logs event after it is processed and stored by Datadog.", - "properties": { - "attributes": { - "description": "JSON object containing all event attributes and their associated values.", - "properties": { - "attributes": { - "additionalProperties": {}, - "description": "JSON object of attributes from Audit Logs events.", - "example": { - "customAttribute": 123, - "duration": 2345 - }, - "type": "object" - }, - "message": { - "description": "Message of the event.", + }, + "logs_config": { + "description": "AWS Logs config", + "properties": { + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" }, - "service": { - "description": "Name of the application or service generating Audit Logs events.\nThis name is used to correlate Audit Logs to APM, so make sure you specify the same\nvalue when you use both products.", - "example": "web-app", + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", "type": "string" }, - "tags": { - "description": "Array of tags associated with your event.", - "example": [ - "team:A" - ], - "items": { - "description": "Tag associated with your event.", - "type": "string" - }, - "type": "array" - }, - "timestamp": { - "description": "Timestamp of your event.", - "example": "2019-01-02T09:42:36.320Z", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "Unique ID of the event.", - "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", - "type": "string" + "type": "array" + } }, - "type": { - "default": "audit", - "description": "Type of the event.", - "enum": [ - "audit" - ], - "example": "audit", - "type": "string", - "x-enum-varnames": [ - "Audit" - ] - } - }, - "type": "object" - }, - "type": "array" - }, - "links": { - "description": "Links attributes.", - "properties": { - "next": { - "description": "Link for the next set of results. Note that the request can also be made using the\nPOST endpoint.", - "example": "https://app.datadoghq.com/api/v2/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" + "type": "object" } }, "type": "object" }, - "meta": { - "description": "The metadata associated with a request.", + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "elapsed": { - "description": "Time elapsed in milliseconds.", - "example": 132, - "format": "int64", - "type": "integer" + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" }, - "page": { - "description": "Paging attributes.", - "properties": { - "after": { - "description": "The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - } - }, - "type": "object" + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" }, - "request_id": { - "description": "The identifier of the request.", - "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", - "type": "string" + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" }, - "status": { - "description": "The status of the response.", - "enum": [ - "done", - "timeout" - ], - "example": "done", - "type": "string", - "x-enum-varnames": [ - "DONE", - "TIMEOUT" + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } ] }, - "warnings": { - "description": "A list of warnings (non-fatal errors) encountered. Partial results may return if\nwarnings are present in the response.", + "tag_filters": { + "description": "AWS Metrics tag filters list", "items": { - "description": "Warning message indicating something that went wrong with the query.", + "description": "AWS Metrics tag filters", "properties": { - "code": { - "description": "Unique code for this type of warning.", - "example": "unknown_index", - "type": "string" - }, - "detail": { - "description": "Detailed explanation of this specific warning.", - "example": "indexes: foo, bar", + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", "type": "string" }, - "title": { - "description": "Short human-readable summary of the warning.", - "example": "One or several indexes are missing or invalid, results hold data from the other indexes", - "type": "string" + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" } }, "type": "object" @@ -5140,448 +5106,439 @@ } }, "type": "object" - } - }, - "type": "object" - }, - "AuditLogsQueryFilter": { - "description": "Search and filter query settings.", - "properties": { - "from": { - "default": "now-15m", - "description": "Minimum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).", - "example": "now-15m", - "type": "string" - }, - "query": { - "default": "*", - "description": "Search query following the Audit Logs search syntax.", - "example": "@type:session AND @session.type:user", - "type": "string" - }, - "to": { - "default": "now", - "description": "Maximum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).", - "example": "now", - "type": "string" - } - }, - "type": "object" - }, - "AuditLogsQueryOptions": { - "description": "Global query options that are used during the query.\nNote: Specify either timezone or time offset, not both. Otherwise, the query fails.", - "properties": { - "time_offset": { - "description": "Time offset (in seconds) to apply to the query.", - "format": "int64", - "type": "integer" - }, - "timezone": { - "default": "UTC", - "description": "The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).", - "example": "GMT", - "type": "string" - } - }, - "type": "object" - }, - "AuditLogsQueryPageOptions": { - "description": "Paging attributes for listing events.", - "properties": { - "cursor": { - "description": "List following results with a cursor provided in the previous query.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - }, - "limit": { - "default": 10, - "description": "Maximum number of events in the response.", - "example": 25, - "format": "int32", - "maximum": 1000, - "type": "integer" - } - }, - "type": "object" - }, - "AuditLogsResponseLinks": { - "description": "Links attributes.", - "properties": { - "next": { - "description": "Link for the next set of results. Note that the request can also be made using the\nPOST endpoint.", - "example": "https://app.datadoghq.com/api/v2/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - } - }, - "type": "object" - }, - "AuditLogsResponseMetadata": { - "description": "The metadata associated with a request.", - "properties": { - "elapsed": { - "description": "Time elapsed in milliseconds.", - "example": 132, - "format": "int64", - "type": "integer" - }, - "page": { - "description": "Paging attributes.", - "properties": { - "after": { - "description": "The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - } - }, - "type": "object" - }, - "request_id": { - "description": "The identifier of the request.", - "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", - "type": "string" - }, - "status": { - "description": "The status of the response.", - "enum": [ - "done", - "timeout" - ], - "example": "done", - "type": "string", - "x-enum-varnames": [ - "DONE", - "TIMEOUT" - ] }, - "warnings": { - "description": "A list of warnings (non-fatal errors) encountered. Partial results may return if\nwarnings are present in the response.", - "items": { - "description": "Warning message indicating something that went wrong with the query.", - "properties": { - "code": { - "description": "Unique code for this type of warning.", - "example": "unknown_index", - "type": "string" - }, - "detail": { - "description": "Detailed explanation of this specific warning.", - "example": "indexes: foo, bar", - "type": "string" - }, - "title": { - "description": "Short human-readable summary of the warning.", - "example": "One or several indexes are missing or invalid, results hold data from the other indexes", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - }, - "AuditLogsResponsePage": { - "description": "Paging attributes.", - "properties": { - "after": { - "description": "The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "modified_at": { + "description": "Timestamp of when the account integration was updated", + "format": "date-time", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "AuditLogsResponseStatus": { - "description": "The status of the response.", - "enum": [ - "done", - "timeout" - ], - "example": "done", - "type": "string", - "x-enum-varnames": [ - "DONE", - "TIMEOUT" - ] - }, - "AuditLogsSearchEventsRequest": { - "description": "The request for a Audit Logs events list.", - "properties": { - "filter": { - "description": "Search and filter query settings.", - "properties": { - "from": { - "default": "now-15m", - "description": "Minimum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).", - "example": "now-15m", - "type": "string" - }, - "query": { - "default": "*", - "description": "Search query following the Audit Logs search syntax.", - "example": "@type:session AND @session.type:user", - "type": "string" - }, - "to": { - "default": "now", - "description": "Maximum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).", - "example": "now", - "type": "string" - } - }, - "type": "object" }, - "options": { - "description": "Global query options that are used during the query.\nNote: Specify either timezone or time offset, not both. Otherwise, the query fails.", + "resources_config": { + "description": "AWS Resources config", "properties": { - "time_offset": { - "description": "Time offset (in seconds) to apply to the query.", - "format": "int64", - "type": "integer" + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" }, - "timezone": { - "default": "UTC", - "description": "The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).", - "example": "GMT", - "type": "string" + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" } }, "type": "object" }, - "page": { - "description": "Paging attributes for listing events.", + "traces_config": { + "description": "AWS Traces config", "properties": { - "cursor": { - "description": "List following results with a cursor provided in the previous query.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - }, - "limit": { - "default": 10, - "description": "Maximum number of events in the response.", - "example": 25, - "format": "int32", - "maximum": 1000, - "type": "integer" + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] } }, "type": "object" - }, - "sort": { - "description": "Sort parameters when querying events.", - "enum": [ - "timestamp", - "-timestamp" - ], - "type": "string", - "x-enum-varnames": [ - "TIMESTAMP_ASCENDING", - "TIMESTAMP_DESCENDING" - ] } }, - "type": "object" - }, - "AuditLogsSort": { - "description": "Sort parameters when querying events.", - "enum": [ - "timestamp", - "-timestamp" + "required": [ + "aws_account_id" ], - "type": "string", - "x-enum-varnames": [ - "TIMESTAMP_ASCENDING", - "TIMESTAMP_DESCENDING" - ] - }, - "AuditLogsWarning": { - "description": "Warning message indicating something that went wrong with the query.", - "properties": { - "code": { - "description": "Unique code for this type of warning.", - "example": "unknown_index", - "type": "string" - }, - "detail": { - "description": "Detailed explanation of this specific warning.", - "example": "indexes: foo, bar", - "type": "string" - }, - "title": { - "description": "Short human-readable summary of the warning.", - "example": "One or several indexes are missing or invalid, results hold data from the other indexes", - "type": "string" - } - }, "type": "object" }, - "AuthNMapping": { - "description": "The AuthN Mapping object returned by API.", + "AWSAccountResponseData": { + "description": "AWS Account Response body", "properties": { "attributes": { - "description": "Attributes of AuthN Mapping.", + "description": "The AWS Account Integration Config", "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" + "account_tags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" + } + ] }, - "created_at": { - "description": "Creation time of the AuthN Mapping.", - "format": "date-time", - "readOnly": true, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", "type": "string" }, - "modified_at": { - "description": "Time of last AuthN Mapping modification.", + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "created_at": { + "description": "Timestamp of when the account integration was created", "format": "date-time", "readOnly": true, "type": "string" }, - "saml_assertion_attribute_id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "ID of the AuthN Mapping.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" - }, - "relationships": { - "description": "All relationships associated with AuthN Mapping.", - "properties": { - "role": { - "description": "Relationship to role.", + "logs_config": { + "description": "AWS Logs config", "properties": { - "data": { - "description": "Relationship to role object.", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, - "saml_assertion_attribute": { - "description": "AuthN Mapping relationship to SAML Assertion Attribute.", + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "data": { - "description": "Data of AuthN Mapping relationship to SAML Assertion Attribute.", - "properties": { - "id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] }, - "type": { - "default": "saml_assertion_attributes", - "description": "SAML assertion attributes resource type.", - "enum": [ - "saml_assertion_attributes" - ], - "example": "saml_assertion_attributes", - "type": "string", - "x-enum-varnames": [ - "SAML_ASSERTION_ATTRIBUTES" + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" ] } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" } }, - "required": [ - "data" - ], "type": "object" }, - "team": { - "description": "Relationship to team.", + "modified_at": { + "description": "Timestamp of when the account integration was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "resources_config": { + "description": "AWS Resources config", "properties": { - "data": { - "description": "Relationship to Team object.", - "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" ] } - }, - "type": "object", - "x-merge-override": { - "required": false - } + ] } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, + "required": [ + "aws_account_id" + ], "type": "object" }, + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, "type": { - "default": "authn_mappings", - "description": "AuthN Mappings resource type.", + "default": "account", + "description": "AWS Account resource type.", "enum": [ - "authn_mappings" + "account" ], - "example": "authn_mappings", + "example": "account", "type": "string", "x-enum-varnames": [ - "AUTHN_MAPPINGS" + "ACCOUNT" ] } }, @@ -5589,412 +5546,386 @@ "id", "type" ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "AuthNMappingAttributes": { - "description": "Attributes of AuthN Mapping.", - "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" - }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" - }, - "created_at": { - "description": "Creation time of the AuthN Mapping.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "modified_at": { - "description": "Time of last AuthN Mapping modification.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "saml_assertion_attribute_id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" - } - }, "type": "object" }, - "AuthNMappingCreateAttributes": { - "description": "Key/Value pair of attributes used for create request.", - "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" - }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" - } + "AWSAccountTags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" }, - "type": "object" + "nullable": true, + "type": "array" }, - "AuthNMappingCreateData": { - "description": "Data for creating an AuthN Mapping.", + "AWSAccountType": { + "default": "account", + "description": "AWS Account resource type.", + "enum": [ + "account" + ], + "example": "account", + "type": "string", + "x-enum-varnames": [ + "ACCOUNT" + ] + }, + "AWSAccountUpdateRequest": { + "description": "AWS Account Update Request body", "properties": { - "attributes": { - "description": "Key/Value pair of attributes used for create request.", + "data": { + "description": "AWS Account Update Request data", "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" - }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" - } - }, - "type": "object" - }, - "relationships": { - "description": "Relationship of AuthN Mapping create object to a Role or Team.", - "oneOf": [ - { - "description": "Relationship of AuthN Mapping to a Role.", + "attributes": { + "description": "The AWS Account Integration Config to be updated", "properties": { - "role": { - "description": "Relationship to role.", - "properties": { - "data": { - "description": "Relationship to role object.", + "account_tags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, "type": "string", - "x-enum-varnames": [ - "ROLES" - ] + "writeOnly": true } }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "role" - ], - "type": "object" - }, - { - "description": "Relationship of AuthN Mapping to a Team.", - "properties": { - "team": { - "description": "Relationship to team.", - "properties": { - "data": { - "description": "Relationship to Team object.", + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "external_id": { + "description": "AWS IAM External ID for associated role", "type": "string" }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "role_name" + ], + "type": "object" } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "team" - ], - "type": "object" - } - ] - }, - "type": { - "default": "authn_mappings", - "description": "AuthN Mappings resource type.", - "enum": [ - "authn_mappings" - ], - "example": "authn_mappings", - "type": "string", - "x-enum-varnames": [ - "AUTHN_MAPPINGS" - ] - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "AuthNMappingCreateRelationships": { - "description": "Relationship of AuthN Mapping create object to a Role or Team.", - "oneOf": [ - { - "description": "Relationship of AuthN Mapping to a Role.", - "properties": { - "role": { - "description": "Relationship to role.", - "properties": { - "data": { - "description": "Relationship to role object.", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" + ] + }, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" ] } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "role" - ], - "type": "object" - }, - { - "description": "Relationship of AuthN Mapping to a Team.", - "properties": { - "team": { - "description": "Relationship to team.", - "properties": { - "data": { - "description": "Relationship to Team object.", + ] + }, + "logs_config": { + "description": "AWS Logs config", "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" } }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "team" - ], - "type": "object" - } - ] - }, - "AuthNMappingCreateRequest": { - "description": "Request for creating an AuthN Mapping.", - "properties": { - "data": { - "description": "Data for creating an AuthN Mapping.", - "properties": { - "attributes": { - "description": "Key/Value pair of attributes used for create request.", - "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" + "type": "object" }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" - } - }, - "type": "object" - }, - "relationships": { - "description": "Relationship of AuthN Mapping create object to a Role or Team.", - "oneOf": [ - { - "description": "Relationship of AuthN Mapping to a Role.", + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "role": { - "description": "Relationship to role.", - "properties": { - "data": { - "description": "Relationship to role object.", + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", "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" + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" } }, - "required": [ - "role" - ], "type": "object" }, - { - "description": "Relationship of AuthN Mapping to a Team.", + "resources_config": { + "description": "AWS Resources config", "properties": { - "team": { - "description": "Relationship to team.", - "properties": { - "data": { - "description": "Relationship to Team object.", + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "include_only" + ] } - }, - "type": "object", - "x-merge-override": { - "required": false - } + ] } }, - "required": [ - "team" - ], "type": "object" } - ] + }, + "required": [ + "aws_account_id" + ], + "type": "object" + }, + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" }, "type": { - "default": "authn_mappings", - "description": "AuthN Mappings resource type.", + "default": "account", + "description": "AWS Account resource type.", "enum": [ - "authn_mappings" + "account" ], - "example": "authn_mappings", + "example": "account", "type": "string", "x-enum-varnames": [ - "AUTHN_MAPPINGS" + "ACCOUNT" ] } }, "required": [ + "attributes", "type" ], "type": "object" @@ -6005,1355 +5936,1663 @@ ], "type": "object" }, - "AuthNMappingIncluded": { - "description": "Included data in the AuthN Mapping response.", - "oneOf": [ - { - "description": "SAML assertion attribute.", - "properties": { - "attributes": { - "description": "Key/Value pair of attributes used in SAML assertion attributes.", + "AWSAccountUpdateRequestAttributes": { + "description": "The AWS Account Integration Config to be updated", + "properties": { + "account_tags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true } }, + "required": [ + "access_key_id" + ], "type": "object" }, - "id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" - }, - "type": { - "default": "saml_assertion_attributes", - "description": "SAML assertion attributes resource type.", - "enum": [ - "saml_assertion_attributes" - ], - "example": "saml_assertion_attributes", - "type": "string", - "x-enum-varnames": [ - "SAML_ASSERTION_ATTRIBUTES" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - { - "description": "Role object returned by the API.", - "properties": { - "attributes": { - "description": "Attributes of the role.", + { + "description": "AWS Authentication config for role-based account", "properties": { - "created_at": { - "description": "Creation time of the role.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "modified_at": { - "description": "Time of last role modification.", - "format": "date-time", - "readOnly": true, + "external_id": { + "description": "AWS IAM External ID for associated role", "type": "string" }, - "name": { - "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, "type": "string" - }, - "user_count": { - "description": "Number of users with that role.", - "format": "int64", - "readOnly": true, - "type": "integer" } }, + "required": [ + "role_name" + ], "type": "object" + } + ] + }, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] }, - "id": { - "description": "The unique identifier of the role.", - "type": "string" - }, - "relationships": { - "description": "Relationships of the role object returned by the API.", + { + "description": "Include only these regions", "properties": { - "permissions": { - "description": "Relationship to multiple permissions objects.", - "properties": { - "data": { - "description": "Relationships to permission objects.", - "items": { - "description": "Relationship to permission object.", - "properties": { - "id": { - "description": "ID of the permission.", - "type": "string" - }, - "type": { - "default": "permissions", - "description": "Permissions resource type.", - "enum": [ - "permissions" - ], - "example": "permissions", - "type": "string", - "x-enum-varnames": [ - "PERMISSIONS" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" } }, - "type": "object" - }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" + "required": [ + "include_only" ] } - }, - "required": [ - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + ] }, - { - "description": "Team.", + "logs_config": { + "description": "AWS Logs config", "properties": { - "attributes": { - "description": "Team attributes.", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, - "type": "string" - }, - "link_count": { - "description": "The number of links belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, - "type": "string" - }, - "summary": { - "description": "A brief summary of the team, derived from the `description`", - "maxLength": 120, - "nullable": true, - "type": "string" + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" }, - "user_count": { - "description": "The number of users belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, "type": "object" - }, - "id": { - "description": "The ID of the Team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] } }, "type": "object" - } - ] - }, - "AuthNMappingRelationshipToRole": { - "description": "Relationship of AuthN Mapping to a Role.", - "properties": { - "role": { - "description": "Relationship to role.", + }, + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "data": { - "description": "Relationship to role object.", - "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "role" - ], - "type": "object" - }, - "AuthNMappingRelationshipToTeam": { - "description": "Relationship of AuthN Mapping to a Team.", - "properties": { - "team": { - "description": "Relationship to team.", - "properties": { - "data": { - "description": "Relationship to Team object.", - "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "team" - ], - "type": "object" - }, - "AuthNMappingRelationships": { - "description": "All relationships associated with AuthN Mapping.", - "properties": { - "role": { - "description": "Relationship to role.", - "properties": { - "data": { - "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": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" ] } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, - "saml_assertion_attribute": { - "description": "AuthN Mapping relationship to SAML Assertion Attribute.", + "resources_config": { + "description": "AWS Resources config", "properties": { - "data": { - "description": "Data of AuthN Mapping relationship to SAML Assertion Attribute.", - "properties": { - "id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" - }, - "type": { - "default": "saml_assertion_attributes", - "description": "SAML assertion attributes resource type.", - "enum": [ - "saml_assertion_attributes" - ], - "example": "saml_assertion_attributes", - "type": "string", - "x-enum-varnames": [ - "SAML_ASSERTION_ATTRIBUTES" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" } }, - "required": [ - "data" - ], "type": "object" }, - "team": { - "description": "Relationship to team.", + "traces_config": { + "description": "AWS Traces config", "properties": { - "data": { - "description": "Relationship to Team object.", - "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" ] } - }, - "type": "object", - "x-merge-override": { - "required": false - } + ] } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, - "type": "object" - }, - "AuthNMappingResourceType": { - "description": "The type of resource being mapped to.", - "enum": [ - "role", - "team" + "required": [ + "aws_account_id" ], - "type": "string", - "x-enum-varnames": [ - "ROLE", - "TEAM" - ] + "type": "object" }, - "AuthNMappingResponse": { - "description": "AuthN Mapping response from the API.", + "AWSAccountUpdateRequestData": { + "description": "AWS Account Update Request data", "properties": { - "data": { - "description": "The AuthN Mapping object returned by API.", + "attributes": { + "description": "The AWS Account Integration Config to be updated", "properties": { - "attributes": { - "description": "Attributes of AuthN Mapping.", - "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" - }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" - }, - "created_at": { - "description": "Creation time of the AuthN Mapping.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "modified_at": { - "description": "Time of last AuthN Mapping modification.", - "format": "date-time", - "readOnly": true, - "type": "string" + "account_tags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" + ], + "type": "object" }, - "saml_assertion_attribute_id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" } - }, - "type": "object" + ] }, - "id": { - "description": "ID of the AuthN Mapping.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", "type": "string" }, - "relationships": { - "description": "All relationships associated with AuthN Mapping.", + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "logs_config": { + "description": "AWS Logs config", "properties": { - "role": { - "description": "Relationship to role.", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", "properties": { - "data": { - "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" - ] - } + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" + } + }, + "type": "object" + }, + "metrics_config": { + "description": "AWS Metrics config", + "properties": { + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" }, - "saml_assertion_attribute": { - "description": "AuthN Mapping relationship to SAML Assertion Attribute.", - "properties": { - "data": { - "description": "Data of AuthN Mapping relationship to SAML Assertion Attribute.", + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", "properties": { - "id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" - }, - "type": { - "default": "saml_assertion_attributes", - "description": "SAML assertion attributes resource type.", - "enum": [ - "saml_assertion_attributes" + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" ], - "example": "saml_assertion_attributes", - "type": "string", - "x-enum-varnames": [ - "SAML_ASSERTION_ATTRIBUTES" - ] + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" } }, "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] } - }, - "required": [ - "data" - ], - "type": "object" + ] }, - "team": { - "description": "Relationship to team.", - "properties": { - "data": { - "description": "Relationship to Team object.", - "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", "type": "string" }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" + "nullable": true, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "include_only" + ] } - }, - "type": "object", - "x-merge-override": { - "required": false - } + ] } }, "type": "object" - }, - "type": { - "default": "authn_mappings", - "description": "AuthN Mappings resource type.", - "enum": [ - "authn_mappings" - ], - "example": "authn_mappings", - "type": "string", - "x-enum-varnames": [ - "AUTHN_MAPPINGS" - ] } }, "required": [ - "id", - "type" + "aws_account_id" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, - "included": { - "description": "Included data in the AuthN Mapping response.", + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "type": { + "default": "account", + "description": "AWS Account resource type.", + "enum": [ + "account" + ], + "example": "account", + "type": "string", + "x-enum-varnames": [ + "ACCOUNT" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "AWSAccountsResponse": { + "description": "AWS Accounts response body", + "properties": { + "data": { + "description": "List of AWS Account Integration Configs", "items": { - "description": "Included data in the AuthN Mapping response.", - "oneOf": [ - { - "description": "SAML assertion attribute.", + "description": "AWS Account Response body", + "properties": { + "attributes": { + "description": "The AWS Account Integration Config", "properties": { - "attributes": { - "description": "Key/Value pair of attributes used in SAML assertion attributes.", - "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" + "account_tags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" + ], + "type": "object" }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" } - }, - "type": "object" + ] }, - "id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", "type": "string" }, - "type": { - "default": "saml_assertion_attributes", - "description": "SAML assertion attributes resource type.", + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", "enum": [ - "saml_assertion_attributes" + "aws", + "aws-cn", + "aws-us-gov" ], - "example": "saml_assertion_attributes", + "example": "aws", "type": "string", "x-enum-varnames": [ - "SAML_ASSERTION_ATTRIBUTES" + "AWS", + "AWS_CN", + "AWS_US_GOV" ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - { - "description": "Role object returned by the API.", - "properties": { - "attributes": { - "description": "Attributes of the role.", - "properties": { - "created_at": { - "description": "Creation time of the role.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "modified_at": { - "description": "Time of last role modification.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", - "type": "string" + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] }, - "user_count": { - "description": "Number of users with that role.", - "format": "int64", - "readOnly": true, - "type": "integer" + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] } - }, - "type": "object" + ] }, - "id": { - "description": "The unique identifier of the role.", + "created_at": { + "description": "Timestamp of when the account integration was created", + "format": "date-time", + "readOnly": true, "type": "string" }, - "relationships": { - "description": "Relationships of the role object returned by the API.", + "logs_config": { + "description": "AWS Logs config", "properties": { - "permissions": { - "description": "Relationship to multiple permissions objects.", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", "properties": { - "data": { - "description": "Relationships to permission objects.", + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", "items": { - "description": "Relationship to permission object.", - "properties": { - "id": { - "description": "ID of the permission.", - "type": "string" - }, - "type": { - "default": "permissions", - "description": "Permissions resource type.", - "enum": [ - "permissions" - ], - "example": "permissions", - "type": "string", - "x-enum-varnames": [ - "PERMISSIONS" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" }, "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, "type": "object" }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } - }, - "required": [ - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - { - "description": "Team.", - "properties": { - "attributes": { - "description": "Team attributes.", + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, - "type": "string" + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" }, - "link_count": { - "description": "The number of links belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, - "type": "string" + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" }, - "summary": { - "description": "A brief summary of the team, derived from the `description`", - "maxLength": 120, - "nullable": true, - "type": "string" + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] }, - "user_count": { - "description": "The number of users belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" } }, "type": "object" }, - "id": { - "description": "The ID of the Team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "modified_at": { + "description": "Timestamp of when the account integration was updated", + "format": "date-time", + "readOnly": true, "type": "string" }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + } + }, + "type": "object" } }, + "required": [ + "aws_account_id" + ], "type": "object" + }, + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "type": { + "default": "account", + "description": "AWS Account resource type.", + "enum": [ + "account" + ], + "example": "account", + "type": "string", + "x-enum-varnames": [ + "ACCOUNT" + ] } - ] + }, + "required": [ + "id", + "type" + ], + "type": "object" }, "type": "array" } }, + "required": [ + "data" + ], "type": "object" }, - "AuthNMappingTeam": { - "description": "Team.", - "properties": { - "attributes": { - "description": "Team attributes.", + "AWSAuthConfig": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, - "link_count": { - "description": "The number of links belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", "type": "string" }, - "summary": { - "description": "A brief summary of the team, derived from the `description`", - "maxLength": 120, - "nullable": true, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, "type": "string" - }, - "user_count": { - "description": "The number of users belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" } }, + "required": [ + "role_name" + ], "type": "object" - }, - "id": { - "description": "The ID of the Team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + } + ] + }, + "AWSAuthConfigKeys": { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, "type": "string", - "x-enum-varnames": [ - "TEAM" - ] + "writeOnly": true } }, + "required": [ + "access_key_id" + ], "type": "object" }, - "AuthNMappingTeamAttributes": { - "description": "Team attributes.", + "AWSAuthConfigRole": { + "description": "AWS Authentication config for role-based account", "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, + "external_id": { + "description": "AWS IAM External ID for associated role", "type": "string" }, - "link_count": { - "description": "The number of links belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, - "type": "string" - }, - "summary": { - "description": "A brief summary of the team, derived from the `description`", - "maxLength": 120, - "nullable": true, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, "type": "string" - }, - "user_count": { - "description": "The number of users belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" } }, + "required": [ + "role_name" + ], "type": "object" }, - "AuthNMappingUpdateAttributes": { - "description": "Key/Value pair of attributes used for update request.", + "AWSLambdaForwarderConfig": { + "description": "AWS Lambda forwarder", "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "AuthNMappingUpdateData": { - "description": "Data for updating an AuthN Mapping.", + "AWSLogsConfig": { + "description": "AWS Logs config", "properties": { - "attributes": { - "description": "Key/Value pair of attributes used for update request.", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, "type": "object" - }, - "id": { - "description": "ID of the AuthN Mapping.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" - }, - "relationships": { - "description": "Relationship of AuthN Mapping update object to a Role or Team.", - "oneOf": [ - { - "description": "Relationship of AuthN Mapping to a Role.", + } + }, + "type": "object" + }, + "AWSLogsServicesResponse": { + "description": "AWS Logs Services response body", + "properties": { + "data": { + "description": "AWS Logs Services response body", + "properties": { + "attributes": { + "description": "AWS Logs Services response body", "properties": { - "role": { - "description": "Relationship to role.", - "properties": { - "data": { - "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 - } - } + "logs_services": { + "description": "List of AWS services that can send logs to Datadog", + "example": [ + "s3" + ], + "items": { + "example": "s3", + "type": "string" }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" } }, "required": [ - "role" + "logs_services" ], "type": "object" }, - { - "description": "Relationship of AuthN Mapping to a Team.", - "properties": { - "team": { - "description": "Relationship to team.", - "properties": { - "data": { - "description": "Relationship to Team object.", - "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "team" + "id": { + "default": "logs_services", + "description": "The `AWSLogsServicesResponseData` `id`.", + "example": "logs_services", + "type": "string" + }, + "type": { + "default": "logs_services", + "description": "The `AWSLogsServicesResponseData` `type`.", + "enum": [ + "logs_services" ], - "type": "object" + "example": "logs_services", + "type": "string", + "x-enum-varnames": [ + "LOGS_SERVICES" + ] } - ] - }, - "type": { - "default": "authn_mappings", - "description": "AuthN Mappings resource type.", - "enum": [ - "authn_mappings" + }, + "required": [ + "id", + "type" ], - "example": "authn_mappings", - "type": "string", - "x-enum-varnames": [ - "AUTHN_MAPPINGS" - ] + "type": "object" } }, "required": [ - "id", - "type" + "data" ], "type": "object" }, - "AuthNMappingUpdateRelationships": { - "description": "Relationship of AuthN Mapping update object to a Role or Team.", - "oneOf": [ - { - "description": "Relationship of AuthN Mapping to a Role.", - "properties": { - "role": { - "description": "Relationship to role.", - "properties": { - "data": { - "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 - } - } + "AWSLogsServicesResponseAttributes": { + "description": "AWS Logs Services response body", + "properties": { + "logs_services": { + "description": "List of AWS services that can send logs to Datadog", + "example": [ + "s3" + ], + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "logs_services" + ], + "type": "object" + }, + "AWSLogsServicesResponseData": { + "description": "AWS Logs Services response body", + "properties": { + "attributes": { + "description": "AWS Logs Services response body", + "properties": { + "logs_services": { + "description": "List of AWS services that can send logs to Datadog", + "example": [ + "s3" + ], + "items": { + "example": "s3", + "type": "string" }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" } }, "required": [ - "role" + "logs_services" ], "type": "object" }, - { - "description": "Relationship of AuthN Mapping to a Team.", - "properties": { - "team": { - "description": "Relationship to team.", + "id": { + "default": "logs_services", + "description": "The `AWSLogsServicesResponseData` `id`.", + "example": "logs_services", + "type": "string" + }, + "type": { + "default": "logs_services", + "description": "The `AWSLogsServicesResponseData` `type`.", + "enum": [ + "logs_services" + ], + "example": "logs_services", + "type": "string", + "x-enum-varnames": [ + "LOGS_SERVICES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "AWSLogsServicesResponseDataType": { + "default": "logs_services", + "description": "The `AWSLogsServicesResponseData` `type`.", + "enum": [ + "logs_services" + ], + "example": "logs_services", + "type": "string", + "x-enum-varnames": [ + "LOGS_SERVICES" + ] + }, + "AWSMetricsConfig": { + "description": "AWS Metrics config", + "properties": { + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", "properties": { - "data": { - "description": "Relationship to Team object.", - "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "AWSNamespaceFilters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" } }, "required": [ - "team" + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "AWSNamespaceFiltersExcludeAll": { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + "AWSNamespaceFiltersExcludeOnly": { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" ], - "type": "object" + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" } + }, + "required": [ + "exclude_only" ] }, - "AuthNMappingUpdateRequest": { - "description": "Request to update an AuthN Mapping.", + "AWSNamespaceFiltersIncludeAll": { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + "AWSNamespaceFiltersIncludeOnly": { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + }, + "AWSNamespaceTagFilter": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + }, + "AWSNamespacesResponse": { + "description": "AWS Namespaces response body", "properties": { "data": { - "description": "Data for updating an AuthN Mapping.", + "description": "AWS Namespaces response body", "properties": { "attributes": { - "description": "Key/Value pair of attributes used for update request.", + "description": "AWS Namespaces response body", "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" - }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" + "namespaces": { + "description": "AWS CloudWatch namespace", + "example": [ + "AWS/ApiGateway" + ], + "items": { + "example": "AWS/ApiGateway", + "type": "string" + }, + "type": "array" } }, + "required": [ + "namespaces" + ], "type": "object" }, "id": { - "description": "ID of the AuthN Mapping.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "default": "namespaces", + "description": "The `AWSNamespacesResponseData` `id`.", + "example": "namespaces", "type": "string" }, - "relationships": { - "description": "Relationship of AuthN Mapping update object to a Role or Team.", - "oneOf": [ - { - "description": "Relationship of AuthN Mapping to a Role.", - "properties": { - "role": { - "description": "Relationship to role.", - "properties": { - "data": { - "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": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "role" - ], - "type": "object" - }, - { - "description": "Relationship of AuthN Mapping to a Team.", - "properties": { - "team": { - "description": "Relationship to team.", - "properties": { - "data": { - "description": "Relationship to Team object.", - "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "team" - ], - "type": "object" - } - ] - }, "type": { - "default": "authn_mappings", - "description": "AuthN Mappings resource type.", + "default": "namespaces", + "description": "The `AWSNamespacesResponseData` `type`.", "enum": [ - "authn_mappings" + "namespaces" ], - "example": "authn_mappings", + "example": "namespaces", "type": "string", "x-enum-varnames": [ - "AUTHN_MAPPINGS" + "NAMESPACES" ] } }, @@ -7369,771 +7608,130 @@ ], "type": "object" }, - "AuthNMappingsResponse": { - "description": "Array of AuthN Mappings response.", + "AWSNamespacesResponseAttributes": { + "description": "AWS Namespaces response body", "properties": { - "data": { - "description": "Array of returned AuthN Mappings.", - "items": { - "description": "The AuthN Mapping object returned by API.", - "properties": { - "attributes": { - "description": "Attributes of AuthN Mapping.", - "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" - }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" - }, - "created_at": { - "description": "Creation time of the AuthN Mapping.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "modified_at": { - "description": "Time of last AuthN Mapping modification.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "saml_assertion_attribute_id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "ID of the AuthN Mapping.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", - "type": "string" - }, - "relationships": { - "description": "All relationships associated with AuthN Mapping.", - "properties": { - "role": { - "description": "Relationship to role.", - "properties": { - "data": { - "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": "object", - "x-merge-override": { - "required": false - } - }, - "saml_assertion_attribute": { - "description": "AuthN Mapping relationship to SAML Assertion Attribute.", - "properties": { - "data": { - "description": "Data of AuthN Mapping relationship to SAML Assertion Attribute.", - "properties": { - "id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" - }, - "type": { - "default": "saml_assertion_attributes", - "description": "SAML assertion attributes resource type.", - "enum": [ - "saml_assertion_attributes" - ], - "example": "saml_assertion_attributes", - "type": "string", - "x-enum-varnames": [ - "SAML_ASSERTION_ATTRIBUTES" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "team": { - "description": "Relationship to team.", - "properties": { - "data": { - "description": "Relationship to Team object.", - "properties": { - "id": { - "description": "The unique identifier of the team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object" - }, - "type": { - "default": "authn_mappings", - "description": "AuthN Mappings resource type.", - "enum": [ - "authn_mappings" - ], - "example": "authn_mappings", - "type": "string", - "x-enum-varnames": [ - "AUTHN_MAPPINGS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - }, - "included": { - "description": "Included data in the AuthN Mapping response.", + "namespaces": { + "description": "AWS CloudWatch namespace", + "example": [ + "AWS/ApiGateway" + ], "items": { - "description": "Included data in the AuthN Mapping response.", - "oneOf": [ - { - "description": "SAML assertion attribute.", - "properties": { - "attributes": { - "description": "Key/Value pair of attributes used in SAML assertion attributes.", - "properties": { - "attribute_key": { - "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "member-of", - "type": "string" - }, - "attribute_value": { - "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", - "example": "Development", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "The ID of the SAML assertion attribute.", - "example": "0", - "type": "string" - }, - "type": { - "default": "saml_assertion_attributes", - "description": "SAML assertion attributes resource type.", - "enum": [ - "saml_assertion_attributes" - ], - "example": "saml_assertion_attributes", - "type": "string", - "x-enum-varnames": [ - "SAML_ASSERTION_ATTRIBUTES" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - { - "description": "Role object returned by the API.", - "properties": { - "attributes": { - "description": "Attributes of the role.", - "properties": { - "created_at": { - "description": "Creation time of the role.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "modified_at": { - "description": "Time of last role modification.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", - "type": "string" - }, - "user_count": { - "description": "Number of users with that role.", - "format": "int64", - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "id": { - "description": "The unique identifier of the role.", - "type": "string" - }, - "relationships": { - "description": "Relationships of the role object returned by the API.", - "properties": { - "permissions": { - "description": "Relationship to multiple permissions objects.", - "properties": { - "data": { - "description": "Relationships to permission objects.", - "items": { - "description": "Relationship to permission object.", - "properties": { - "id": { - "description": "ID of the permission.", - "type": "string" - }, - "type": { - "default": "permissions", - "description": "Permissions resource type.", - "enum": [ - "permissions" - ], - "example": "permissions", - "type": "string", - "x-enum-varnames": [ - "PERMISSIONS" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "type": "object" - }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } - }, - "required": [ - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - { - "description": "Team.", - "properties": { - "attributes": { - "description": "Team attributes.", - "properties": { - "avatar": { - "description": "Unicode representation of the avatar for the team, limited to a single grapheme", - "example": "🥑", - "nullable": true, - "type": "string" - }, - "banner": { - "description": "Banner selection for the team", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "handle": { - "description": "The team's identifier", - "example": "example-team", - "maxLength": 195, - "type": "string" - }, - "link_count": { - "description": "The number of links belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - }, - "name": { - "description": "The name of the team", - "example": "Example Team", - "maxLength": 200, - "type": "string" - }, - "summary": { - "description": "A brief summary of the team, derived from the `description`", - "maxLength": 120, - "nullable": true, - "type": "string" - }, - "user_count": { - "description": "The number of users belonging to the team", - "format": "int32", - "maximum": 2147483647, - "readOnly": true, - "type": "integer" - } - }, - "type": "object" - }, - "id": { - "description": "The ID of the Team.", - "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", - "type": "string" - }, - "type": { - "default": "team", - "description": "Team type", - "enum": [ - "team" - ], - "example": "team", - "type": "string", - "x-enum-varnames": [ - "TEAM" - ] - } - }, - "type": "object" - } - ] + "example": "AWS/ApiGateway", + "type": "string" }, "type": "array" - }, - "meta": { - "description": "Object describing meta attributes of response.", - "properties": { - "page": { - "description": "Pagination object.", - "properties": { - "total_count": { - "description": "Total count.", - "format": "int64", - "type": "integer" - }, - "total_filtered_count": { - "description": "Total count of elements matched by the filter.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - } - }, - "type": "object", - "x-merge-override": { - "properties": false - } } }, - "type": "object" - }, - "AuthNMappingsSort": { - "description": "Sorting options for AuthN Mappings.", - "enum": [ - "created_at", - "-created_at", - "role_id", - "-role_id", - "saml_assertion_attribute_id", - "-saml_assertion_attribute_id", - "role.name", - "-role.name", - "saml_assertion_attribute.attribute_key", - "-saml_assertion_attribute.attribute_key", - "saml_assertion_attribute.attribute_value", - "-saml_assertion_attribute.attribute_value" - ], - "type": "string", - "x-enum-varnames": [ - "CREATED_AT_ASCENDING", - "CREATED_AT_DESCENDING", - "ROLE_ID_ASCENDING", - "ROLE_ID_DESCENDING", - "SAML_ASSERTION_ATTRIBUTE_ID_ASCENDING", - "SAML_ASSERTION_ATTRIBUTE_ID_DESCENDING", - "ROLE_NAME_ASCENDING", - "ROLE_NAME_DESCENDING", - "SAML_ASSERTION_ATTRIBUTE_KEY_ASCENDING", - "SAML_ASSERTION_ATTRIBUTE_KEY_DESCENDING", - "SAML_ASSERTION_ATTRIBUTE_VALUE_ASCENDING", - "SAML_ASSERTION_ATTRIBUTE_VALUE_DESCENDING" - ] - }, - "AuthNMappingsType": { - "default": "authn_mappings", - "description": "AuthN Mappings resource type.", - "enum": [ - "authn_mappings" + "required": [ + "namespaces" ], - "example": "authn_mappings", - "type": "string", - "x-enum-varnames": [ - "AUTHN_MAPPINGS" - ] + "type": "object" }, - "AwsCURConfig": { - "description": "AWS CUR config.", + "AWSNamespacesResponseData": { + "description": "AWS Namespaces response body", "properties": { "attributes": { - "description": "Attributes for An AWS CUR config.", + "description": "AWS Namespaces response body", "properties": { - "account_id": { - "description": "The AWS account ID.", - "example": "123456789123", - "type": "string" - }, - "bucket_name": { - "description": "The AWS bucket name used to store the Cost and Usage Report.", - "example": "dd-cost-bucket", - "type": "string" - }, - "bucket_region": { - "description": "The region the bucket is located in.", - "example": "us-east-1", - "type": "string" - }, - "created_at": { - "description": "The timestamp when the AWS CUR config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "error_messages": { - "description": "The error messages for the AWS CUR config.", + "namespaces": { + "description": "AWS CloudWatch namespace", + "example": [ + "AWS/ApiGateway" + ], "items": { + "example": "AWS/ApiGateway", "type": "string" }, "type": "array" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "report_name": { - "description": "The name of the Cost and Usage Report.", - "example": "dd-report-name", - "type": "string" - }, - "report_prefix": { - "description": "The report prefix used for the Cost and Usage Report.", - "example": "dd-report-prefix", - "type": "string" - }, - "status": { - "description": "The status of the AWS CUR.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the AWS CUR config status was updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "updated_at": { - "description": "The timestamp when the AWS CUR config status was updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } } }, "required": [ - "account_id", - "bucket_name", - "bucket_region", - "report_name", - "report_prefix", - "status" + "namespaces" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, "id": { - "description": "The ID of the AWS CUR config.", - "format": "int64", - "type": "integer" + "default": "namespaces", + "description": "The `AWSNamespacesResponseData` `id`.", + "example": "namespaces", + "type": "string" }, "type": { - "default": "aws_cur_config", - "description": "Type of AWS CUR config.", + "default": "namespaces", + "description": "The `AWSNamespacesResponseData` `type`.", "enum": [ - "aws_cur_config" + "namespaces" ], - "example": "aws_cur_config", + "example": "namespaces", "type": "string", "x-enum-varnames": [ - "AWS_CUR_CONFIG" + "NAMESPACES" ] } }, "required": [ - "attributes", + "id", "type" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, - "AwsCURConfigAttributes": { - "description": "Attributes for An AWS CUR config.", - "properties": { - "account_id": { - "description": "The AWS account ID.", - "example": "123456789123", - "type": "string" - }, - "bucket_name": { - "description": "The AWS bucket name used to store the Cost and Usage Report.", - "example": "dd-cost-bucket", - "type": "string" - }, - "bucket_region": { - "description": "The region the bucket is located in.", - "example": "us-east-1", - "type": "string" - }, - "created_at": { - "description": "The timestamp when the AWS CUR config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "error_messages": { - "description": "The error messages for the AWS CUR config.", - "items": { - "type": "string" - }, - "type": "array" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "report_name": { - "description": "The name of the Cost and Usage Report.", - "example": "dd-report-name", - "type": "string" - }, - "report_prefix": { - "description": "The report prefix used for the Cost and Usage Report.", - "example": "dd-report-prefix", - "type": "string" - }, - "status": { - "description": "The status of the AWS CUR.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the AWS CUR config status was updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "updated_at": { - "description": "The timestamp when the AWS CUR config status was updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - } - }, - "required": [ - "account_id", - "bucket_name", - "bucket_region", - "report_name", - "report_prefix", - "status" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "AwsCURConfigPatchData": { - "description": "AWS CUR config Patch data.", - "properties": { - "attributes": { - "description": "Attributes for AWS CUR config Patch Request.", - "properties": { - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "example": true, - "type": "boolean" - } - }, - "required": [ - "is_enabled" - ], - "type": "object" - }, - "type": { - "default": "aws_cur_config_patch_request", - "description": "Type of AWS CUR config Patch Request.", - "enum": [ - "aws_cur_config_patch_request" - ], - "example": "aws_cur_config_patch_request", - "type": "string", - "x-enum-varnames": [ - "AWS_CUR_CONFIG_PATCH_REQUEST" - ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "AwsCURConfigPatchRequest": { - "description": "AWS CUR config Patch Request.", + "AWSNamespacesResponseDataType": { + "default": "namespaces", + "description": "The `AWSNamespacesResponseData` `type`.", + "enum": [ + "namespaces" + ], + "example": "namespaces", + "type": "string", + "x-enum-varnames": [ + "NAMESPACES" + ] + }, + "AWSNewExternalIDResponse": { + "description": "AWS External ID response body", "properties": { "data": { - "description": "AWS CUR config Patch data.", + "description": "AWS External ID response body", "properties": { "attributes": { - "description": "Attributes for AWS CUR config Patch Request.", + "description": "AWS External ID response body", "properties": { - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "example": true, - "type": "boolean" + "external_id": { + "description": "AWS IAM External ID for associated role", + "example": "acb8f6b8a844443dbb726d07dcb1a870", + "type": "string" } }, "required": [ - "is_enabled" + "external_id" ], "type": "object" }, + "id": { + "default": "external_id", + "description": "The `AWSNewExternalIDResponseData` `id`.", + "example": "external_id", + "type": "string" + }, "type": { - "default": "aws_cur_config_patch_request", - "description": "Type of AWS CUR config Patch Request.", + "default": "external_id", + "description": "The `AWSNewExternalIDResponseData` `type`.", "enum": [ - "aws_cur_config_patch_request" + "external_id" ], - "example": "aws_cur_config_patch_request", + "example": "external_id", "type": "string", "x-enum-varnames": [ - "AWS_CUR_CONFIG_PATCH_REQUEST" + "EXTERNAL_ID" ] } }, "required": [ - "attributes", + "id", "type" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, "required": [ @@ -8141,751 +7739,415 @@ ], "type": "object" }, - "AwsCURConfigPatchRequestAttributes": { - "description": "Attributes for AWS CUR config Patch Request.", + "AWSNewExternalIDResponseAttributes": { + "description": "AWS External ID response body", "properties": { - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "example": true, - "type": "boolean" + "external_id": { + "description": "AWS IAM External ID for associated role", + "example": "acb8f6b8a844443dbb726d07dcb1a870", + "type": "string" } }, "required": [ - "is_enabled" + "external_id" ], "type": "object" }, - "AwsCURConfigPatchRequestType": { - "default": "aws_cur_config_patch_request", - "description": "Type of AWS CUR config Patch Request.", - "enum": [ - "aws_cur_config_patch_request" - ], - "example": "aws_cur_config_patch_request", - "type": "string", - "x-enum-varnames": [ - "AWS_CUR_CONFIG_PATCH_REQUEST" - ] - }, - "AwsCURConfigPostData": { - "description": "AWS CUR config Post data.", + "AWSNewExternalIDResponseData": { + "description": "AWS External ID response body", "properties": { "attributes": { - "description": "Attributes for AWS CUR config Post Request.", + "description": "AWS External ID response body", "properties": { - "account_id": { - "description": "The AWS account ID.", - "example": "123456789123", - "type": "string" - }, - "bucket_name": { - "description": "The AWS bucket name used to store the Cost and Usage Report.", - "example": "dd-cost-bucket", - "type": "string" - }, - "bucket_region": { - "description": "The region the bucket is located in.", - "example": "us-east-1", - "type": "string" - }, - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "type": "boolean" - }, - "months": { - "description": "The month of the report.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "report_name": { - "description": "The name of the Cost and Usage Report.", - "example": "dd-report-name", - "type": "string" - }, - "report_prefix": { - "description": "The report prefix used for the Cost and Usage Report.", - "example": "dd-report-prefix", + "external_id": { + "description": "AWS IAM External ID for associated role", + "example": "acb8f6b8a844443dbb726d07dcb1a870", "type": "string" } }, "required": [ - "account_id", - "bucket_name", - "report_name", - "report_prefix" + "external_id" ], "type": "object" }, + "id": { + "default": "external_id", + "description": "The `AWSNewExternalIDResponseData` `id`.", + "example": "external_id", + "type": "string" + }, "type": { - "default": "aws_cur_config_post_request", - "description": "Type of AWS CUR config Post Request.", + "default": "external_id", + "description": "The `AWSNewExternalIDResponseData` `type`.", "enum": [ - "aws_cur_config_post_request" + "external_id" ], - "example": "aws_cur_config_post_request", + "example": "external_id", "type": "string", "x-enum-varnames": [ - "AWS_CUR_CONFIG_POST_REQUEST" + "EXTERNAL_ID" ] } }, "required": [ - "attributes", + "id", "type" ], "type": "object" }, - "AwsCURConfigPostRequest": { - "description": "AWS CUR config Post Request.", - "properties": { - "data": { - "description": "AWS CUR config Post data.", + "AWSNewExternalIDResponseDataType": { + "default": "external_id", + "description": "The `AWSNewExternalIDResponseData` `type`.", + "enum": [ + "external_id" + ], + "example": "external_id", + "type": "string", + "x-enum-varnames": [ + "EXTERNAL_ID" + ] + }, + "AWSRegions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", "properties": { - "attributes": { - "description": "Attributes for AWS CUR config Post Request.", + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "AWSRegionsIncludeAll": { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + "AWSRegionsIncludeOnly": { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + }, + "AWSResourcesConfig": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "AWSTracesConfig": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", "properties": { - "account_id": { - "description": "The AWS account ID.", - "example": "123456789123", - "type": "string" - }, - "bucket_name": { - "description": "The AWS bucket name used to store the Cost and Usage Report.", - "example": "dd-cost-bucket", - "type": "string" - }, - "bucket_region": { - "description": "The region the bucket is located in.", - "example": "us-east-1", - "type": "string" - }, - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", + "include_all": { + "description": "Include all services", + "example": false, "type": "boolean" - }, - "months": { - "description": "The month of the report.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "report_name": { - "description": "The name of the Cost and Usage Report.", - "example": "dd-report-name", - "type": "string" - }, - "report_prefix": { - "description": "The report prefix used for the Cost and Usage Report.", - "example": "dd-report-prefix", - "type": "string" } }, "required": [ - "account_id", - "bucket_name", - "report_name", - "report_prefix" - ], - "type": "object" + "include_all" + ] }, - "type": { - "default": "aws_cur_config_post_request", - "description": "Type of AWS CUR config Post Request.", - "enum": [ - "aws_cur_config_post_request" - ], - "example": "aws_cur_config_post_request", - "type": "string", - "x-enum-varnames": [ - "AWS_CUR_CONFIG_POST_REQUEST" + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" ] } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" + ] } }, - "required": [ - "data" - ], "type": "object" }, - "AwsCURConfigPostRequestAttributes": { - "description": "Attributes for AWS CUR config Post Request.", + "ActiveBillingDimensionsAttributes": { + "description": "List of active billing dimensions.", "properties": { - "account_id": { - "description": "The AWS account ID.", - "example": "123456789123", - "type": "string" - }, - "bucket_name": { - "description": "The AWS bucket name used to store the Cost and Usage Report.", - "example": "dd-cost-bucket", - "type": "string" - }, - "bucket_region": { - "description": "The region the bucket is located in.", - "example": "us-east-1", + "month": { + "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.", + "format": "date-time", "type": "string" }, - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "type": "boolean" - }, - "months": { - "description": "The month of the report.", - "format": "int32", - "maximum": 36, - "type": "integer" + "values": { + "description": "List of active billing dimensions. Example: `[infra_host, apm_host, serverless_infra]`.", + "items": { + "description": "A given billing dimension in a list.", + "example": "infra_host", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ActiveBillingDimensionsBody": { + "description": "Active billing dimensions data.", + "properties": { + "attributes": { + "description": "List of active billing dimensions.", + "properties": { + "month": { + "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.", + "format": "date-time", + "type": "string" + }, + "values": { + "description": "List of active billing dimensions. Example: `[infra_host, apm_host, serverless_infra]`.", + "items": { + "description": "A given billing dimension in a list.", + "example": "infra_host", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" }, - "report_name": { - "description": "The name of the Cost and Usage Report.", - "example": "dd-report-name", + "id": { + "description": "Unique ID of the response.", "type": "string" }, - "report_prefix": { - "description": "The report prefix used for the Cost and Usage Report.", - "example": "dd-report-prefix", - "type": "string" + "type": { + "default": "billing_dimensions", + "description": "Type of active billing dimensions data.", + "enum": [ + "billing_dimensions" + ], + "type": "string", + "x-enum-varnames": [ + "BILLING_DIMENSIONS" + ] } }, - "required": [ - "account_id", - "bucket_name", - "report_name", - "report_prefix" - ], "type": "object" }, - "AwsCURConfigPostRequestType": { - "default": "aws_cur_config_post_request", - "description": "Type of AWS CUR config Post Request.", - "enum": [ - "aws_cur_config_post_request" - ], - "example": "aws_cur_config_post_request", - "type": "string", - "x-enum-varnames": [ - "AWS_CUR_CONFIG_POST_REQUEST" - ] - }, - "AwsCURConfigResponse": { - "description": "Response of AWS CUR config.", + "ActiveBillingDimensionsResponse": { + "description": "Active billing dimensions response.", "properties": { "data": { - "description": "AWS CUR config.", + "description": "Active billing dimensions data.", "properties": { "attributes": { - "description": "Attributes for An AWS CUR config.", + "description": "List of active billing dimensions.", "properties": { - "account_id": { - "description": "The AWS account ID.", - "example": "123456789123", - "type": "string" - }, - "bucket_name": { - "description": "The AWS bucket name used to store the Cost and Usage Report.", - "example": "dd-cost-bucket", - "type": "string" - }, - "bucket_region": { - "description": "The region the bucket is located in.", - "example": "us-east-1", + "month": { + "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.", + "format": "date-time", "type": "string" }, - "created_at": { - "description": "The timestamp when the AWS CUR config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "error_messages": { - "description": "The error messages for the AWS CUR config.", + "values": { + "description": "List of active billing dimensions. Example: `[infra_host, apm_host, serverless_infra]`.", "items": { + "description": "A given billing dimension in a list.", + "example": "infra_host", "type": "string" }, "type": "array" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "report_name": { - "description": "The name of the Cost and Usage Report.", - "example": "dd-report-name", - "type": "string" - }, - "report_prefix": { - "description": "The report prefix used for the Cost and Usage Report.", - "example": "dd-report-prefix", - "type": "string" - }, - "status": { - "description": "The status of the AWS CUR.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the AWS CUR config status was updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "updated_at": { - "description": "The timestamp when the AWS CUR config status was updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } } }, - "required": [ - "account_id", - "bucket_name", - "bucket_region", - "report_name", - "report_prefix", - "status" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, "id": { - "description": "The ID of the AWS CUR config.", - "format": "int64", - "type": "integer" + "description": "Unique ID of the response.", + "type": "string" }, "type": { - "default": "aws_cur_config", - "description": "Type of AWS CUR config.", + "default": "billing_dimensions", + "description": "Type of active billing dimensions data.", "enum": [ - "aws_cur_config" + "billing_dimensions" ], - "example": "aws_cur_config", "type": "string", "x-enum-varnames": [ - "AWS_CUR_CONFIG" + "BILLING_DIMENSIONS" ] } }, - "required": [ - "attributes", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, "type": "object" }, - "AwsCURConfigType": { - "default": "aws_cur_config", - "description": "Type of AWS CUR config.", + "ActiveBillingDimensionsType": { + "default": "billing_dimensions", + "description": "Type of active billing dimensions data.", "enum": [ - "aws_cur_config" + "billing_dimensions" ], - "example": "aws_cur_config", "type": "string", "x-enum-varnames": [ - "AWS_CUR_CONFIG" + "BILLING_DIMENSIONS" ] }, - "AwsCURConfigsResponse": { - "description": "List of AWS CUR configs.", - "properties": { - "data": { - "description": "An AWS CUR config.", - "items": { - "description": "AWS CUR config.", - "properties": { - "attributes": { - "description": "Attributes for An AWS CUR config.", - "properties": { - "account_id": { - "description": "The AWS account ID.", - "example": "123456789123", - "type": "string" - }, - "bucket_name": { - "description": "The AWS bucket name used to store the Cost and Usage Report.", - "example": "dd-cost-bucket", - "type": "string" - }, - "bucket_region": { - "description": "The region the bucket is located in.", - "example": "us-east-1", - "type": "string" - }, - "created_at": { - "description": "The timestamp when the AWS CUR config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "error_messages": { - "description": "The error messages for the AWS CUR config.", - "items": { - "type": "string" - }, - "type": "array" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "report_name": { - "description": "The name of the Cost and Usage Report.", - "example": "dd-report-name", - "type": "string" - }, - "report_prefix": { - "description": "The report prefix used for the Cost and Usage Report.", - "example": "dd-report-prefix", - "type": "string" - }, - "status": { - "description": "The status of the AWS CUR.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the AWS CUR config status was updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "updated_at": { - "description": "The timestamp when the AWS CUR config status was updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - } - }, - "required": [ - "account_id", - "bucket_name", - "bucket_region", - "report_name", - "report_prefix", - "status" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "id": { - "description": "The ID of the AWS CUR config.", - "format": "int64", - "type": "integer" - }, - "type": { - "default": "aws_cur_config", - "description": "Type of AWS CUR config.", - "enum": [ - "aws_cur_config" - ], - "example": "aws_cur_config", - "type": "string", - "x-enum-varnames": [ - "AWS_CUR_CONFIG" - ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "type": "object" + "ApiID": { + "description": "API identifier.", + "example": "90646597-5fdb-4a17-a240-647003f8c028", + "format": "uuid", + "type": "string" }, - "AzureUCConfig": { - "description": "Azure config.", + "ApmRetentionFilterType": { + "default": "apm_retention_filter", + "description": "The type of the resource.", + "enum": [ + "apm_retention_filter" + ], + "example": "apm_retention_filter", + "type": "string", + "x-enum-varnames": [ + "apm_retention_filter" + ] + }, + "ApplicationKeyCreateAttributes": { + "description": "Attributes used to create an application Key.", "properties": { - "account_id": { - "description": "The tenant ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "client_id": { - "description": "The client ID of the Azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "created_at": { - "description": "The timestamp when the Azure config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "dataset_type": { - "description": "The dataset type of the Azure config.", - "example": "actual", + "name": { + "description": "Name of the application key.", + "example": "Application Key for managing dashboards", "type": "string" }, - "error_messages": { - "description": "The error messages for the Azure config.", + "scopes": { + "description": "Array of scopes to grant the application key.", + "example": [ + "dashboards_read", + "dashboards_write", + "dashboards_public_share" + ], "items": { + "description": "Name of scope.", "type": "string" }, + "nullable": true, "type": "array" - }, - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "id": { - "description": "The ID of the Azure config.", - "format": "int64", - "type": "integer" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "scope": { - "description": "The scope of your observed subscription.", - "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "status": { - "description": "The status of the Azure config.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the Azure config status was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - }, - "updated_at": { - "description": "The timestamp when the Azure config was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } } }, "required": [ - "account_id", - "client_id", - "dataset_type", - "export_name", - "export_path", - "scope", - "status", - "storage_account", - "storage_container" + "name" ], "type": "object", "x-merge-override": { - "required": false + "properties": false } }, - "AzureUCConfigPair": { - "description": "Azure config pair.", + "ApplicationKeyCreateData": { + "description": "Object used to create an application key.", "properties": { "attributes": { - "description": "Attributes for Azure config pair.", + "description": "Attributes used to create an application Key.", "properties": { - "configs": { - "description": "An Azure config.", + "name": { + "description": "Name of the application key.", + "example": "Application Key for managing dashboards", + "type": "string" + }, + "scopes": { + "description": "Array of scopes to grant the application key.", + "example": [ + "dashboards_read", + "dashboards_write", + "dashboards_public_share" + ], "items": { - "description": "Azure config.", - "properties": { - "account_id": { - "description": "The tenant ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "client_id": { - "description": "The client ID of the Azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "created_at": { - "description": "The timestamp when the Azure config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "dataset_type": { - "description": "The dataset type of the Azure config.", - "example": "actual", - "type": "string" - }, - "error_messages": { - "description": "The error messages for the Azure config.", - "items": { - "type": "string" - }, - "type": "array" - }, - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "id": { - "description": "The ID of the Azure config.", - "format": "int64", - "type": "integer" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "scope": { - "description": "The scope of your observed subscription.", - "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "status": { - "description": "The status of the Azure config.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the Azure config status was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - }, - "updated_at": { - "description": "The timestamp when the Azure config was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - } - }, - "required": [ - "account_id", - "client_id", - "dataset_type", - "export_name", - "export_path", - "scope", - "status", - "storage_account", - "storage_container" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "description": "Name of scope.", + "type": "string" }, + "nullable": true, "type": "array" - }, - "id": { - "description": "The ID of the Azure config pair.", - "format": "int64", - "type": "integer" } }, "required": [ - "configs" + "name" ], "type": "object", "x-merge-override": { "properties": false } }, - "id": { - "description": "The ID of Cloud Cost Management account.", - "format": "int64", - "type": "integer" - }, "type": { - "default": "azure_uc_configs", - "description": "Type of Azure config pair.", + "default": "application_keys", + "description": "Application Keys resource type.", "enum": [ - "azure_uc_configs" + "application_keys" ], - "example": "azure_uc_configs", + "example": "application_keys", "type": "string", "x-enum-varnames": [ - "AZURE_UC_CONFIGS" + "APPLICATION_KEYS" ] } }, @@ -8898,297 +8160,53 @@ "required": false } }, - "AzureUCConfigPairAttributes": { - "description": "Attributes for Azure config pair.", + "ApplicationKeyCreateRequest": { + "description": "Request used to create an application key.", "properties": { - "configs": { - "description": "An Azure config.", - "items": { - "description": "Azure config.", - "properties": { - "account_id": { - "description": "The tenant ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "client_id": { - "description": "The client ID of the Azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "created_at": { - "description": "The timestamp when the Azure config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "dataset_type": { - "description": "The dataset type of the Azure config.", - "example": "actual", - "type": "string" - }, - "error_messages": { - "description": "The error messages for the Azure config.", - "items": { + "data": { + "description": "Object used to create an application key.", + "properties": { + "attributes": { + "description": "Attributes used to create an application Key.", + "properties": { + "name": { + "description": "Name of the application key.", + "example": "Application Key for managing dashboards", "type": "string" }, - "type": "array" - }, - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "id": { - "description": "The ID of the Azure config.", - "format": "int64", - "type": "integer" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "scope": { - "description": "The scope of your observed subscription.", - "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "status": { - "description": "The status of the Azure config.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the Azure config status was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - }, - "updated_at": { - "description": "The timestamp when the Azure config was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - } - }, - "required": [ - "account_id", - "client_id", - "dataset_type", - "export_name", - "export_path", - "scope", - "status", - "storage_account", - "storage_container" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - }, - "id": { - "description": "The ID of the Azure config pair.", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "configs" - ], - "type": "object", - "x-merge-override": { - "properties": false - } - }, - "AzureUCConfigPairType": { - "default": "azure_uc_configs", - "description": "Type of Azure config pair.", - "enum": [ - "azure_uc_configs" - ], - "example": "azure_uc_configs", - "type": "string", - "x-enum-varnames": [ - "AZURE_UC_CONFIGS" - ] - }, - "AzureUCConfigPairsResponse": { - "description": "Response of Azure config pair.", - "properties": { - "data": { - "description": "Azure config pair.", - "properties": { - "attributes": { - "description": "Attributes for Azure config pair.", - "properties": { - "configs": { - "description": "An Azure config.", - "items": { - "description": "Azure config.", - "properties": { - "account_id": { - "description": "The tenant ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "client_id": { - "description": "The client ID of the Azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "created_at": { - "description": "The timestamp when the Azure config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "dataset_type": { - "description": "The dataset type of the Azure config.", - "example": "actual", - "type": "string" - }, - "error_messages": { - "description": "The error messages for the Azure config.", - "items": { - "type": "string" - }, - "type": "array" - }, - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "id": { - "description": "The ID of the Azure config.", - "format": "int64", - "type": "integer" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "scope": { - "description": "The scope of your observed subscription.", - "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "status": { - "description": "The status of the Azure config.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the Azure config status was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - }, - "updated_at": { - "description": "The timestamp when the Azure config was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - } - }, - "required": [ - "account_id", - "client_id", - "dataset_type", - "export_name", - "export_path", - "scope", - "status", - "storage_account", - "storage_container" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - }, - "id": { - "description": "The ID of the Azure config pair.", - "format": "int64", - "type": "integer" - } + "scopes": { + "description": "Array of scopes to grant the application key.", + "example": [ + "dashboards_read", + "dashboards_write", + "dashboards_public_share" + ], + "items": { + "description": "Name of scope.", + "type": "string" + }, + "nullable": true, + "type": "array" + } }, "required": [ - "configs" + "name" ], "type": "object", "x-merge-override": { "properties": false } }, - "id": { - "description": "The ID of Cloud Cost Management account.", - "format": "int64", - "type": "integer" - }, "type": { - "default": "azure_uc_configs", - "description": "Type of Azure config pair.", + "default": "application_keys", + "description": "Application Keys resource type.", "enum": [ - "azure_uc_configs" + "application_keys" ], - "example": "azure_uc_configs", + "example": "application_keys", "type": "string", "x-enum-varnames": [ - "AZURE_UC_CONFIGS" + "APPLICATION_KEYS" ] } }, @@ -9202,1405 +8220,1183 @@ } } }, - "type": "object" - }, - "AzureUCConfigPatchData": { - "description": "Azure config Patch data.", - "properties": { - "attributes": { - "description": "Attributes for Azure config Patch Request.", - "properties": { - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "example": true, - "type": "boolean" - } - }, - "required": [ - "is_enabled" - ], - "type": "object" - }, - "type": { - "default": "azure_uc_config_patch_request", - "description": "Type of Azure config Patch Request.", - "enum": [ - "azure_uc_config_patch_request" - ], - "example": "azure_uc_config_patch_request", - "type": "string", - "x-enum-varnames": [ - "AZURE_UC_CONFIG_PATCH_REQUEST" - ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - }, - "AzureUCConfigPatchRequest": { - "description": "Azure config Patch Request.", - "properties": { - "data": { - "description": "Azure config Patch data.", - "properties": { - "attributes": { - "description": "Attributes for Azure config Patch Request.", - "properties": { - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "example": true, - "type": "boolean" - } - }, - "required": [ - "is_enabled" - ], - "type": "object" - }, - "type": { - "default": "azure_uc_config_patch_request", - "description": "Type of Azure config Patch Request.", - "enum": [ - "azure_uc_config_patch_request" - ], - "example": "azure_uc_config_patch_request", - "type": "string", - "x-enum-varnames": [ - "AZURE_UC_CONFIG_PATCH_REQUEST" - ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - } - }, "required": [ "data" ], "type": "object" }, - "AzureUCConfigPatchRequestAttributes": { - "description": "Attributes for Azure config Patch Request.", - "properties": { - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "example": true, - "type": "boolean" - } - }, - "required": [ - "is_enabled" - ], - "type": "object" - }, - "AzureUCConfigPatchRequestType": { - "default": "azure_uc_config_patch_request", - "description": "Type of Azure config Patch Request.", - "enum": [ - "azure_uc_config_patch_request" - ], - "example": "azure_uc_config_patch_request", - "type": "string", - "x-enum-varnames": [ - "AZURE_UC_CONFIG_PATCH_REQUEST" - ] - }, - "AzureUCConfigPostData": { - "description": "Azure config Post data.", + "ApplicationKeyRelationships": { + "description": "Resources related to the application key.", "properties": { - "attributes": { - "description": "Attributes for Azure config Post Request.", + "owned_by": { + "description": "Relationship to user.", "properties": { - "account_id": { - "description": "The tenant ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "actual_bill_config": { - "description": "Bill config.", - "properties": { - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - } - }, - "required": [ - "export_name", - "export_path", - "storage_account", - "storage_container" - ], - "type": "object" - }, - "amortized_bill_config": { - "description": "Bill config.", + "data": { + "description": "Relationship to user object.", "properties": { - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", "type": "string" }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] } }, "required": [ - "export_name", - "export_path", - "storage_account", - "storage_container" + "id", + "type" ], - "type": "object" - }, - "client_id": { - "description": "The client ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "type": "boolean" - }, - "scope": { - "description": "The scope of your observed subscription.", - "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" + "type": "object", + "x-merge-override": { + "required": false + } } }, "required": [ - "account_id", - "actual_bill_config", - "amortized_bill_config", - "client_id", - "scope" + "data" ], "type": "object" - }, - "type": { - "default": "azure_uc_config_post_request", - "description": "Type of Azure config Post Request.", - "enum": [ - "azure_uc_config_post_request" - ], - "example": "azure_uc_config_post_request", - "type": "string", - "x-enum-varnames": [ - "AZURE_UC_CONFIG_POST_REQUEST" - ] } }, - "required": [ - "attributes", - "type" - ], - "type": "object" + "type": "object", + "x-merge-override": { + "properties": false + } }, - "AzureUCConfigPostRequest": { - "description": "Azure config Post Request.", + "ApplicationKeyResponse": { + "description": "Response for retrieving an application key.", "properties": { "data": { - "description": "Azure config Post data.", + "description": "Datadog application key.", "properties": { "attributes": { - "description": "Attributes for Azure config Post Request.", + "description": "Attributes of a full application key.", "properties": { - "account_id": { - "description": "The tenant ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "created_at": { + "description": "Creation date of the application key.", + "example": "2020-11-23T10:00:00.000Z", + "format": "date-time", + "readOnly": true, "type": "string" }, - "actual_bill_config": { - "description": "Bill config.", - "properties": { - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - } - }, - "required": [ - "export_name", - "export_path", - "storage_account", - "storage_container" - ], - "type": "object" + "key": { + "description": "The application key.", + "readOnly": true, + "type": "string", + "x-secret": true }, - "amortized_bill_config": { - "description": "Bill config.", - "properties": { - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - } - }, - "required": [ - "export_name", - "export_path", - "storage_account", - "storage_container" - ], - "type": "object" + "last4": { + "description": "The last four characters of the application key.", + "example": "abcd", + "maxLength": 4, + "minLength": 4, + "readOnly": true, + "type": "string", + "x-secret": true }, - "client_id": { - "description": "The client ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "name": { + "description": "Name of the application key.", + "example": "Application Key for managing dashboards", "type": "string" }, - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "type": "boolean" - }, - "scope": { - "description": "The scope of your observed subscription.", - "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" + "scopes": { + "description": "Array of scopes to grant the application key.", + "example": [ + "dashboards_read", + "dashboards_write", + "dashboards_public_share" + ], + "items": { + "description": "Name of scope.", + "type": "string" + }, + "nullable": true, + "type": "array" } }, - "required": [ - "account_id", - "actual_bill_config", - "amortized_bill_config", - "client_id", - "scope" - ], - "type": "object" - }, - "type": { - "default": "azure_uc_config_post_request", - "description": "Type of Azure config Post Request.", - "enum": [ - "azure_uc_config_post_request" - ], - "example": "azure_uc_config_post_request", - "type": "string", - "x-enum-varnames": [ - "AZURE_UC_CONFIG_POST_REQUEST" - ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "AzureUCConfigPostRequestAttributes": { - "description": "Attributes for Azure config Post Request.", - "properties": { - "account_id": { - "description": "The tenant ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "actual_bill_config": { - "description": "Bill config.", - "properties": { - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - } - }, - "required": [ - "export_name", - "export_path", - "storage_account", - "storage_container" - ], - "type": "object" - }, - "amortized_bill_config": { - "description": "Bill config.", - "properties": { - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" + "type": "object", + "x-merge-override": { + "properties": false + } }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", + "id": { + "description": "ID of the application key.", "type": "string" }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - } - }, - "required": [ - "export_name", - "export_path", - "storage_account", - "storage_container" - ], - "type": "object" - }, - "client_id": { - "description": "The client ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "is_enabled": { - "description": "Whether or not the Cloud Cost Management account is enabled.", - "type": "boolean" - }, - "scope": { - "description": "The scope of your observed subscription.", - "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - } - }, - "required": [ - "account_id", - "actual_bill_config", - "amortized_bill_config", - "client_id", - "scope" - ], - "type": "object" - }, - "AzureUCConfigPostRequestType": { - "default": "azure_uc_config_post_request", - "description": "Type of Azure config Post Request.", - "enum": [ - "azure_uc_config_post_request" - ], - "example": "azure_uc_config_post_request", - "type": "string", - "x-enum-varnames": [ - "AZURE_UC_CONFIG_POST_REQUEST" - ] - }, - "AzureUCConfigsResponse": { - "description": "List of Azure accounts with configs.", - "properties": { - "data": { - "description": "An Azure config pair.", - "items": { - "description": "Azure config pair.", - "properties": { - "attributes": { - "description": "Attributes for Azure config pair.", - "properties": { - "configs": { - "description": "An Azure config.", - "items": { - "description": "Azure config.", + "relationships": { + "description": "Resources related to the application key.", + "properties": { + "owned_by": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", "properties": { - "account_id": { - "description": "The tenant ID of the azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "client_id": { - "description": "The client ID of the Azure account.", - "example": "1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "created_at": { - "description": "The timestamp when the Azure config was created.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "dataset_type": { - "description": "The dataset type of the Azure config.", - "example": "actual", - "type": "string" - }, - "error_messages": { - "description": "The error messages for the Azure config.", - "items": { - "type": "string" - }, - "type": "array" - }, - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, "id": { - "description": "The ID of the Azure config.", - "format": "int64", - "type": "integer" - }, - "months": { - "deprecated": true, - "description": "The number of months the report has been backfilled.", - "format": "int32", - "maximum": 36, - "type": "integer" - }, - "scope": { - "description": "The scope of your observed subscription.", - "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", - "type": "string" - }, - "status": { - "description": "The status of the Azure config.", - "example": "active", - "type": "string" - }, - "status_updated_at": { - "description": "The timestamp when the Azure config status was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", - "type": "string", - "x-merge-override": { - "format": false - } - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" - }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", "type": "string" }, - "updated_at": { - "description": "The timestamp when the Azure config was last updated.", - "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", "type": "string", - "x-merge-override": { - "format": false - } + "x-enum-varnames": [ + "USERS" + ] } }, "required": [ - "account_id", - "client_id", - "dataset_type", - "export_name", - "export_path", - "scope", - "status", - "storage_account", - "storage_container" + "id", + "type" ], "type": "object", "x-merge-override": { "required": false } - }, - "type": "array" + } }, - "id": { - "description": "The ID of the Azure config pair.", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "configs" - ], - "type": "object", - "x-merge-override": { - "properties": false + "required": [ + "data" + ], + "type": "object" } }, - "id": { - "description": "The ID of Cloud Cost Management account.", - "format": "int64", - "type": "integer" - }, - "type": { - "default": "azure_uc_configs", - "description": "Type of Azure config pair.", - "enum": [ - "azure_uc_configs" - ], - "example": "azure_uc_configs", - "type": "string", - "x-enum-varnames": [ - "AZURE_UC_CONFIGS" - ] + "type": "object", + "x-merge-override": { + "properties": false } }, - "required": [ - "attributes", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "type": { + "default": "application_keys", + "description": "Application Keys resource type.", + "enum": [ + "application_keys" + ], + "example": "application_keys", + "type": "string", + "x-enum-varnames": [ + "APPLICATION_KEYS" + ] } }, - "type": "array" - } - }, - "type": "object" - }, - "BillConfig": { - "description": "Bill config.", - "properties": { - "export_name": { - "description": "The name of the configured Azure Export.", - "example": "dd-actual-export", - "type": "string" - }, - "export_path": { - "description": "The path where the Azure Export is saved.", - "example": "dd-export-path", - "type": "string" - }, - "storage_account": { - "description": "The name of the storage account where the Azure Export is saved.", - "example": "dd-storage-account", - "type": "string" + "type": "object", + "x-merge-override": { + "required": false + } }, - "storage_container": { - "description": "The name of the storage container where the Azure Export is saved.", - "example": "dd-storage-container", - "type": "string" - } - }, - "required": [ - "export_name", - "export_path", - "storage_account", - "storage_container" - ], - "type": "object" - }, - "BillingDimensionsMappingBody": { - "description": "Billing dimensions mapping data.", - "items": { - "description": "The mapping data for each billing dimension.", - "properties": { - "attributes": { - "description": "Mapping of billing dimensions to endpoint keys.", - "properties": { - "endpoints": { - "description": "List of supported endpoints with their keys mapped to the billing_dimension.", - "items": { - "description": "An endpoint's keys mapped to the billing_dimension.", - "properties": { - "id": { - "description": "The URL for the endpoint.", - "example": "api/v1/usage/billable-summary", - "type": "string" - }, - "keys": { - "description": "The billing dimension.", - "example": [ - "apm_host_top99p", - "apm_host_sum" - ], - "items": { - "example": "apm_host_top99p", + "included": { + "description": "Array of objects related to the application key.", + "items": { + "description": "An object related to an application key.", + "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" }, - "type": "array" - }, - "status": { - "description": "Denotes whether mapping keys were available for this endpoint.", - "enum": [ - "OK", - "NOT_FOUND" - ], - "type": "string", - "x-enum-varnames": [ - "OK", - "NOT_FOUND" - ] - } - }, - "type": "object" - }, - "type": "array" - }, - "in_app_label": { - "description": "Label used for the billing dimension in the Plan & Usage charts.", - "example": "APM Hosts", - "type": "string" - }, - "timestamp": { - "description": "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`.", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "ID of the billing dimension.", - "type": "string" - }, - "type": { - "default": "billing_dimensions", - "description": "Type of active billing dimensions data.", - "enum": [ - "billing_dimensions" - ], - "type": "string", - "x-enum-varnames": [ - "BILLING_DIMENSIONS" - ] - } - }, - "type": "object" - }, - "type": "array" - }, - "BillingDimensionsMappingBodyItem": { - "description": "The mapping data for each billing dimension.", - "properties": { - "attributes": { - "description": "Mapping of billing dimensions to endpoint keys.", - "properties": { - "endpoints": { - "description": "List of supported endpoints with their keys mapped to the billing_dimension.", - "items": { - "description": "An endpoint's keys mapped to the billing_dimension.", + "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": "Role object returned by the API.", "properties": { + "attributes": { + "description": "Attributes of the role.", + "properties": { + "created_at": { + "description": "Creation time of the role.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_at": { + "description": "Time of last role modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", + "type": "string" + }, + "user_count": { + "description": "Number of users with that role.", + "format": "int64", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, "id": { - "description": "The URL for the endpoint.", - "example": "api/v1/usage/billable-summary", + "description": "The unique identifier of the role.", "type": "string" }, - "keys": { - "description": "The billing dimension.", - "example": [ - "apm_host_top99p", - "apm_host_sum" + "relationships": { + "description": "Relationships of the role object returned by the API.", + "properties": { + "permissions": { + "description": "Relationship to multiple permissions objects.", + "properties": { + "data": { + "description": "Relationships to permission objects.", + "items": { + "description": "Relationship to permission object.", + "properties": { + "id": { + "description": "ID of the permission.", + "type": "string" + }, + "type": { + "default": "permissions", + "description": "Permissions resource type.", + "enum": [ + "permissions" + ], + "example": "permissions", + "type": "string", + "x-enum-varnames": [ + "PERMISSIONS" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" + }, + "type": { + "default": "roles", + "description": "Roles type.", + "enum": [ + "roles" ], - "items": { - "example": "apm_host_top99p", - "type": "string" + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } + }, + "required": [ + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + { + "description": "The definition of LeakedKey object.", + "properties": { + "attributes": { + "description": "The definition of LeakedKeyAttributes object.", + "properties": { + "date": { + "description": "The LeakedKeyAttributes date.", + "example": "2017-07-21T17:32:28Z", + "format": "date-time", + "type": "string" + }, + "leak_source": { + "description": "The LeakedKeyAttributes leak_source.", + "type": "string" + } }, - "type": "array" + "required": [ + "date" + ], + "type": "object" }, - "status": { - "description": "Denotes whether mapping keys were available for this endpoint.", + "id": { + "description": "The LeakedKey id.", + "example": "id", + "type": "string" + }, + "type": { + "default": "leaked_keys", + "description": "The definition of LeakedKeyType object.", "enum": [ - "OK", - "NOT_FOUND" + "leaked_keys" ], + "example": "leaked_keys", "type": "string", "x-enum-varnames": [ - "OK", - "NOT_FOUND" + "LEAKED_KEYS" ] } }, + "required": [ + "attributes", + "id", + "type" + ], "type": "object" - }, - "type": "array" - }, - "in_app_label": { - "description": "Label used for the billing dimension in the Plan & Usage charts.", - "example": "APM Hosts", - "type": "string" - }, - "timestamp": { - "description": "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`.", - "format": "date-time", - "type": "string" - } + } + ] }, - "type": "object" - }, - "id": { - "description": "ID of the billing dimension.", - "type": "string" - }, - "type": { - "default": "billing_dimensions", - "description": "Type of active billing dimensions data.", - "enum": [ - "billing_dimensions" - ], - "type": "string", - "x-enum-varnames": [ - "BILLING_DIMENSIONS" - ] + "type": "array" } }, "type": "object" }, - "BillingDimensionsMappingBodyItemAttributes": { - "description": "Mapping of billing dimensions to endpoint keys.", - "properties": { - "endpoints": { - "description": "List of supported endpoints with their keys mapped to the billing_dimension.", - "items": { - "description": "An endpoint's keys mapped to the billing_dimension.", - "properties": { - "id": { - "description": "The URL for the endpoint.", - "example": "api/v1/usage/billable-summary", - "type": "string" - }, - "keys": { - "description": "The billing dimension.", - "example": [ - "apm_host_top99p", - "apm_host_sum" - ], - "items": { - "example": "apm_host_top99p", + "ApplicationKeyResponseIncludedItem": { + "description": "An object related to an application key.", + "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" }, - "type": "array" + "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" + } }, - "status": { - "description": "Denotes whether mapping keys were available for this endpoint.", - "enum": [ - "OK", - "NOT_FOUND" - ], - "type": "string", - "x-enum-varnames": [ - "OK", - "NOT_FOUND" - ] - } + "type": "object" }, - "type": "object" - }, - "type": "array" - }, - "in_app_label": { - "description": "Label used for the billing dimension in the Plan & Usage charts.", - "example": "APM Hosts", - "type": "string" - }, - "timestamp": { - "description": "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`.", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "BillingDimensionsMappingBodyItemAttributesEndpointsItems": { - "description": "An endpoint's keys mapped to the billing_dimension.", - "properties": { - "id": { - "description": "The URL for the endpoint.", - "example": "api/v1/usage/billable-summary", - "type": "string" - }, - "keys": { - "description": "The billing dimension.", - "example": [ - "apm_host_top99p", - "apm_host_sum" - ], - "items": { - "example": "apm_host_top99p", - "type": "string" - }, - "type": "array" - }, - "status": { - "description": "Denotes whether mapping keys were available for this endpoint.", - "enum": [ - "OK", - "NOT_FOUND" - ], - "type": "string", - "x-enum-varnames": [ - "OK", - "NOT_FOUND" - ] - } - }, - "type": "object" - }, - "BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus": { - "description": "Denotes whether mapping keys were available for this endpoint.", - "enum": [ - "OK", - "NOT_FOUND" - ], - "type": "string", - "x-enum-varnames": [ - "OK", - "NOT_FOUND" - ] - }, - "BillingDimensionsMappingResponse": { - "description": "Billing dimensions mapping response.", - "properties": { - "data": { - "description": "Billing dimensions mapping data.", - "items": { - "description": "The mapping data for each billing dimension.", - "properties": { - "attributes": { - "description": "Mapping of billing dimensions to endpoint keys.", - "properties": { - "endpoints": { - "description": "List of supported endpoints with their keys mapped to the billing_dimension.", - "items": { - "description": "An endpoint's keys mapped to the billing_dimension.", + "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": "The URL for the endpoint.", - "example": "api/v1/usage/billable-summary", + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", "type": "string" }, - "keys": { - "description": "The billing dimension.", - "example": [ - "apm_host_top99p", - "apm_host_sum" - ], - "items": { - "example": "apm_host_top99p", - "type": "string" - }, - "type": "array" - }, - "status": { - "description": "Denotes whether mapping keys were available for this endpoint.", + "type": { + "default": "orgs", + "description": "Organizations resource type.", "enum": [ - "OK", - "NOT_FOUND" + "orgs" ], + "example": "orgs", "type": "string", "x-enum-varnames": [ - "OK", - "NOT_FOUND" + "ORGS" ] } }, + "required": [ + "id", + "type" + ], "type": "object" - }, - "type": "array" + } }, - "in_app_label": { - "description": "Label used for the billing dimension in the Plan & Usage charts.", - "example": "APM Hosts", - "type": "string" + "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" + } }, - "timestamp": { - "description": "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`.", - "format": "date-time", - "type": "string" - } + "required": [ + "data" + ], + "type": "object" }, - "type": "object" - }, - "id": { - "description": "ID of the billing dimension.", - "type": "string" - }, - "type": { - "default": "billing_dimensions", - "description": "Type of active billing dimensions data.", - "enum": [ - "billing_dimensions" - ], - "type": "string", - "x-enum-varnames": [ - "BILLING_DIMENSIONS" - ] - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - }, - "BulkMuteFindingsRequest": { - "description": "The new bulk mute finding request.", - "properties": { - "data": { - "description": "Data object containing the new bulk mute properties of the finding.", - "properties": { - "attributes": { - "additionalProperties": false, - "description": "The mute properties to be updated.", - "properties": { - "mute": { - "additionalProperties": false, - "description": "Object containing the new mute properties of the findings.", + "other_users": { + "description": "Relationship to users.", "properties": { - "description": { - "description": "Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.", - "type": "string" - }, - "expiration_date": { - "description": "The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.\nIf this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.\n", - "example": 1778721573794, - "format": "int64", - "type": "integer" - }, - "muted": { - "description": "Whether those findings should be muted or unmuted.", - "example": true, - "type": "boolean" - }, - "reason": { - "description": "The reason why this finding is muted or unmuted.", - "enum": [ - "PENDING_FIX", - "FALSE_POSITIVE", - "ACCEPTED_RISK", - "NO_PENDING_FIX", - "HUMAN_ERROR", - "NO_LONGER_ACCEPTED_RISK", - "OTHER" - ], - "example": "ACCEPTED_RISK", - "type": "string", - "x-enum-varnames": [ - "PENDING_FIX", - "FALSE_POSITIVE", - "ACCEPTED_RISK", - "NO_PENDING_FIX", - "HUMAN_ERROR", - "NO_LONGER_ACCEPTED_RISK", - "OTHER" - ] + "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": [ - "muted", - "reason" + "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 + } } }, - "required": [ - "mute" + "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": "Role object returned by the API.", + "properties": { + "attributes": { + "description": "Attributes of the role.", + "properties": { + "created_at": { + "description": "Creation time of the role.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_at": { + "description": "Time of last role modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", + "type": "string" + }, + "user_count": { + "description": "Number of users with that role.", + "format": "int64", + "readOnly": true, + "type": "integer" + } + }, "type": "object" }, "id": { - "description": "UUID to identify the request", - "example": "dbe5f567-192b-4404-b908-29b70e1c9f76", + "description": "The unique identifier of the role.", "type": "string" }, - "meta": { - "description": "Meta object containing the findings to be updated.", + "relationships": { + "description": "Relationships of the role object returned by the API.", "properties": { - "findings": { - "description": "Array of findings.", - "items": { - "description": "Finding object containing the finding information.", - "properties": { - "finding_id": { - "description": "The unique ID for this finding.", - "example": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", - "type": "string" - } - }, - "type": "object" + "permissions": { + "description": "Relationship to multiple permissions objects.", + "properties": { + "data": { + "description": "Relationships to permission objects.", + "items": { + "description": "Relationship to permission object.", + "properties": { + "id": { + "description": "ID of the permission.", + "type": "string" + }, + "type": { + "default": "permissions", + "description": "Permissions resource type.", + "enum": [ + "permissions" + ], + "example": "permissions", + "type": "string", + "x-enum-varnames": [ + "PERMISSIONS" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } }, - "type": "array" + "type": "object", + "x-merge-override": { + "required": false + } } }, "type": "object" }, "type": { - "default": "finding", - "description": "The JSON:API type for findings.", + "default": "roles", + "description": "Roles type.", "enum": [ - "finding" + "roles" ], - "example": "finding", + "example": "roles", "type": "string", "x-enum-varnames": [ - "FINDING" + "ROLES" ] } }, "required": [ - "id", - "type", - "attributes", - "meta" + "type" ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "BulkMuteFindingsRequestAttributes": { - "additionalProperties": false, - "description": "The mute properties to be updated.", - "properties": { - "mute": { - "additionalProperties": false, - "description": "Object containing the new mute properties of the findings.", - "properties": { - "description": { - "description": "Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.", - "type": "string" - }, - "expiration_date": { - "description": "The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.\nIf this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.\n", - "example": 1778721573794, - "format": "int64", - "type": "integer" + "type": "object", + "x-merge-override": { + "required": false + } + }, + { + "description": "The definition of LeakedKey object.", + "properties": { + "attributes": { + "description": "The definition of LeakedKeyAttributes object.", + "properties": { + "date": { + "description": "The LeakedKeyAttributes date.", + "example": "2017-07-21T17:32:28Z", + "format": "date-time", + "type": "string" + }, + "leak_source": { + "description": "The LeakedKeyAttributes leak_source.", + "type": "string" + } + }, + "required": [ + "date" + ], + "type": "object" }, - "muted": { - "description": "Whether those findings should be muted or unmuted.", - "example": true, - "type": "boolean" + "id": { + "description": "The LeakedKey id.", + "example": "id", + "type": "string" }, - "reason": { - "description": "The reason why this finding is muted or unmuted.", + "type": { + "default": "leaked_keys", + "description": "The definition of LeakedKeyType object.", "enum": [ - "PENDING_FIX", - "FALSE_POSITIVE", - "ACCEPTED_RISK", - "NO_PENDING_FIX", - "HUMAN_ERROR", - "NO_LONGER_ACCEPTED_RISK", - "OTHER" + "leaked_keys" ], - "example": "ACCEPTED_RISK", + "example": "leaked_keys", "type": "string", "x-enum-varnames": [ - "PENDING_FIX", - "FALSE_POSITIVE", - "ACCEPTED_RISK", - "NO_PENDING_FIX", - "HUMAN_ERROR", - "NO_LONGER_ACCEPTED_RISK", - "OTHER" + "LEAKED_KEYS" ] } }, "required": [ - "muted", - "reason" + "attributes", + "id", + "type" ], "type": "object" } - }, - "required": [ - "mute" - ], - "type": "object" + ] }, - "BulkMuteFindingsRequestData": { - "description": "Data object containing the new bulk mute properties of the finding.", + "ApplicationKeyResponseMeta": { + "description": "Additional information related to the application key response.", "properties": { - "attributes": { - "additionalProperties": false, - "description": "The mute properties to be updated.", - "properties": { - "mute": { - "additionalProperties": false, - "description": "Object containing the new mute properties of the findings.", - "properties": { - "description": { - "description": "Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.", - "type": "string" - }, - "expiration_date": { - "description": "The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.\nIf this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.\n", - "example": 1778721573794, - "format": "int64", - "type": "integer" - }, - "muted": { - "description": "Whether those findings should be muted or unmuted.", - "example": true, - "type": "boolean" - }, - "reason": { - "description": "The reason why this finding is muted or unmuted.", - "enum": [ - "PENDING_FIX", - "FALSE_POSITIVE", - "ACCEPTED_RISK", - "NO_PENDING_FIX", - "HUMAN_ERROR", - "NO_LONGER_ACCEPTED_RISK", - "OTHER" - ], - "example": "ACCEPTED_RISK", - "type": "string", - "x-enum-varnames": [ - "PENDING_FIX", - "FALSE_POSITIVE", - "ACCEPTED_RISK", - "NO_PENDING_FIX", - "HUMAN_ERROR", - "NO_LONGER_ACCEPTED_RISK", - "OTHER" - ] - } - }, - "required": [ - "muted", - "reason" - ], - "type": "object" - } - }, - "required": [ - "mute" - ], - "type": "object" - }, - "id": { - "description": "UUID to identify the request", - "example": "dbe5f567-192b-4404-b908-29b70e1c9f76", - "type": "string" + "max_allowed_per_user": { + "description": "Max allowed number of application keys per user.", + "format": "int64", + "type": "integer" }, - "meta": { - "description": "Meta object containing the findings to be updated.", + "page": { + "description": "Additional information related to the application key response.", "properties": { - "findings": { - "description": "Array of findings.", - "items": { - "description": "Finding object containing the finding information.", - "properties": { - "finding_id": { - "description": "The unique ID for this finding.", - "example": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" + "total_filtered_count": { + "description": "Total filtered application key count.", + "format": "int64", + "type": "integer" } }, "type": "object" - }, - "type": { - "default": "finding", - "description": "The JSON:API type for findings.", - "enum": [ - "finding" - ], - "example": "finding", - "type": "string", - "x-enum-varnames": [ - "FINDING" - ] } }, - "required": [ - "id", - "type", - "attributes", - "meta" - ], "type": "object" }, - "BulkMuteFindingsRequestMeta": { - "description": "Meta object containing the findings to be updated.", + "ApplicationKeyResponseMetaPage": { + "description": "Additional information related to the application key response.", "properties": { - "findings": { - "description": "Array of findings.", - "items": { - "description": "Finding object containing the finding information.", - "properties": { - "finding_id": { - "description": "The unique ID for this finding.", - "example": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" + "total_filtered_count": { + "description": "Total filtered application key count.", + "format": "int64", + "type": "integer" } }, "type": "object" }, - "BulkMuteFindingsRequestMetaFindings": { - "description": "Finding object containing the finding information.", + "ApplicationKeyUpdateAttributes": { + "description": "Attributes used to update an application Key.", "properties": { - "finding_id": { - "description": "The unique ID for this finding.", - "example": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", + "name": { + "description": "Name of the application key.", + "example": "Application Key for managing dashboards", "type": "string" + }, + "scopes": { + "description": "Array of scopes to grant the application key.", + "example": [ + "dashboards_read", + "dashboards_write", + "dashboards_public_share" + ], + "items": { + "description": "Name of scope.", + "type": "string" + }, + "nullable": true, + "type": "array" } }, - "type": "object" + "type": "object", + "x-merge-override": { + "properties": false + } }, - "BulkMuteFindingsRequestProperties": { - "additionalProperties": false, - "description": "Object containing the new mute properties of the findings.", + "ApplicationKeyUpdateData": { + "description": "Object used to update an application key.", "properties": { - "description": { - "description": "Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.", - "type": "string" - }, - "expiration_date": { - "description": "The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.\nIf this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.\n", - "example": 1778721573794, - "format": "int64", - "type": "integer" + "attributes": { + "description": "Attributes used to update an application Key.", + "properties": { + "name": { + "description": "Name of the application key.", + "example": "Application Key for managing dashboards", + "type": "string" + }, + "scopes": { + "description": "Array of scopes to grant the application key.", + "example": [ + "dashboards_read", + "dashboards_write", + "dashboards_public_share" + ], + "items": { + "description": "Name of scope.", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object", + "x-merge-override": { + "properties": false + } }, - "muted": { - "description": "Whether those findings should be muted or unmuted.", - "example": true, - "type": "boolean" + "id": { + "description": "ID of the application key.", + "example": "00112233-4455-6677-8899-aabbccddeeff", + "type": "string" }, - "reason": { - "description": "The reason why this finding is muted or unmuted.", + "type": { + "default": "application_keys", + "description": "Application Keys resource type.", "enum": [ - "PENDING_FIX", - "FALSE_POSITIVE", - "ACCEPTED_RISK", - "NO_PENDING_FIX", - "HUMAN_ERROR", - "NO_LONGER_ACCEPTED_RISK", - "OTHER" + "application_keys" ], - "example": "ACCEPTED_RISK", + "example": "application_keys", "type": "string", "x-enum-varnames": [ - "PENDING_FIX", - "FALSE_POSITIVE", - "ACCEPTED_RISK", - "NO_PENDING_FIX", - "HUMAN_ERROR", - "NO_LONGER_ACCEPTED_RISK", - "OTHER" + "APPLICATION_KEYS" ] } }, "required": [ - "muted", - "reason" + "attributes", + "id", + "type" ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } }, - "BulkMuteFindingsResponse": { - "description": "The expected response schema.", + "ApplicationKeyUpdateRequest": { + "description": "Request used to update an application key.", "properties": { "data": { - "description": "Data object containing the ID of the request that was updated.", + "description": "Object used to update an application key.", "properties": { + "attributes": { + "description": "Attributes used to update an application Key.", + "properties": { + "name": { + "description": "Name of the application key.", + "example": "Application Key for managing dashboards", + "type": "string" + }, + "scopes": { + "description": "Array of scopes to grant the application key.", + "example": [ + "dashboards_read", + "dashboards_write", + "dashboards_public_share" + ], + "items": { + "description": "Name of scope.", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object", + "x-merge-override": { + "properties": false + } + }, "id": { - "description": "UUID used to identify the request", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "description": "ID of the application key.", + "example": "00112233-4455-6677-8899-aabbccddeeff", "type": "string" }, "type": { - "default": "finding", - "description": "The JSON:API type for findings.", + "default": "application_keys", + "description": "Application Keys resource type.", "enum": [ - "finding" + "application_keys" ], - "example": "finding", + "example": "application_keys", "type": "string", "x-enum-varnames": [ - "FINDING" + "APPLICATION_KEYS" ] } }, - "type": "object" + "required": [ + "attributes", + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } } }, "required": [ @@ -10608,6081 +9404,11846 @@ ], "type": "object" }, - "BulkMuteFindingsResponseData": { - "description": "Data object containing the ID of the request that was updated.", + "ApplicationKeysSort": { + "default": "name", + "description": "Sorting options", + "enum": [ + "created_at", + "-created_at", + "last4", + "-last4", + "name", + "-name" + ], + "type": "string", + "x-enum-varnames": [ + "CREATED_AT_ASCENDING", + "CREATED_AT_DESCENDING", + "LAST4_ASCENDING", + "LAST4_DESCENDING", + "NAME_ASCENDING", + "NAME_DESCENDING" + ] + }, + "ApplicationKeysType": { + "default": "application_keys", + "description": "Application Keys resource type.", + "enum": [ + "application_keys" + ], + "example": "application_keys", + "type": "string", + "x-enum-varnames": [ + "APPLICATION_KEYS" + ] + }, + "AuditLogsEvent": { + "description": "Object description of an Audit Logs event after it is processed and stored by Datadog.", "properties": { + "attributes": { + "description": "JSON object containing all event attributes and their associated values.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "JSON object of attributes from Audit Logs events.", + "example": { + "customAttribute": 123, + "duration": 2345 + }, + "type": "object" + }, + "message": { + "description": "Message of the event.", + "type": "string" + }, + "service": { + "description": "Name of the application or service generating Audit Logs events.\nThis name is used to correlate Audit Logs to APM, so make sure you specify the same\nvalue when you use both products.", + "example": "web-app", + "type": "string" + }, + "tags": { + "description": "Array of tags associated with your event.", + "example": [ + "team:A" + ], + "items": { + "description": "Tag associated with your event.", + "type": "string" + }, + "type": "array" + }, + "timestamp": { + "description": "Timestamp of your event.", + "example": "2019-01-02T09:42:36.320Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, "id": { - "description": "UUID used to identify the request", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "description": "Unique ID of the event.", + "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", "type": "string" }, "type": { - "default": "finding", - "description": "The JSON:API type for findings.", + "default": "audit", + "description": "Type of the event.", "enum": [ - "finding" + "audit" ], - "example": "finding", + "example": "audit", "type": "string", "x-enum-varnames": [ - "FINDING" + "Audit" ] } }, "type": "object" }, - "CIAppAggregateBucketValue": { - "description": "A bucket value, can either be a timeseries or a single value.", - "oneOf": [ - { - "description": "A single string value.", + "AuditLogsEventAttributes": { + "description": "JSON object containing all event attributes and their associated values.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "JSON object of attributes from Audit Logs events.", + "example": { + "customAttribute": 123, + "duration": 2345 + }, + "type": "object" + }, + "message": { + "description": "Message of the event.", "type": "string" }, - { - "description": "A single number value.", - "format": "double", - "type": "number" + "service": { + "description": "Name of the application or service generating Audit Logs events.\nThis name is used to correlate Audit Logs to APM, so make sure you specify the same\nvalue when you use both products.", + "example": "web-app", + "type": "string" }, - { - "description": "A timeseries array.", + "tags": { + "description": "Array of tags associated with your event.", + "example": [ + "team:A" + ], "items": { - "description": "A timeseries point.", + "description": "Tag associated with your event.", + "type": "string" + }, + "type": "array" + }, + "timestamp": { + "description": "Timestamp of your event.", + "example": "2019-01-02T09:42:36.320Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "AuditLogsEventType": { + "default": "audit", + "description": "Type of the event.", + "enum": [ + "audit" + ], + "example": "audit", + "type": "string", + "x-enum-varnames": [ + "Audit" + ] + }, + "AuditLogsEventsResponse": { + "description": "Response object with all events matching the request and pagination information.", + "properties": { + "data": { + "description": "Array of events matching the request.", + "items": { + "description": "Object description of an Audit Logs event after it is processed and stored by Datadog.", "properties": { - "time": { - "description": "The time value for this point.", - "example": "2020-06-08T11:55:00.123Z", - "format": "date-time", + "attributes": { + "description": "JSON object containing all event attributes and their associated values.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "JSON object of attributes from Audit Logs events.", + "example": { + "customAttribute": 123, + "duration": 2345 + }, + "type": "object" + }, + "message": { + "description": "Message of the event.", + "type": "string" + }, + "service": { + "description": "Name of the application or service generating Audit Logs events.\nThis name is used to correlate Audit Logs to APM, so make sure you specify the same\nvalue when you use both products.", + "example": "web-app", + "type": "string" + }, + "tags": { + "description": "Array of tags associated with your event.", + "example": [ + "team:A" + ], + "items": { + "description": "Tag associated with your event.", + "type": "string" + }, + "type": "array" + }, + "timestamp": { + "description": "Timestamp of your event.", + "example": "2019-01-02T09:42:36.320Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "Unique ID of the event.", + "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", "type": "string" }, - "value": { - "description": "The value for this point.", - "example": 19, - "format": "double", - "type": "number" + "type": { + "default": "audit", + "description": "Type of the event.", + "enum": [ + "audit" + ], + "example": "audit", + "type": "string", + "x-enum-varnames": [ + "Audit" + ] } }, "type": "object" }, - "type": "array", - "x-generate-alias-as-model": true + "type": "array" + }, + "links": { + "description": "Links attributes.", + "properties": { + "next": { + "description": "Link for the next set of results. Note that the request can also be made using the\nPOST endpoint.", + "example": "https://app.datadoghq.com/api/v2/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "description": "The metadata associated with a request.", + "properties": { + "elapsed": { + "description": "Time elapsed in milliseconds.", + "example": 132, + "format": "int64", + "type": "integer" + }, + "page": { + "description": "Paging attributes.", + "properties": { + "after": { + "description": "The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + } + }, + "type": "object" + }, + "request_id": { + "description": "The identifier of the request.", + "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", + "type": "string" + }, + "status": { + "description": "The status of the response.", + "enum": [ + "done", + "timeout" + ], + "example": "done", + "type": "string", + "x-enum-varnames": [ + "DONE", + "TIMEOUT" + ] + }, + "warnings": { + "description": "A list of warnings (non-fatal errors) encountered. Partial results may return if\nwarnings are present in the response.", + "items": { + "description": "Warning message indicating something that went wrong with the query.", + "properties": { + "code": { + "description": "Unique code for this type of warning.", + "example": "unknown_index", + "type": "string" + }, + "detail": { + "description": "Detailed explanation of this specific warning.", + "example": "indexes: foo, bar", + "type": "string" + }, + "title": { + "description": "Short human-readable summary of the warning.", + "example": "One or several indexes are missing or invalid, results hold data from the other indexes", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" } - ] - }, - "CIAppAggregateBucketValueSingleNumber": { - "description": "A single number value.", - "format": "double", - "type": "number" + }, + "type": "object" }, - "CIAppAggregateBucketValueSingleString": { - "description": "A single string value.", - "type": "string" + "AuditLogsQueryFilter": { + "description": "Search and filter query settings.", + "properties": { + "from": { + "default": "now-15m", + "description": "Minimum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).", + "example": "now-15m", + "type": "string" + }, + "query": { + "default": "*", + "description": "Search query following the Audit Logs search syntax.", + "example": "@type:session AND @session.type:user", + "type": "string" + }, + "to": { + "default": "now", + "description": "Maximum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).", + "example": "now", + "type": "string" + } + }, + "type": "object" }, - "CIAppAggregateBucketValueTimeseries": { - "description": "A timeseries array.", - "items": { - "description": "A timeseries point.", - "properties": { - "time": { - "description": "The time value for this point.", - "example": "2020-06-08T11:55:00.123Z", - "format": "date-time", - "type": "string" - }, - "value": { - "description": "The value for this point.", - "example": 19, - "format": "double", - "type": "number" - } + "AuditLogsQueryOptions": { + "description": "Global query options that are used during the query.\nNote: Specify either timezone or time offset, not both. Otherwise, the query fails.", + "properties": { + "time_offset": { + "description": "Time offset (in seconds) to apply to the query.", + "format": "int64", + "type": "integer" }, - "type": "object" + "timezone": { + "default": "UTC", + "description": "The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).", + "example": "GMT", + "type": "string" + } }, - "type": "array", - "x-generate-alias-as-model": true + "type": "object" }, - "CIAppAggregateBucketValueTimeseriesPoint": { - "description": "A timeseries point.", + "AuditLogsQueryPageOptions": { + "description": "Paging attributes for listing events.", "properties": { - "time": { - "description": "The time value for this point.", - "example": "2020-06-08T11:55:00.123Z", - "format": "date-time", + "cursor": { + "description": "List following results with a cursor provided in the previous query.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "string" }, - "value": { - "description": "The value for this point.", - "example": 19, - "format": "double", - "type": "number" + "limit": { + "default": 10, + "description": "Maximum number of events in the response.", + "example": 25, + "format": "int32", + "maximum": 1000, + "type": "integer" } }, "type": "object" }, - "CIAppAggregateSort": { - "description": "A sort rule. The `aggregation` field is required when `type` is `measure`.", - "example": { - "aggregation": "count", - "order": "asc" + "AuditLogsResponseLinks": { + "description": "Links attributes.", + "properties": { + "next": { + "description": "Link for the next set of results. Note that the request can also be made using the\nPOST endpoint.", + "example": "https://app.datadoghq.com/api/v2/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + } }, + "type": "object" + }, + "AuditLogsResponseMetadata": { + "description": "The metadata associated with a request.", "properties": { - "aggregation": { - "description": "An aggregation function.", - "enum": [ - "count", - "cardinality", - "pc75", - "pc90", - "pc95", - "pc98", - "pc99", - "sum", - "min", - "max", - "avg", - "median", - "latest", - "earliest", - "most_frequent", - "delta" - ], - "example": "pc90", - "type": "string", - "x-enum-varnames": [ - "COUNT", - "CARDINALITY", - "PERCENTILE_75", - "PERCENTILE_90", - "PERCENTILE_95", - "PERCENTILE_98", - "PERCENTILE_99", - "SUM", - "MIN", - "MAX", - "AVG", - "MEDIAN", - "LATEST", - "EARLIEST", - "MOST_FREQUENT", - "DELTA" - ] + "elapsed": { + "description": "Time elapsed in milliseconds.", + "example": 132, + "format": "int64", + "type": "integer" }, - "metric": { - "description": "The metric to sort by (only used for `type=measure`).", - "example": "@duration", + "page": { + "description": "Paging attributes.", + "properties": { + "after": { + "description": "The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + } + }, + "type": "object" + }, + "request_id": { + "description": "The identifier of the request.", + "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", "type": "string" }, - "order": { - "description": "The order to use, ascending or descending.", + "status": { + "description": "The status of the response.", "enum": [ - "asc", - "desc" + "done", + "timeout" ], - "example": "asc", + "example": "done", "type": "string", "x-enum-varnames": [ - "ASCENDING", - "DESCENDING" + "DONE", + "TIMEOUT" ] }, - "type": { - "default": "alphabetical", - "description": "The type of sorting algorithm.", - "enum": [ - "alphabetical", - "measure" - ], - "type": "string", - "x-enum-varnames": [ - "ALPHABETICAL", - "MEASURE" - ] + "warnings": { + "description": "A list of warnings (non-fatal errors) encountered. Partial results may return if\nwarnings are present in the response.", + "items": { + "description": "Warning message indicating something that went wrong with the query.", + "properties": { + "code": { + "description": "Unique code for this type of warning.", + "example": "unknown_index", + "type": "string" + }, + "detail": { + "description": "Detailed explanation of this specific warning.", + "example": "indexes: foo, bar", + "type": "string" + }, + "title": { + "description": "Short human-readable summary of the warning.", + "example": "One or several indexes are missing or invalid, results hold data from the other indexes", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" } }, "type": "object" }, - "CIAppAggregateSortType": { - "default": "alphabetical", - "description": "The type of sorting algorithm.", - "enum": [ - "alphabetical", - "measure" - ], - "type": "string", - "x-enum-varnames": [ - "ALPHABETICAL", - "MEASURE" - ] - }, - "CIAppAggregationFunction": { - "description": "An aggregation function.", - "enum": [ - "count", - "cardinality", - "pc75", - "pc90", - "pc95", - "pc98", - "pc99", - "sum", - "min", - "max", - "avg", - "median", - "latest", - "earliest", - "most_frequent", - "delta" - ], - "example": "pc90", - "type": "string", - "x-enum-varnames": [ - "COUNT", - "CARDINALITY", - "PERCENTILE_75", - "PERCENTILE_90", - "PERCENTILE_95", - "PERCENTILE_98", - "PERCENTILE_99", - "SUM", - "MIN", - "MAX", - "AVG", - "MEDIAN", - "LATEST", - "EARLIEST", - "MOST_FREQUENT", - "DELTA" - ] - }, - "CIAppCIError": { - "description": "Contains information of the CI error.", - "nullable": true, + "AuditLogsResponsePage": { + "description": "Paging attributes.", "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, + "after": { + "description": "The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "type": "string" } }, "type": "object" }, - "CIAppCIErrorDomain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "AuditLogsResponseStatus": { + "description": "The status of the response.", "enum": [ - "provider", - "user", - "unknown" + "done", + "timeout" ], + "example": "done", "type": "string", "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" + "DONE", + "TIMEOUT" ] }, - "CIAppCompute": { - "description": "A compute rule to compute metrics or timeseries.", + "AuditLogsSearchEventsRequest": { + "description": "The request for a Audit Logs events list.", "properties": { - "aggregation": { - "description": "An aggregation function.", - "enum": [ - "count", - "cardinality", - "pc75", - "pc90", - "pc95", - "pc98", - "pc99", - "sum", - "min", - "max", - "avg", - "median", - "latest", - "earliest", - "most_frequent", - "delta" - ], - "example": "pc90", - "type": "string", - "x-enum-varnames": [ - "COUNT", - "CARDINALITY", - "PERCENTILE_75", - "PERCENTILE_90", - "PERCENTILE_95", - "PERCENTILE_98", - "PERCENTILE_99", - "SUM", - "MIN", - "MAX", - "AVG", - "MEDIAN", - "LATEST", - "EARLIEST", - "MOST_FREQUENT", - "DELTA" - ] + "filter": { + "description": "Search and filter query settings.", + "properties": { + "from": { + "default": "now-15m", + "description": "Minimum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).", + "example": "now-15m", + "type": "string" + }, + "query": { + "default": "*", + "description": "Search query following the Audit Logs search syntax.", + "example": "@type:session AND @session.type:user", + "type": "string" + }, + "to": { + "default": "now", + "description": "Maximum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).", + "example": "now", + "type": "string" + } + }, + "type": "object" }, - "interval": { - "description": "The time buckets' size (only used for type=timeseries)\nDefaults to a resolution of 150 points.", - "example": "5m", - "type": "string" + "options": { + "description": "Global query options that are used during the query.\nNote: Specify either timezone or time offset, not both. Otherwise, the query fails.", + "properties": { + "time_offset": { + "description": "Time offset (in seconds) to apply to the query.", + "format": "int64", + "type": "integer" + }, + "timezone": { + "default": "UTC", + "description": "The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).", + "example": "GMT", + "type": "string" + } + }, + "type": "object" }, - "metric": { - "description": "The metric to use.", - "example": "@duration", - "type": "string" + "page": { + "description": "Paging attributes for listing events.", + "properties": { + "cursor": { + "description": "List following results with a cursor provided in the previous query.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + }, + "limit": { + "default": 10, + "description": "Maximum number of events in the response.", + "example": 25, + "format": "int32", + "maximum": 1000, + "type": "integer" + } + }, + "type": "object" }, - "type": { - "default": "total", - "description": "The type of compute.", + "sort": { + "description": "Sort parameters when querying events.", "enum": [ - "timeseries", - "total" + "timestamp", + "-timestamp" ], "type": "string", "x-enum-varnames": [ - "TIMESERIES", - "TOTAL" + "TIMESTAMP_ASCENDING", + "TIMESTAMP_DESCENDING" ] } }, - "required": [ - "aggregation" - ], "type": "object" }, - "CIAppComputeType": { - "default": "total", - "description": "The type of compute.", + "AuditLogsSort": { + "description": "Sort parameters when querying events.", "enum": [ - "timeseries", - "total" + "timestamp", + "-timestamp" ], "type": "string", "x-enum-varnames": [ - "TIMESERIES", - "TOTAL" + "TIMESTAMP_ASCENDING", + "TIMESTAMP_DESCENDING" ] }, - "CIAppComputes": { - "additionalProperties": { - "description": "A bucket value, can either be a timeseries or a single value.", - "oneOf": [ - { - "description": "A single string value.", - "type": "string" - }, - { - "description": "A single number value.", - "format": "double", - "type": "number" + "AuditLogsWarning": { + "description": "Warning message indicating something that went wrong with the query.", + "properties": { + "code": { + "description": "Unique code for this type of warning.", + "example": "unknown_index", + "type": "string" + }, + "detail": { + "description": "Detailed explanation of this specific warning.", + "example": "indexes: foo, bar", + "type": "string" + }, + "title": { + "description": "Short human-readable summary of the warning.", + "example": "One or several indexes are missing or invalid, results hold data from the other indexes", + "type": "string" + } + }, + "type": "object" + }, + "AuthNMapping": { + "description": "The AuthN Mapping object returned by API.", + "properties": { + "attributes": { + "description": "Attributes of AuthN Mapping.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + }, + "created_at": { + "description": "Creation time of the AuthN Mapping.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_at": { + "description": "Time of last AuthN Mapping modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "saml_assertion_attribute_id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + } }, - { - "description": "A timeseries array.", - "items": { - "description": "A timeseries point.", + "type": "object" + }, + "id": { + "description": "ID of the AuthN Mapping.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" + }, + "relationships": { + "description": "All relationships associated with AuthN Mapping.", + "properties": { + "role": { + "description": "Relationship to role.", "properties": { - "time": { - "description": "The time value for this point.", - "example": "2020-06-08T11:55:00.123Z", - "format": "date-time", - "type": "string" - }, - "value": { - "description": "The value for this point.", - "example": 19, - "format": "double", - "type": "number" + "data": { + "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": "object", + "x-merge-override": { + "required": false + } + }, + "saml_assertion_attribute": { + "description": "AuthN Mapping relationship to SAML Assertion Attribute.", + "properties": { + "data": { + "description": "Data of AuthN Mapping relationship to SAML Assertion Attribute.", + "properties": { + "id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + }, + "type": { + "default": "saml_assertion_attributes", + "description": "SAML assertion attributes resource type.", + "enum": [ + "saml_assertion_attributes" + ], + "example": "saml_assertion_attributes", + "type": "string", + "x-enum-varnames": [ + "SAML_ASSERTION_ATTRIBUTES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } } }, + "required": [ + "data" + ], "type": "object" }, - "type": "array", - "x-generate-alias-as-model": true - } - ] + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", + "properties": { + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" + }, + "type": { + "default": "authn_mappings", + "description": "AuthN Mappings resource type.", + "enum": [ + "authn_mappings" + ], + "example": "authn_mappings", + "type": "string", + "x-enum-varnames": [ + "AUTHN_MAPPINGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "AuthNMappingAttributes": { + "description": "Attributes of AuthN Mapping.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + }, + "created_at": { + "description": "Creation time of the AuthN Mapping.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_at": { + "description": "Time of last AuthN Mapping modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "saml_assertion_attribute_id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + } }, - "description": "A map of the metric name to value for regular compute, or a list of values for a timeseries.", "type": "object" }, - "CIAppCreatePipelineEventRequest": { - "description": "Request object.", + "AuthNMappingCreateAttributes": { + "description": "Key/Value pair of attributes used for create request.", "properties": { - "data": { - "description": "Data of the pipeline event to create.", + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + } + }, + "type": "object" + }, + "AuthNMappingCreateData": { + "description": "Data for creating an AuthN Mapping.", + "properties": { + "attributes": { + "description": "Key/Value pair of attributes used for create request.", "properties": { - "attributes": { - "description": "Attributes of the pipeline event to create.", + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "description": "Relationship of AuthN Mapping create object to a Role or Team.", + "oneOf": [ + { + "description": "Relationship of AuthN Mapping to a Role.", "properties": { - "env": { - "description": "The Datadog environment.", - "type": "string" - }, - "resource": { - "description": "Details of the CI pipeline event.", - "example": "Details TBD", - "oneOf": [ - { - "description": "Details of the top level pipeline, build, or workflow of your CI.", + "role": { + "description": "Relationship to role.", + "properties": { + "data": { + "description": "Relationship to role object.", "properties": { - "end": { - "description": "Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + "id": { + "description": "The unique identifier of the role.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", "type": "string" }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "is_manual": { - "description": "Whether or not the pipeline was triggered manually by the user.", - "example": false, - "nullable": true, - "type": "boolean" - }, - "is_resumed": { - "description": "Whether or not the pipeline was resumed after being blocked.", - "example": false, - "nullable": true, - "type": "boolean" - }, - "level": { - "default": "pipeline", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "type": { + "default": "roles", + "description": "Roles type.", "enum": [ - "pipeline" + "roles" ], - "example": "pipeline", + "example": "roles", "type": "string", "x-enum-varnames": [ - "PIPELINE" + "ROLES" ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "Name of the pipeline. All pipeline runs for the builds should have the same name.", - "example": "Deploy to AWS", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "parent_pipeline": { - "description": "If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.", - "nullable": true, - "properties": { - "id": { - "description": "UUID of a pipeline.", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", - "type": "string" - }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://ci-platform.com/pipelines/123456789", - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "partial_retry": { - "description": "Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one\nwhich only runs a subset of the original jobs.", - "example": false, - "type": "boolean" - }, - "pipeline_id": { - "description": "Any ID used in the provider to identify the pipeline run even if it is not unique across retries.\nIf the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.", - "example": "#023", - "type": "string" - }, - "previous_attempt": { - "description": "If the pipeline is a retry, this should contain the details of the previous attempt.", - "nullable": true, - "properties": { - "id": { - "description": "UUID of a pipeline.", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", - "type": "string" - }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://ci-platform.com/pipelines/123456789", - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "start": { - "description": "Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "role" + ], + "type": "object" + }, + { + "description": "Relationship of AuthN Mapping to a Team.", + "properties": { + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", + "properties": { + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", "type": "string" }, - "status": { - "description": "The final status of the pipeline.", + "type": { + "default": "team", + "description": "Team type", "enum": [ - "success", - "error", - "canceled", - "skipped", - "blocked" + "team" ], - "example": "success", + "example": "team", "type": "string", "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED", - "BLOCKED" + "TEAM" ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "unique_id": { - "description": "UUID of the pipeline run. The ID has to be unique across retries and pipelines,\nincluding partial retries.", - "example": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", - "type": "string" - }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://my-ci-provider.example/pipelines/my-pipeline/run/1", - "type": "string" } }, - "required": [ - "level", - "unique_id", - "name", - "url", - "start", - "end", - "status", - "partial_retry" + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "team" + ], + "type": "object" + } + ] + }, + "type": { + "default": "authn_mappings", + "description": "AuthN Mappings resource type.", + "enum": [ + "authn_mappings" + ], + "example": "authn_mappings", + "type": "string", + "x-enum-varnames": [ + "AUTHN_MAPPINGS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "AuthNMappingCreateRelationships": { + "description": "Relationship of AuthN Mapping create object to a Role or Team.", + "oneOf": [ + { + "description": "Relationship of AuthN Mapping to a Role.", + "properties": { + "role": { + "description": "Relationship to role.", + "properties": { + "data": { + "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" ], - "type": "object" + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "role" + ], + "type": "object" + }, + { + "description": "Relationship of AuthN Mapping to a Team.", + "properties": { + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", + "properties": { + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" }, - { - "description": "Details of a CI stage.", + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "team" + ], + "type": "object" + } + ] + }, + "AuthNMappingCreateRequest": { + "description": "Request for creating an AuthN Mapping.", + "properties": { + "data": { + "description": "Data for creating an AuthN Mapping.", + "properties": { + "attributes": { + "description": "Key/Value pair of attributes used for create request.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "description": "Relationship of AuthN Mapping create object to a Role or Team.", + "oneOf": [ + { + "description": "Relationship of AuthN Mapping to a Role.", + "properties": { + "role": { + "description": "Relationship to role.", "properties": { - "dependencies": { - "description": "A list of stage IDs that this stage depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" - ], - "items": { - "description": "A list of stage IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "end": { - "description": "Time when the stage run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, + "data": { + "description": "Relationship to role object.", "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "id": { + "description": "The unique identifier of the role.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" + }, + "type": { + "default": "roles", + "description": "Roles type.", "enum": [ - "provider", - "user", - "unknown" + "roles" ], + "example": "roles", "type": "string", "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" + "ROLES" ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" } }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "id": { - "description": "UUID for the stage. It has to be unique at least in the pipeline scope.", - "example": "562bdbbb-7cab-48c8-851c-b24ca14628bf", - "type": "string" - }, - "level": { - "default": "stage", - "description": "Used to distinguish between pipelines, stages, jobs and steps.", - "enum": [ - "stage" - ], - "example": "stage", - "type": "string", - "x-enum-varnames": [ - "STAGE" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the stage.", - "example": "build", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "start": { - "description": "Time when the stage run started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the stage.", - "enum": [ - "success", - "error", - "canceled", - "skipped" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" - ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" + "type": "object", + "x-merge-override": { + "required": false + } } }, - "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status" - ], - "type": "object" - }, - { - "description": "Details of a CI job.", + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "role" + ], + "type": "object" + }, + { + "description": "Relationship of AuthN Mapping to a Team.", + "properties": { + "team": { + "description": "Relationship to team.", "properties": { - "dependencies": { - "description": "A list of job IDs that this job depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" - ], - "items": { - "description": "A list of job IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "end": { - "description": "Time when the job run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, + "data": { + "description": "Relationship to Team object.", "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", "type": "string" }, "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "id": { - "description": "The UUID for the job. It has to be unique within each pipeline execution.", - "example": "c865bad4-de82-44b8-ade7-2c987528eb54", - "type": "string" - }, - "level": { - "default": "job", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", - "enum": [ - "job" - ], - "example": "job", - "type": "string", - "x-enum-varnames": [ - "JOB" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the job.", - "example": "test", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, - "type": "string" - }, - "start": { - "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the job.", - "enum": [ - "success", - "error", - "canceled", - "skipped" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" - ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "url": { - "description": "The URL to look at the job in the CI provider UI.", - "example": "https://ci-platform.com/job/your-job-name/build/123", - "type": "string" - } - }, - "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status", - "url" - ], - "type": "object" - }, - { - "description": "Details of a CI step.", - "properties": { - "end": { - "description": "Time when the step run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "default": "team", + "description": "Team type", "enum": [ - "provider", - "user", - "unknown" + "team" ], + "example": "team", "type": "string", "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" + "TEAM" ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "id": { - "description": "UUID for the step. It has to be unique within each pipeline execution.", - "example": "c2d517a8-4f3a-4b41-b4ae-69df0c864c79", - "type": "string" - }, - "job_id": { - "description": "The parent job UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "job_name": { - "description": "The parent job name (if applicable).", - "nullable": true, - "type": "string" - }, - "level": { - "default": "step", - "description": "Used to distinguish between pipelines, stages, jobs and steps.", - "enum": [ - "step" - ], - "example": "step", - "type": "string", - "x-enum-varnames": [ - "STEP" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the step.", - "example": "test-server", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" } }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, - "type": "string" - }, - "start": { - "description": "Time when the step run started. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the step.", - "enum": [ - "success", - "error" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR" - ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "url": { - "description": "The URL to look at the step in the CI provider UI.", - "nullable": true, - "type": "string" + "type": "object", + "x-merge-override": { + "required": false + } } }, - "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status" - ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } } - ] - }, - "service": { - "description": "If the CI provider is SaaS, use this to differentiate between instances.", - "type": "string" + }, + "required": [ + "team" + ], + "type": "object" } - }, - "required": [ - "resource" - ], - "type": "object" + ] }, "type": { - "default": "cipipeline_resource_request", - "description": "Type of the event.", + "default": "authn_mappings", + "description": "AuthN Mappings resource type.", "enum": [ - "cipipeline_resource_request" + "authn_mappings" ], - "example": "cipipeline_resource_request", + "example": "authn_mappings", "type": "string", "x-enum-varnames": [ - "CIPIPELINE_RESOURCE_REQUEST" + "AUTHN_MAPPINGS" ] } }, + "required": [ + "type" + ], "type": "object" } }, + "required": [ + "data" + ], "type": "object" }, - "CIAppCreatePipelineEventRequestAttributes": { - "description": "Attributes of the pipeline event to create.", - "properties": { - "env": { - "description": "The Datadog environment.", - "type": "string" + "AuthNMappingIncluded": { + "description": "Included data in the AuthN Mapping response.", + "oneOf": [ + { + "description": "SAML assertion attribute.", + "properties": { + "attributes": { + "description": "Key/Value pair of attributes used in SAML assertion attributes.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + }, + "type": { + "default": "saml_assertion_attributes", + "description": "SAML assertion attributes resource type.", + "enum": [ + "saml_assertion_attributes" + ], + "example": "saml_assertion_attributes", + "type": "string", + "x-enum-varnames": [ + "SAML_ASSERTION_ATTRIBUTES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } }, - "resource": { - "description": "Details of the CI pipeline event.", - "example": "Details TBD", - "oneOf": [ - { - "description": "Details of the top level pipeline, build, or workflow of your CI.", + { + "description": "Role object returned by the API.", + "properties": { + "attributes": { + "description": "Attributes of the role.", "properties": { - "end": { - "description": "Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", + "created_at": { + "description": "Creation time of the role.", "format": "date-time", + "readOnly": true, "type": "string" }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, + "modified_at": { + "description": "Time of last role modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", + "type": "string" + }, + "user_count": { + "description": "Number of users with that role.", + "format": "int64", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the role.", + "type": "string" + }, + "relationships": { + "description": "Relationships of the role object returned by the API.", + "properties": { + "permissions": { + "description": "Relationship to multiple permissions objects.", "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" + "data": { + "description": "Relationships to permission objects.", + "items": { + "description": "Relationship to permission object.", + "properties": { + "id": { + "description": "ID of the permission.", + "type": "string" + }, + "type": { + "default": "permissions", + "description": "Permissions resource type.", + "enum": [ + "permissions" + ], + "example": "permissions", + "type": "string", + "x-enum-varnames": [ + "PERMISSIONS" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" } }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "is_manual": { - "description": "Whether or not the pipeline was triggered manually by the user.", - "example": false, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" + }, + "type": { + "default": "roles", + "description": "Roles type.", + "enum": [ + "roles" + ], + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } + }, + "required": [ + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + { + "description": "Team.", + "properties": { + "attributes": { + "description": "Team attributes.", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", "nullable": true, - "type": "boolean" + "type": "string" }, - "is_resumed": { - "description": "Whether or not the pipeline was resumed after being blocked.", - "example": false, + "banner": { + "description": "Banner selection for the team", + "format": "int64", "nullable": true, - "type": "boolean" + "type": "integer" }, - "level": { - "default": "pipeline", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", - "enum": [ - "pipeline" - ], - "example": "pipeline", - "type": "string", - "x-enum-varnames": [ - "PIPELINE" - ] + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" + "link_count": { + "description": "The number of links belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" }, "name": { - "description": "Name of the pipeline. All pipeline runs for the builds should have the same name.", - "example": "Deploy to AWS", + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, "type": "string" }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "parent_pipeline": { - "description": "If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.", + "summary": { + "description": "A brief summary of the team, derived from the `description`", + "maxLength": 120, "nullable": true, - "properties": { - "id": { - "description": "UUID of a pipeline.", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", - "type": "string" - }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://ci-platform.com/pipelines/123456789", - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "partial_retry": { - "description": "Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one\nwhich only runs a subset of the original jobs.", - "example": false, - "type": "boolean" - }, - "pipeline_id": { - "description": "Any ID used in the provider to identify the pipeline run even if it is not unique across retries.\nIf the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.", - "example": "#023", "type": "string" }, - "previous_attempt": { - "description": "If the pipeline is a retry, this should contain the details of the previous attempt.", - "nullable": true, - "properties": { - "id": { - "description": "UUID of a pipeline.", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", - "type": "string" - }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://ci-platform.com/pipelines/123456789", - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, + "user_count": { + "description": "The number of users belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, "type": "integer" - }, - "start": { - "description": "Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the Team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object" + } + ] + }, + "AuthNMappingRelationshipToRole": { + "description": "Relationship of AuthN Mapping to a Role.", + "properties": { + "role": { + "description": "Relationship to role.", + "properties": { + "data": { + "description": "Relationship to role object.", + "properties": { + "id": { + "description": "The unique identifier of the role.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", "type": "string" }, - "status": { - "description": "The final status of the pipeline.", + "type": { + "default": "roles", + "description": "Roles type.", "enum": [ - "success", - "error", - "canceled", - "skipped", - "blocked" + "roles" ], - "example": "success", + "example": "roles", "type": "string", "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED", - "BLOCKED" + "ROLES" ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "unique_id": { - "description": "UUID of the pipeline run. The ID has to be unique across retries and pipelines,\nincluding partial retries.", - "example": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", - "type": "string" - }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://my-ci-provider.example/pipelines/my-pipeline/run/1", - "type": "string" } }, - "required": [ - "level", - "unique_id", - "name", - "url", - "start", - "end", - "status", - "partial_retry" - ], - "type": "object" - }, - { - "description": "Details of a CI stage.", + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "role" + ], + "type": "object" + }, + "AuthNMappingRelationshipToTeam": { + "description": "Relationship of AuthN Mapping to a Team.", + "properties": { + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", "properties": { - "dependencies": { - "description": "A list of stage IDs that this stage depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" - ], - "items": { - "description": "A list of stage IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "end": { - "description": "Time when the stage run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", "type": "string" }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" ], - "type": "object" - }, + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "team" + ], + "type": "object" + }, + "AuthNMappingRelationships": { + "description": "All relationships associated with AuthN Mapping.", + "properties": { + "role": { + "description": "Relationship to role.", + "properties": { + "data": { + "description": "Relationship to role object.", + "properties": { "id": { - "description": "UUID for the stage. It has to be unique at least in the pipeline scope.", - "example": "562bdbbb-7cab-48c8-851c-b24ca14628bf", + "description": "The unique identifier of the role.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", "type": "string" }, - "level": { - "default": "stage", - "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "type": { + "default": "roles", + "description": "Roles type.", "enum": [ - "stage" + "roles" ], - "example": "stage", + "example": "roles", "type": "string", "x-enum-varnames": [ - "STAGE" + "ROLES" ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the stage.", - "example": "build", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "start": { - "description": "Time when the stage run started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "saml_assertion_attribute": { + "description": "AuthN Mapping relationship to SAML Assertion Attribute.", + "properties": { + "data": { + "description": "Data of AuthN Mapping relationship to SAML Assertion Attribute.", + "properties": { + "id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", "type": "string" }, - "status": { - "description": "The final status of the stage.", + "type": { + "default": "saml_assertion_attributes", + "description": "SAML assertion attributes resource type.", "enum": [ - "success", - "error", - "canceled", - "skipped" + "saml_assertion_attributes" ], - "example": "success", + "example": "saml_assertion_attributes", "type": "string", "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" + "SAML_ASSERTION_ATTRIBUTES" ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" } }, "required": [ - "level", "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status" + "type" ], - "type": "object" - }, - { - "description": "Details of a CI job.", + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", "properties": { - "dependencies": { - "description": "A list of job IDs that this job depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" ], - "items": { - "description": "A list of job IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" + }, + "AuthNMappingResourceType": { + "description": "The type of resource being mapped to.", + "enum": [ + "role", + "team" + ], + "type": "string", + "x-enum-varnames": [ + "ROLE", + "TEAM" + ] + }, + "AuthNMappingResponse": { + "description": "AuthN Mapping response from the API.", + "properties": { + "data": { + "description": "The AuthN Mapping object returned by API.", + "properties": { + "attributes": { + "description": "Attributes of AuthN Mapping.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" }, - "end": { - "description": "Time when the job run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + }, + "created_at": { + "description": "Creation time of the AuthN Mapping.", "format": "date-time", + "readOnly": true, "type": "string" }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, + "modified_at": { + "description": "Time of last AuthN Mapping modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "saml_assertion_attribute_id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the AuthN Mapping.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" + }, + "relationships": { + "description": "All relationships associated with AuthN Mapping.", + "properties": { + "role": { + "description": "Relationship to role.", "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" + "data": { + "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": "object" + "type": "object", + "x-merge-override": { + "required": false + } }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, + "saml_assertion_attribute": { + "description": "AuthN Mapping relationship to SAML Assertion Attribute.", "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" + "data": { + "description": "Data of AuthN Mapping relationship to SAML Assertion Attribute.", + "properties": { + "id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + }, + "type": { + "default": "saml_assertion_attributes", + "description": "SAML assertion attributes resource type.", + "enum": [ + "saml_assertion_attributes" + ], + "example": "saml_assertion_attributes", + "type": "string", + "x-enum-varnames": [ + "SAML_ASSERTION_ATTRIBUTES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } } }, "required": [ - "repository_url", - "sha", - "author_email" + "data" ], "type": "object" }, - "id": { - "description": "The UUID for the job. It has to be unique within each pipeline execution.", - "example": "c865bad4-de82-44b8-ade7-2c987528eb54", - "type": "string" - }, - "level": { - "default": "job", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", - "enum": [ - "job" - ], - "example": "job", - "type": "string", - "x-enum-varnames": [ - "JOB" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", + "properties": { + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" + }, + "type": { + "default": "authn_mappings", + "description": "AuthN Mappings resource type.", + "enum": [ + "authn_mappings" + ], + "example": "authn_mappings", + "type": "string", + "x-enum-varnames": [ + "AUTHN_MAPPINGS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "included": { + "description": "Included data in the AuthN Mapping response.", + "items": { + "description": "Included data in the AuthN Mapping response.", + "oneOf": [ + { + "description": "SAML assertion attribute.", + "properties": { + "attributes": { + "description": "Key/Value pair of attributes used in SAML assertion attributes.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", "type": "string" }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the job.", - "example": "test", - "type": "string" + "type": { + "default": "saml_assertion_attributes", + "description": "SAML assertion attributes resource type.", + "enum": [ + "saml_assertion_attributes" + ], + "example": "saml_assertion_attributes", + "type": "string", + "x-enum-varnames": [ + "SAML_ASSERTION_ATTRIBUTES" + ] + } }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + { + "description": "Role object returned by the API.", + "properties": { + "attributes": { + "description": "Attributes of the role.", + "properties": { + "created_at": { + "description": "Creation time of the role.", + "format": "date-time", + "readOnly": true, "type": "string" }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" + "modified_at": { + "description": "Time of last role modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", + "type": "string" + }, + "user_count": { + "description": "Number of users with that role.", + "format": "int64", + "readOnly": true, + "type": "integer" + } }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } + "type": "object" }, - "type": "object" - }, - "parameters": { - "additionalProperties": { + "id": { + "description": "The unique identifier of the role.", "type": "string" }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" + "relationships": { + "description": "Relationships of the role object returned by the API.", + "properties": { + "permissions": { + "description": "Relationship to multiple permissions objects.", + "properties": { + "data": { + "description": "Relationships to permission objects.", + "items": { + "description": "Relationship to permission object.", + "properties": { + "id": { + "description": "ID of the permission.", + "type": "string" + }, + "type": { + "default": "permissions", + "description": "Permissions resource type.", + "enum": [ + "permissions" + ], + "example": "permissions", + "type": "string", + "x-enum-varnames": [ + "PERMISSIONS" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, - "type": "string" - }, - "start": { - "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the job.", - "enum": [ - "success", - "error", - "canceled", - "skipped" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" - ] + "type": { + "default": "roles", + "description": "Roles type.", + "enum": [ + "roles" + ], + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", + "required": [ + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + { + "description": "Team.", + "properties": { + "attributes": { + "description": "Team attributes.", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", + "nullable": true, + "type": "string" + }, + "banner": { + "description": "Banner selection for the team", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" + }, + "link_count": { + "description": "The number of links belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + }, + "name": { + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from the `description`", + "maxLength": 120, + "nullable": true, + "type": "string" + }, + "user_count": { + "description": "The number of users belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the Team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", "type": "string" }, - "nullable": true, - "type": "array" + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } }, - "url": { - "description": "The URL to look at the job in the CI provider UI.", - "example": "https://ci-platform.com/job/your-job-name/build/123", - "type": "string" + "type": "object" + } + ] + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthNMappingTeam": { + "description": "Team.", + "properties": { + "attributes": { + "description": "Team attributes.", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", + "nullable": true, + "type": "string" + }, + "banner": { + "description": "Banner selection for the team", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" + }, + "link_count": { + "description": "The number of links belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + }, + "name": { + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from the `description`", + "maxLength": 120, + "nullable": true, + "type": "string" + }, + "user_count": { + "description": "The number of users belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the Team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object" + }, + "AuthNMappingTeamAttributes": { + "description": "Team attributes.", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", + "nullable": true, + "type": "string" + }, + "banner": { + "description": "Banner selection for the team", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" + }, + "link_count": { + "description": "The number of links belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + }, + "name": { + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from the `description`", + "maxLength": 120, + "nullable": true, + "type": "string" + }, + "user_count": { + "description": "The number of users belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "AuthNMappingUpdateAttributes": { + "description": "Key/Value pair of attributes used for update request.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + } + }, + "type": "object" + }, + "AuthNMappingUpdateData": { + "description": "Data for updating an AuthN Mapping.", + "properties": { + "attributes": { + "description": "Key/Value pair of attributes used for update request.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the AuthN Mapping.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" + }, + "relationships": { + "description": "Relationship of AuthN Mapping update object to a Role or Team.", + "oneOf": [ + { + "description": "Relationship of AuthN Mapping to a Role.", + "properties": { + "role": { + "description": "Relationship to role.", + "properties": { + "data": { + "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": "object", + "x-merge-override": { + "required": false + } } }, "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status", - "url" + "role" ], "type": "object" }, { - "description": "Details of a CI step.", + "description": "Relationship of AuthN Mapping to a Team.", "properties": { - "end": { - "description": "Time when the step run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "id": { - "description": "UUID for the step. It has to be unique within each pipeline execution.", - "example": "c2d517a8-4f3a-4b41-b4ae-69df0c864c79", - "type": "string" - }, - "job_id": { - "description": "The parent job UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "job_name": { - "description": "The parent job name (if applicable).", - "nullable": true, - "type": "string" - }, - "level": { - "default": "step", - "description": "Used to distinguish between pipelines, stages, jobs and steps.", - "enum": [ - "step" - ], - "example": "step", - "type": "string", - "x-enum-varnames": [ - "STEP" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the step.", - "example": "test-server", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, + "team": { + "description": "Relationship to team.", "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" + "data": { + "description": "Relationship to Team object.", + "properties": { + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" + "type": "object", + "x-merge-override": { + "required": false + } } }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, - "type": "string" - }, - "start": { - "description": "Time when the step run started. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the step.", - "enum": [ - "success", - "error" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR" - ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "url": { - "description": "The URL to look at the step in the CI provider UI.", - "nullable": true, - "type": "string" + "type": "object", + "x-merge-override": { + "required": false + } } }, "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status" + "team" ], "type": "object" } ] }, - "service": { - "description": "If the CI provider is SaaS, use this to differentiate between instances.", - "type": "string" + "type": { + "default": "authn_mappings", + "description": "AuthN Mappings resource type.", + "enum": [ + "authn_mappings" + ], + "example": "authn_mappings", + "type": "string", + "x-enum-varnames": [ + "AUTHN_MAPPINGS" + ] } }, "required": [ - "resource" + "id", + "type" ], "type": "object" }, - "CIAppCreatePipelineEventRequestAttributesResource": { - "description": "Details of the CI pipeline event.", - "example": "Details TBD", + "AuthNMappingUpdateRelationships": { + "description": "Relationship of AuthN Mapping update object to a Role or Team.", "oneOf": [ { - "description": "Details of the top level pipeline, build, or workflow of your CI.", + "description": "Relationship of AuthN Mapping to a Role.", "properties": { - "end": { - "description": "Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, + "role": { + "description": "Relationship to role.", "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" + "data": { + "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": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "role" + ], + "type": "object" + }, + { + "description": "Relationship of AuthN Mapping to a Team.", + "properties": { + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", + "properties": { + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "team" + ], + "type": "object" + } + ] + }, + "AuthNMappingUpdateRequest": { + "description": "Request to update an AuthN Mapping.", + "properties": { + "data": { + "description": "Data for updating an AuthN Mapping.", + "properties": { + "attributes": { + "description": "Key/Value pair of attributes used for update request.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", "type": "string" }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", "type": "string" } }, - "required": [ - "repository_url", - "sha", - "author_email" - ], "type": "object" }, - "is_manual": { - "description": "Whether or not the pipeline was triggered manually by the user.", - "example": false, - "nullable": true, - "type": "boolean" + "id": { + "description": "ID of the AuthN Mapping.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "type": "string" }, - "is_resumed": { - "description": "Whether or not the pipeline was resumed after being blocked.", - "example": false, - "nullable": true, - "type": "boolean" + "relationships": { + "description": "Relationship of AuthN Mapping update object to a Role or Team.", + "oneOf": [ + { + "description": "Relationship of AuthN Mapping to a Role.", + "properties": { + "role": { + "description": "Relationship to role.", + "properties": { + "data": { + "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": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "role" + ], + "type": "object" + }, + { + "description": "Relationship of AuthN Mapping to a Team.", + "properties": { + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", + "properties": { + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "team" + ], + "type": "object" + } + ] }, - "level": { - "default": "pipeline", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "type": { + "default": "authn_mappings", + "description": "AuthN Mappings resource type.", "enum": [ - "pipeline" + "authn_mappings" ], - "example": "pipeline", + "example": "authn_mappings", "type": "string", "x-enum-varnames": [ - "PIPELINE" + "AUTHN_MAPPINGS" ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "Name of the pipeline. All pipeline runs for the builds should have the same name.", - "example": "Deploy to AWS", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "AuthNMappingsResponse": { + "description": "Array of AuthN Mappings response.", + "properties": { + "data": { + "description": "Array of returned AuthN Mappings.", + "items": { + "description": "The AuthN Mapping object returned by API.", + "properties": { + "attributes": { + "description": "Attributes of AuthN Mapping.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", "type": "string" }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + }, + "created_at": { + "description": "Creation time of the AuthN Mapping.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_at": { + "description": "Time of last AuthN Mapping modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "saml_assertion_attribute_id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + } }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } + "type": "object" }, - "type": "object" - }, - "parameters": { - "additionalProperties": { + "id": { + "description": "ID of the AuthN Mapping.", + "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", "type": "string" }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" + "relationships": { + "description": "All relationships associated with AuthN Mapping.", + "properties": { + "role": { + "description": "Relationship to role.", + "properties": { + "data": { + "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": "object", + "x-merge-override": { + "required": false + } + }, + "saml_assertion_attribute": { + "description": "AuthN Mapping relationship to SAML Assertion Attribute.", + "properties": { + "data": { + "description": "Data of AuthN Mapping relationship to SAML Assertion Attribute.", + "properties": { + "id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + }, + "type": { + "default": "saml_assertion_attributes", + "description": "SAML assertion attributes resource type.", + "enum": [ + "saml_assertion_attributes" + ], + "example": "saml_assertion_attributes", + "type": "string", + "x-enum-varnames": [ + "SAML_ASSERTION_ATTRIBUTES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "team": { + "description": "Relationship to team.", + "properties": { + "data": { + "description": "Relationship to Team object.", + "properties": { + "id": { + "description": "The unique identifier of the team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" }, - "nullable": true, - "type": "object" + "type": { + "default": "authn_mappings", + "description": "AuthN Mappings resource type.", + "enum": [ + "authn_mappings" + ], + "example": "authn_mappings", + "type": "string", + "x-enum-varnames": [ + "AUTHN_MAPPINGS" + ] + } }, - "parent_pipeline": { - "description": "If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.", - "nullable": true, - "properties": { - "id": { - "description": "UUID of a pipeline.", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", - "type": "string" + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + }, + "included": { + "description": "Included data in the AuthN Mapping response.", + "items": { + "description": "Included data in the AuthN Mapping response.", + "oneOf": [ + { + "description": "SAML assertion attribute.", + "properties": { + "attributes": { + "description": "Key/Value pair of attributes used in SAML assertion attributes.", + "properties": { + "attribute_key": { + "description": "Key portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "member-of", + "type": "string" + }, + "attribute_value": { + "description": "Value portion of a key/value pair of the attribute sent from the Identity Provider.", + "example": "Development", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the SAML assertion attribute.", + "example": "0", + "type": "string" + }, + "type": { + "default": "saml_assertion_attributes", + "description": "SAML assertion attributes resource type.", + "enum": [ + "saml_assertion_attributes" + ], + "example": "saml_assertion_attributes", + "type": "string", + "x-enum-varnames": [ + "SAML_ASSERTION_ATTRIBUTES" + ] + } }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://ci-platform.com/pipelines/123456789", - "type": "string" + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false } }, - "required": [ - "id" - ], - "type": "object" - }, - "partial_retry": { - "description": "Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one\nwhich only runs a subset of the original jobs.", - "example": false, - "type": "boolean" - }, - "pipeline_id": { - "description": "Any ID used in the provider to identify the pipeline run even if it is not unique across retries.\nIf the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.", - "example": "#023", - "type": "string" - }, - "previous_attempt": { - "description": "If the pipeline is a retry, this should contain the details of the previous attempt.", - "nullable": true, + { + "description": "Role object returned by the API.", + "properties": { + "attributes": { + "description": "Attributes of the role.", + "properties": { + "created_at": { + "description": "Creation time of the role.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_at": { + "description": "Time of last role modification.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the role. The name is neither unique nor a stable identifier of the role.", + "type": "string" + }, + "user_count": { + "description": "Number of users with that role.", + "format": "int64", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "The unique identifier of the role.", + "type": "string" + }, + "relationships": { + "description": "Relationships of the role object returned by the API.", + "properties": { + "permissions": { + "description": "Relationship to multiple permissions objects.", + "properties": { + "data": { + "description": "Relationships to permission objects.", + "items": { + "description": "Relationship to permission object.", + "properties": { + "id": { + "description": "ID of the permission.", + "type": "string" + }, + "type": { + "default": "permissions", + "description": "Permissions resource type.", + "enum": [ + "permissions" + ], + "example": "permissions", + "type": "string", + "x-enum-varnames": [ + "PERMISSIONS" + ] + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" + }, + "type": { + "default": "roles", + "description": "Roles type.", + "enum": [ + "roles" + ], + "example": "roles", + "type": "string", + "x-enum-varnames": [ + "ROLES" + ] + } + }, + "required": [ + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + { + "description": "Team.", + "properties": { + "attributes": { + "description": "Team attributes.", + "properties": { + "avatar": { + "description": "Unicode representation of the avatar for the team, limited to a single grapheme", + "example": "🥑", + "nullable": true, + "type": "string" + }, + "banner": { + "description": "Banner selection for the team", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "handle": { + "description": "The team's identifier", + "example": "example-team", + "maxLength": 195, + "type": "string" + }, + "link_count": { + "description": "The number of links belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + }, + "name": { + "description": "The name of the team", + "example": "Example Team", + "maxLength": 200, + "type": "string" + }, + "summary": { + "description": "A brief summary of the team, derived from the `description`", + "maxLength": 120, + "nullable": true, + "type": "string" + }, + "user_count": { + "description": "The number of users belonging to the team", + "format": "int32", + "maximum": 2147483647, + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "description": "The ID of the Team.", + "example": "f9bb8444-af7f-11ec-ac2c-da7ad0900001", + "type": "string" + }, + "type": { + "default": "team", + "description": "Team type", + "enum": [ + "team" + ], + "example": "team", + "type": "string", + "x-enum-varnames": [ + "TEAM" + ] + } + }, + "type": "object" + } + ] + }, + "type": "array" + }, + "meta": { + "description": "Object describing meta attributes of response.", + "properties": { + "page": { + "description": "Pagination object.", "properties": { - "id": { - "description": "UUID of a pipeline.", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", - "type": "string" + "total_count": { + "description": "Total count.", + "format": "int64", + "type": "integer" }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://ci-platform.com/pipelines/123456789", - "type": "string" + "total_filtered_count": { + "description": "Total count of elements matched by the filter.", + "format": "int64", + "type": "integer" } }, - "required": [ - "id" - ], "type": "object" + } + }, + "type": "object", + "x-merge-override": { + "properties": false + } + } + }, + "type": "object" + }, + "AuthNMappingsSort": { + "description": "Sorting options for AuthN Mappings.", + "enum": [ + "created_at", + "-created_at", + "role_id", + "-role_id", + "saml_assertion_attribute_id", + "-saml_assertion_attribute_id", + "role.name", + "-role.name", + "saml_assertion_attribute.attribute_key", + "-saml_assertion_attribute.attribute_key", + "saml_assertion_attribute.attribute_value", + "-saml_assertion_attribute.attribute_value" + ], + "type": "string", + "x-enum-varnames": [ + "CREATED_AT_ASCENDING", + "CREATED_AT_DESCENDING", + "ROLE_ID_ASCENDING", + "ROLE_ID_DESCENDING", + "SAML_ASSERTION_ATTRIBUTE_ID_ASCENDING", + "SAML_ASSERTION_ATTRIBUTE_ID_DESCENDING", + "ROLE_NAME_ASCENDING", + "ROLE_NAME_DESCENDING", + "SAML_ASSERTION_ATTRIBUTE_KEY_ASCENDING", + "SAML_ASSERTION_ATTRIBUTE_KEY_DESCENDING", + "SAML_ASSERTION_ATTRIBUTE_VALUE_ASCENDING", + "SAML_ASSERTION_ATTRIBUTE_VALUE_DESCENDING" + ] + }, + "AuthNMappingsType": { + "default": "authn_mappings", + "description": "AuthN Mappings resource type.", + "enum": [ + "authn_mappings" + ], + "example": "authn_mappings", + "type": "string", + "x-enum-varnames": [ + "AUTHN_MAPPINGS" + ] + }, + "AwsCURConfig": { + "description": "AWS CUR config.", + "properties": { + "attributes": { + "description": "Attributes for An AWS CUR config.", + "properties": { + "account_id": { + "description": "The AWS account ID.", + "example": "123456789123", + "type": "string" }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" + "bucket_name": { + "description": "The AWS bucket name used to store the Cost and Usage Report.", + "example": "dd-cost-bucket", + "type": "string" }, - "start": { - "description": "Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + "bucket_region": { + "description": "The region the bucket is located in.", + "example": "us-east-1", "type": "string" }, - "status": { - "description": "The final status of the pipeline.", - "enum": [ - "success", - "error", - "canceled", - "skipped", - "blocked" - ], - "example": "success", + "created_at": { + "description": "The timestamp when the AWS CUR config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED", - "BLOCKED" - ] + "x-merge-override": { + "format": false + } }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], + "error_messages": { + "description": "The error messages for the AWS CUR config.", "items": { - "description": "Tags in the form of `key:value`.", "type": "string" }, - "nullable": true, "type": "array" }, - "unique_id": { - "description": "UUID of the pipeline run. The ID has to be unique across retries and pipelines,\nincluding partial retries.", - "example": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" + }, + "report_name": { + "description": "The name of the Cost and Usage Report.", + "example": "dd-report-name", "type": "string" }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://my-ci-provider.example/pipelines/my-pipeline/run/1", + "report_prefix": { + "description": "The report prefix used for the Cost and Usage Report.", + "example": "dd-report-prefix", + "type": "string" + }, + "status": { + "description": "The status of the AWS CUR.", + "example": "active", "type": "string" + }, + "status_updated_at": { + "description": "The timestamp when the AWS CUR config status was updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "updated_at": { + "description": "The timestamp when the AWS CUR config status was updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } } }, "required": [ - "level", - "unique_id", - "name", - "url", - "start", - "end", - "status", - "partial_retry" + "account_id", + "bucket_name", + "bucket_region", + "report_name", + "report_prefix", + "status" ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } }, - { - "description": "Details of a CI stage.", - "properties": { - "dependencies": { - "description": "A list of stage IDs that this stage depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" - ], - "items": { - "description": "A list of stage IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "end": { - "description": "Time when the stage run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" + "id": { + "description": "The ID of the AWS CUR config.", + "format": "int64", + "type": "integer" + }, + "type": { + "default": "aws_cur_config", + "description": "Type of AWS CUR config.", + "enum": [ + "aws_cur_config" + ], + "example": "aws_cur_config", + "type": "string", + "x-enum-varnames": [ + "AWS_CUR_CONFIG" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "AwsCURConfigAttributes": { + "description": "Attributes for An AWS CUR config.", + "properties": { + "account_id": { + "description": "The AWS account ID.", + "example": "123456789123", + "type": "string" + }, + "bucket_name": { + "description": "The AWS bucket name used to store the Cost and Usage Report.", + "example": "dd-cost-bucket", + "type": "string" + }, + "bucket_region": { + "description": "The region the bucket is located in.", + "example": "us-east-1", + "type": "string" + }, + "created_at": { + "description": "The timestamp when the AWS CUR config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "error_messages": { + "description": "The error messages for the AWS CUR config.", + "items": { + "type": "string" + }, + "type": "array" + }, + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" + }, + "report_name": { + "description": "The name of the Cost and Usage Report.", + "example": "dd-report-name", + "type": "string" + }, + "report_prefix": { + "description": "The report prefix used for the Cost and Usage Report.", + "example": "dd-report-prefix", + "type": "string" + }, + "status": { + "description": "The status of the AWS CUR.", + "example": "active", + "type": "string" + }, + "status_updated_at": { + "description": "The timestamp when the AWS CUR config status was updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "updated_at": { + "description": "The timestamp when the AWS CUR config status was updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + } + }, + "required": [ + "account_id", + "bucket_name", + "bucket_region", + "report_name", + "report_prefix", + "status" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "AwsCURConfigPatchData": { + "description": "AWS CUR config Patch data.", + "properties": { + "attributes": { + "description": "Attributes for AWS CUR config Patch Request.", + "properties": { + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "example": true, + "type": "boolean" + } + }, + "required": [ + "is_enabled" + ], + "type": "object" + }, + "type": { + "default": "aws_cur_config_patch_request", + "description": "Type of AWS CUR config Patch Request.", + "enum": [ + "aws_cur_config_patch_request" + ], + "example": "aws_cur_config_patch_request", + "type": "string", + "x-enum-varnames": [ + "AWS_CUR_CONFIG_PATCH_REQUEST" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "AwsCURConfigPatchRequest": { + "description": "AWS CUR config Patch Request.", + "properties": { + "data": { + "description": "AWS CUR config Patch data.", + "properties": { + "attributes": { + "description": "Attributes for AWS CUR config Patch Request.", + "properties": { + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "example": true, + "type": "boolean" } }, "required": [ - "repository_url", - "sha", - "author_email" + "is_enabled" ], "type": "object" }, - "id": { - "description": "UUID for the stage. It has to be unique at least in the pipeline scope.", - "example": "562bdbbb-7cab-48c8-851c-b24ca14628bf", - "type": "string" - }, - "level": { - "default": "stage", - "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "type": { + "default": "aws_cur_config_patch_request", + "description": "Type of AWS CUR config Patch Request.", "enum": [ - "stage" + "aws_cur_config_patch_request" ], - "example": "stage", + "example": "aws_cur_config_patch_request", "type": "string", "x-enum-varnames": [ - "STAGE" + "AWS_CUR_CONFIG_PATCH_REQUEST" ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the stage.", - "example": "build", + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "AwsCURConfigPatchRequestAttributes": { + "description": "Attributes for AWS CUR config Patch Request.", + "properties": { + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "example": true, + "type": "boolean" + } + }, + "required": [ + "is_enabled" + ], + "type": "object" + }, + "AwsCURConfigPatchRequestType": { + "default": "aws_cur_config_patch_request", + "description": "Type of AWS CUR config Patch Request.", + "enum": [ + "aws_cur_config_patch_request" + ], + "example": "aws_cur_config_patch_request", + "type": "string", + "x-enum-varnames": [ + "AWS_CUR_CONFIG_PATCH_REQUEST" + ] + }, + "AwsCURConfigPostData": { + "description": "AWS CUR config Post data.", + "properties": { + "attributes": { + "description": "Attributes for AWS CUR config Post Request.", + "properties": { + "account_id": { + "description": "The AWS account ID.", + "example": "123456789123", "type": "string" }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", + "bucket_name": { + "description": "The AWS bucket name used to store the Cost and Usage Report.", + "example": "dd-cost-bucket", "type": "string" }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "bucket_region": { + "description": "The region the bucket is located in.", + "example": "us-east-1", "type": "string" }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "type": "boolean" + }, + "months": { + "description": "The month of the report.", + "format": "int32", + "maximum": 36, "type": "integer" }, - "start": { - "description": "Time when the stage run started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + "report_name": { + "description": "The name of the Cost and Usage Report.", + "example": "dd-report-name", "type": "string" }, - "status": { - "description": "The final status of the stage.", - "enum": [ - "success", - "error", - "canceled", - "skipped" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" - ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" + "report_prefix": { + "description": "The report prefix used for the Cost and Usage Report.", + "example": "dd-report-prefix", + "type": "string" } }, "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status" + "account_id", + "bucket_name", + "report_name", + "report_prefix" ], "type": "object" }, - { - "description": "Details of a CI job.", + "type": { + "default": "aws_cur_config_post_request", + "description": "Type of AWS CUR config Post Request.", + "enum": [ + "aws_cur_config_post_request" + ], + "example": "aws_cur_config_post_request", + "type": "string", + "x-enum-varnames": [ + "AWS_CUR_CONFIG_POST_REQUEST" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "AwsCURConfigPostRequest": { + "description": "AWS CUR config Post Request.", + "properties": { + "data": { + "description": "AWS CUR config Post data.", "properties": { - "dependencies": { - "description": "A list of job IDs that this job depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" - ], - "items": { - "description": "A list of job IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "end": { - "description": "Time when the job run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, + "attributes": { + "description": "Attributes for AWS CUR config Post Request.", "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, + "account_id": { + "description": "The AWS account ID.", + "example": "123456789123", "type": "string" }, - "committer_name": { - "description": "The committer name.", - "nullable": true, + "bucket_name": { + "description": "The AWS bucket name used to store the Cost and Usage Report.", + "example": "dd-cost-bucket", "type": "string" }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, + "bucket_region": { + "description": "The region the bucket is located in.", + "example": "us-east-1", "type": "string" }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "type": "boolean" }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" + "months": { + "description": "The month of the report.", + "format": "int32", + "maximum": 36, + "type": "integer" }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", + "report_name": { + "description": "The name of the Cost and Usage Report.", + "example": "dd-report-name", "type": "string" }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, + "report_prefix": { + "description": "The report prefix used for the Cost and Usage Report.", + "example": "dd-report-prefix", "type": "string" } }, "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "id": { - "description": "The UUID for the job. It has to be unique within each pipeline execution.", - "example": "c865bad4-de82-44b8-ade7-2c987528eb54", - "type": "string" - }, - "level": { - "default": "job", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", - "enum": [ - "job" - ], - "example": "job", - "type": "string", - "x-enum-varnames": [ - "JOB" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" + "account_id", + "bucket_name", + "report_name", + "report_prefix" ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the job.", - "example": "test", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, "type": "object" }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, - "type": "string" - }, - "start": { - "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the job.", + "type": { + "default": "aws_cur_config_post_request", + "description": "Type of AWS CUR config Post Request.", "enum": [ - "success", - "error", - "canceled", - "skipped" + "aws_cur_config_post_request" ], - "example": "success", + "example": "aws_cur_config_post_request", "type": "string", "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" + "AWS_CUR_CONFIG_POST_REQUEST" ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "url": { - "description": "The URL to look at the job in the CI provider UI.", - "example": "https://ci-platform.com/job/your-job-name/build/123", - "type": "string" } }, "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status", - "url" + "attributes", + "type" ], "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "AwsCURConfigPostRequestAttributes": { + "description": "Attributes for AWS CUR config Post Request.", + "properties": { + "account_id": { + "description": "The AWS account ID.", + "example": "123456789123", + "type": "string" }, - { - "description": "Details of a CI step.", + "bucket_name": { + "description": "The AWS bucket name used to store the Cost and Usage Report.", + "example": "dd-cost-bucket", + "type": "string" + }, + "bucket_region": { + "description": "The region the bucket is located in.", + "example": "us-east-1", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "type": "boolean" + }, + "months": { + "description": "The month of the report.", + "format": "int32", + "maximum": 36, + "type": "integer" + }, + "report_name": { + "description": "The name of the Cost and Usage Report.", + "example": "dd-report-name", + "type": "string" + }, + "report_prefix": { + "description": "The report prefix used for the Cost and Usage Report.", + "example": "dd-report-prefix", + "type": "string" + } + }, + "required": [ + "account_id", + "bucket_name", + "report_name", + "report_prefix" + ], + "type": "object" + }, + "AwsCURConfigPostRequestType": { + "default": "aws_cur_config_post_request", + "description": "Type of AWS CUR config Post Request.", + "enum": [ + "aws_cur_config_post_request" + ], + "example": "aws_cur_config_post_request", + "type": "string", + "x-enum-varnames": [ + "AWS_CUR_CONFIG_POST_REQUEST" + ] + }, + "AwsCURConfigResponse": { + "description": "Response of AWS CUR config.", + "properties": { + "data": { + "description": "AWS CUR config.", "properties": { - "end": { - "description": "Time when the step run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, + "attributes": { + "description": "Attributes for An AWS CUR config.", "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, + "account_id": { + "description": "The AWS account ID.", + "example": "123456789123", "type": "string" }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, + "bucket_name": { + "description": "The AWS bucket name used to store the Cost and Usage Report.", + "example": "dd-cost-bucket", "type": "string" }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, + "bucket_region": { + "description": "The region the bucket is located in.", + "example": "us-east-1", "type": "string" }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" + "created_at": { + "description": "The timestamp when the AWS CUR config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" + "error_messages": { + "description": "The error messages for the AWS CUR config.", + "items": { + "type": "string" + }, + "type": "array" }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, + "report_name": { + "description": "The name of the Cost and Usage Report.", + "example": "dd-report-name", "type": "string" }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, + "report_prefix": { + "description": "The report prefix used for the Cost and Usage Report.", + "example": "dd-report-prefix", "type": "string" }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", + "status": { + "description": "The status of the AWS CUR.", + "example": "active", "type": "string" }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" + "status_updated_at": { + "description": "The timestamp when the AWS CUR config status was updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" + "updated_at": { + "description": "The timestamp when the AWS CUR config status was updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } } }, "required": [ - "repository_url", - "sha", - "author_email" + "account_id", + "bucket_name", + "bucket_region", + "report_name", + "report_prefix", + "status" ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } }, "id": { - "description": "UUID for the step. It has to be unique within each pipeline execution.", - "example": "c2d517a8-4f3a-4b41-b4ae-69df0c864c79", - "type": "string" - }, - "job_id": { - "description": "The parent job UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "job_name": { - "description": "The parent job name (if applicable).", - "nullable": true, - "type": "string" + "description": "The ID of the AWS CUR config.", + "format": "int64", + "type": "integer" }, - "level": { - "default": "step", - "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "type": { + "default": "aws_cur_config", + "description": "Type of AWS CUR config.", "enum": [ - "step" + "aws_cur_config" ], - "example": "step", + "example": "aws_cur_config", "type": "string", "x-enum-varnames": [ - "STEP" + "AWS_CUR_CONFIG" ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" + }, + "AwsCURConfigType": { + "default": "aws_cur_config", + "description": "Type of AWS CUR config.", + "enum": [ + "aws_cur_config" + ], + "example": "aws_cur_config", + "type": "string", + "x-enum-varnames": [ + "AWS_CUR_CONFIG" + ] + }, + "AwsCURConfigsResponse": { + "description": "List of AWS CUR configs.", + "properties": { + "data": { + "description": "An AWS CUR config.", + "items": { + "description": "AWS CUR config.", + "properties": { + "attributes": { + "description": "Attributes for An AWS CUR config.", + "properties": { + "account_id": { + "description": "The AWS account ID.", + "example": "123456789123", + "type": "string" + }, + "bucket_name": { + "description": "The AWS bucket name used to store the Cost and Usage Report.", + "example": "dd-cost-bucket", + "type": "string" + }, + "bucket_region": { + "description": "The region the bucket is located in.", + "example": "us-east-1", + "type": "string" + }, + "created_at": { + "description": "The timestamp when the AWS CUR config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "error_messages": { + "description": "The error messages for the AWS CUR config.", + "items": { + "type": "string" + }, + "type": "array" + }, + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" + }, + "report_name": { + "description": "The name of the Cost and Usage Report.", + "example": "dd-report-name", + "type": "string" + }, + "report_prefix": { + "description": "The report prefix used for the Cost and Usage Report.", + "example": "dd-report-prefix", + "type": "string" + }, + "status": { + "description": "The status of the AWS CUR.", + "example": "active", + "type": "string" + }, + "status_updated_at": { + "description": "The timestamp when the AWS CUR config status was updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "updated_at": { + "description": "The timestamp when the AWS CUR config status was updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + } + }, + "required": [ + "account_id", + "bucket_name", + "bucket_region", + "report_name", + "report_prefix", + "status" + ], + "type": "object", + "x-merge-override": { + "required": false + } }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the step.", - "example": "test-server", - "type": "string" + "id": { + "description": "The ID of the AWS CUR config.", + "format": "int64", + "type": "integer" + }, + "type": { + "default": "aws_cur_config", + "description": "Type of AWS CUR config.", + "enum": [ + "aws_cur_config" + ], + "example": "aws_cur_config", + "type": "string", + "x-enum-varnames": [ + "AWS_CUR_CONFIG" + ] + } }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { + "required": [ + "attributes", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "type": "object" + }, + "AzureUCConfig": { + "description": "Azure config.", + "properties": { + "account_id": { + "description": "The tenant ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "client_id": { + "description": "The client ID of the Azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "created_at": { + "description": "The timestamp when the Azure config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "dataset_type": { + "description": "The dataset type of the Azure config.", + "example": "actual", + "type": "string" + }, + "error_messages": { + "description": "The error messages for the Azure config.", + "items": { + "type": "string" + }, + "type": "array" + }, + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" + }, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "id": { + "description": "The ID of the Azure config.", + "format": "int64", + "type": "integer" + }, + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" + }, + "scope": { + "description": "The scope of your observed subscription.", + "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "status": { + "description": "The status of the Azure config.", + "example": "active", + "type": "string" + }, + "status_updated_at": { + "description": "The timestamp when the Azure config status was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + }, + "updated_at": { + "description": "The timestamp when the Azure config was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + } + }, + "required": [ + "account_id", + "client_id", + "dataset_type", + "export_name", + "export_path", + "scope", + "status", + "storage_account", + "storage_container" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "AzureUCConfigPair": { + "description": "Azure config pair.", + "properties": { + "attributes": { + "description": "Attributes for Azure config pair.", + "properties": { + "configs": { + "description": "An Azure config.", + "items": { + "description": "Azure config.", + "properties": { + "account_id": { + "description": "The tenant ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", "type": "string" }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" + "client_id": { + "description": "The client ID of the Azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "created_at": { + "description": "The timestamp when the Azure config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "dataset_type": { + "description": "The dataset type of the Azure config.", + "example": "actual", + "type": "string" + }, + "error_messages": { + "description": "The error messages for the Azure config.", + "items": { + "type": "string" + }, + "type": "array" + }, + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" + }, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "id": { + "description": "The ID of the Azure config.", + "format": "int64", + "type": "integer" + }, + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" + }, + "scope": { + "description": "The scope of your observed subscription.", + "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "status": { + "description": "The status of the Azure config.", + "example": "active", + "type": "string" + }, + "status_updated_at": { + "description": "The timestamp when the Azure config status was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + }, + "updated_at": { + "description": "The timestamp when the Azure config was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + } }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" + "required": [ + "account_id", + "client_id", + "dataset_type", + "export_name", + "export_path", + "scope", + "status", + "storage_account", + "storage_container" + ], + "type": "object", + "x-merge-override": { + "required": false } }, - "type": "object" + "type": "array" }, - "parameters": { - "additionalProperties": { + "id": { + "description": "The ID of the Azure config pair.", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "configs" + ], + "type": "object", + "x-merge-override": { + "properties": false + } + }, + "id": { + "description": "The ID of Cloud Cost Management account.", + "format": "int64", + "type": "integer" + }, + "type": { + "default": "azure_uc_configs", + "description": "Type of Azure config pair.", + "enum": [ + "azure_uc_configs" + ], + "example": "azure_uc_configs", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIGS" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "AzureUCConfigPairAttributes": { + "description": "Attributes for Azure config pair.", + "properties": { + "configs": { + "description": "An Azure config.", + "items": { + "description": "Azure config.", + "properties": { + "account_id": { + "description": "The tenant ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", "type": "string" }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" + "client_id": { + "description": "The client ID of the Azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, - "type": "string" - }, - "start": { - "description": "Time when the step run started. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the step.", - "enum": [ - "success", - "error" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR" - ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", + "created_at": { + "description": "The timestamp when the Azure config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "dataset_type": { + "description": "The dataset type of the Azure config.", + "example": "actual", "type": "string" }, - "nullable": true, - "type": "array" + "error_messages": { + "description": "The error messages for the Azure config.", + "items": { + "type": "string" + }, + "type": "array" + }, + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" + }, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "id": { + "description": "The ID of the Azure config.", + "format": "int64", + "type": "integer" + }, + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" + }, + "scope": { + "description": "The scope of your observed subscription.", + "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "status": { + "description": "The status of the Azure config.", + "example": "active", + "type": "string" + }, + "status_updated_at": { + "description": "The timestamp when the Azure config status was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + }, + "updated_at": { + "description": "The timestamp when the Azure config was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + } }, - "url": { - "description": "The URL to look at the step in the CI provider UI.", - "nullable": true, - "type": "string" + "required": [ + "account_id", + "client_id", + "dataset_type", + "export_name", + "export_path", + "scope", + "status", + "storage_account", + "storage_container" + ], + "type": "object", + "x-merge-override": { + "required": false } }, - "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status" - ], - "type": "object" + "type": "array" + }, + "id": { + "description": "The ID of the Azure config pair.", + "format": "int64", + "type": "integer" } + }, + "required": [ + "configs" + ], + "type": "object", + "x-merge-override": { + "properties": false + } + }, + "AzureUCConfigPairType": { + "default": "azure_uc_configs", + "description": "Type of Azure config pair.", + "enum": [ + "azure_uc_configs" + ], + "example": "azure_uc_configs", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIGS" ] }, - "CIAppCreatePipelineEventRequestData": { - "description": "Data of the pipeline event to create.", + "AzureUCConfigPairsResponse": { + "description": "Response of Azure config pair.", "properties": { - "attributes": { - "description": "Attributes of the pipeline event to create.", + "data": { + "description": "Azure config pair.", "properties": { - "env": { - "description": "The Datadog environment.", - "type": "string" - }, - "resource": { - "description": "Details of the CI pipeline event.", - "example": "Details TBD", - "oneOf": [ - { - "description": "Details of the top level pipeline, build, or workflow of your CI.", - "properties": { - "end": { - "description": "Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } + "attributes": { + "description": "Attributes for Azure config pair.", + "properties": { + "configs": { + "description": "An Azure config.", + "items": { + "description": "Azure config.", + "properties": { + "account_id": { + "description": "The tenant ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" + "client_id": { + "description": "The client ID of the Azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "created_at": { + "description": "The timestamp when the Azure config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false } }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "is_manual": { - "description": "Whether or not the pipeline was triggered manually by the user.", - "example": false, - "nullable": true, - "type": "boolean" - }, - "is_resumed": { - "description": "Whether or not the pipeline was resumed after being blocked.", - "example": false, - "nullable": true, - "type": "boolean" - }, - "level": { - "default": "pipeline", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", - "enum": [ - "pipeline" - ], - "example": "pipeline", - "type": "string", - "x-enum-varnames": [ - "PIPELINE" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "dataset_type": { + "description": "The dataset type of the Azure config.", + "example": "actual", "type": "string" }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "Name of the pipeline. All pipeline runs for the builds should have the same name.", - "example": "Deploy to AWS", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", + "error_messages": { + "description": "The error messages for the Azure config.", + "items": { "type": "string" }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } + "type": "array" }, - "type": "object" - }, - "parameters": { - "additionalProperties": { + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", "type": "string" }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" }, - "nullable": true, - "type": "object" - }, - "parent_pipeline": { - "description": "If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.", - "nullable": true, - "properties": { - "id": { - "description": "UUID of a pipeline.", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", - "type": "string" - }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://ci-platform.com/pipelines/123456789", - "type": "string" - } + "id": { + "description": "The ID of the Azure config.", + "format": "int64", + "type": "integer" }, - "required": [ - "id" - ], - "type": "object" - }, - "partial_retry": { - "description": "Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one\nwhich only runs a subset of the original jobs.", - "example": false, - "type": "boolean" - }, - "pipeline_id": { - "description": "Any ID used in the provider to identify the pipeline run even if it is not unique across retries.\nIf the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.", - "example": "#023", - "type": "string" - }, - "previous_attempt": { - "description": "If the pipeline is a retry, this should contain the details of the previous attempt.", - "nullable": true, - "properties": { - "id": { - "description": "UUID of a pipeline.", - "example": "93bfeb70-af47-424d-908a-948d3f08e37f", - "type": "string" - }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://ci-platform.com/pipelines/123456789", - "type": "string" - } + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" }, - "required": [ - "id" - ], - "type": "object" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "start": { - "description": "Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the pipeline.", - "enum": [ - "success", - "error", - "canceled", - "skipped", - "blocked" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED", - "BLOCKED" - ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", + "scope": { + "description": "The scope of your observed subscription.", + "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", "type": "string" }, - "nullable": true, - "type": "array" + "status": { + "description": "The status of the Azure config.", + "example": "active", + "type": "string" + }, + "status_updated_at": { + "description": "The timestamp when the Azure config status was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + }, + "updated_at": { + "description": "The timestamp when the Azure config was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } + } }, - "unique_id": { - "description": "UUID of the pipeline run. The ID has to be unique across retries and pipelines,\nincluding partial retries.", - "example": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", + "required": [ + "account_id", + "client_id", + "dataset_type", + "export_name", + "export_path", + "scope", + "status", + "storage_account", + "storage_container" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + }, + "id": { + "description": "The ID of the Azure config pair.", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "configs" + ], + "type": "object", + "x-merge-override": { + "properties": false + } + }, + "id": { + "description": "The ID of Cloud Cost Management account.", + "format": "int64", + "type": "integer" + }, + "type": { + "default": "azure_uc_configs", + "description": "Type of Azure config pair.", + "enum": [ + "azure_uc_configs" + ], + "example": "azure_uc_configs", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIGS" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "type": "object" + }, + "AzureUCConfigPatchData": { + "description": "Azure config Patch data.", + "properties": { + "attributes": { + "description": "Attributes for Azure config Patch Request.", + "properties": { + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "example": true, + "type": "boolean" + } + }, + "required": [ + "is_enabled" + ], + "type": "object" + }, + "type": { + "default": "azure_uc_config_patch_request", + "description": "Type of Azure config Patch Request.", + "enum": [ + "azure_uc_config_patch_request" + ], + "example": "azure_uc_config_patch_request", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIG_PATCH_REQUEST" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "AzureUCConfigPatchRequest": { + "description": "Azure config Patch Request.", + "properties": { + "data": { + "description": "Azure config Patch data.", + "properties": { + "attributes": { + "description": "Attributes for Azure config Patch Request.", + "properties": { + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "example": true, + "type": "boolean" + } + }, + "required": [ + "is_enabled" + ], + "type": "object" + }, + "type": { + "default": "azure_uc_config_patch_request", + "description": "Type of Azure config Patch Request.", + "enum": [ + "azure_uc_config_patch_request" + ], + "example": "azure_uc_config_patch_request", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIG_PATCH_REQUEST" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "AzureUCConfigPatchRequestAttributes": { + "description": "Attributes for Azure config Patch Request.", + "properties": { + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "example": true, + "type": "boolean" + } + }, + "required": [ + "is_enabled" + ], + "type": "object" + }, + "AzureUCConfigPatchRequestType": { + "default": "azure_uc_config_patch_request", + "description": "Type of Azure config Patch Request.", + "enum": [ + "azure_uc_config_patch_request" + ], + "example": "azure_uc_config_patch_request", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIG_PATCH_REQUEST" + ] + }, + "AzureUCConfigPostData": { + "description": "Azure config Post data.", + "properties": { + "attributes": { + "description": "Attributes for Azure config Post Request.", + "properties": { + "account_id": { + "description": "The tenant ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "actual_bill_config": { + "description": "Bill config.", + "properties": { + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" + }, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + } + }, + "required": [ + "export_name", + "export_path", + "storage_account", + "storage_container" + ], + "type": "object" + }, + "amortized_bill_config": { + "description": "Bill config.", + "properties": { + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" + }, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + } + }, + "required": [ + "export_name", + "export_path", + "storage_account", + "storage_container" + ], + "type": "object" + }, + "client_id": { + "description": "The client ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "type": "boolean" + }, + "scope": { + "description": "The scope of your observed subscription.", + "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + } + }, + "required": [ + "account_id", + "actual_bill_config", + "amortized_bill_config", + "client_id", + "scope" + ], + "type": "object" + }, + "type": { + "default": "azure_uc_config_post_request", + "description": "Type of Azure config Post Request.", + "enum": [ + "azure_uc_config_post_request" + ], + "example": "azure_uc_config_post_request", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIG_POST_REQUEST" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "AzureUCConfigPostRequest": { + "description": "Azure config Post Request.", + "properties": { + "data": { + "description": "Azure config Post data.", + "properties": { + "attributes": { + "description": "Attributes for Azure config Post Request.", + "properties": { + "account_id": { + "description": "The tenant ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "actual_bill_config": { + "description": "Bill config.", + "properties": { + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", "type": "string" }, - "url": { - "description": "The URL to look at the pipeline in the CI provider UI.", - "example": "https://my-ci-provider.example/pipelines/my-pipeline/run/1", + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", "type": "string" } }, "required": [ - "level", - "unique_id", - "name", - "url", - "start", - "end", - "status", - "partial_retry" + "export_name", + "export_path", + "storage_account", + "storage_container" ], "type": "object" }, - { - "description": "Details of a CI stage.", + "amortized_bill_config": { + "description": "Bill config.", "properties": { - "dependencies": { - "description": "A list of stage IDs that this stage depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" - ], - "items": { - "description": "A list of stage IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" }, - "end": { - "description": "Time when the stage run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", "type": "string" }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + } + }, + "required": [ + "export_name", + "export_path", + "storage_account", + "storage_container" + ], + "type": "object" + }, + "client_id": { + "description": "The client ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "type": "boolean" + }, + "scope": { + "description": "The scope of your observed subscription.", + "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + } + }, + "required": [ + "account_id", + "actual_bill_config", + "amortized_bill_config", + "client_id", + "scope" + ], + "type": "object" + }, + "type": { + "default": "azure_uc_config_post_request", + "description": "Type of Azure config Post Request.", + "enum": [ + "azure_uc_config_post_request" + ], + "example": "azure_uc_config_post_request", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIG_POST_REQUEST" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "AzureUCConfigPostRequestAttributes": { + "description": "Attributes for Azure config Post Request.", + "properties": { + "account_id": { + "description": "The tenant ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "actual_bill_config": { + "description": "Bill config.", + "properties": { + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" + }, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + } + }, + "required": [ + "export_name", + "export_path", + "storage_account", + "storage_container" + ], + "type": "object" + }, + "amortized_bill_config": { + "description": "Bill config.", + "properties": { + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" + }, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + } + }, + "required": [ + "export_name", + "export_path", + "storage_account", + "storage_container" + ], + "type": "object" + }, + "client_id": { + "description": "The client ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the Cloud Cost Management account is enabled.", + "type": "boolean" + }, + "scope": { + "description": "The scope of your observed subscription.", + "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", + "type": "string" + } + }, + "required": [ + "account_id", + "actual_bill_config", + "amortized_bill_config", + "client_id", + "scope" + ], + "type": "object" + }, + "AzureUCConfigPostRequestType": { + "default": "azure_uc_config_post_request", + "description": "Type of Azure config Post Request.", + "enum": [ + "azure_uc_config_post_request" + ], + "example": "azure_uc_config_post_request", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIG_POST_REQUEST" + ] + }, + "AzureUCConfigsResponse": { + "description": "List of Azure accounts with configs.", + "properties": { + "data": { + "description": "An Azure config pair.", + "items": { + "description": "Azure config pair.", + "properties": { + "attributes": { + "description": "Attributes for Azure config pair.", + "properties": { + "configs": { + "description": "An Azure config.", + "items": { + "description": "Azure config.", "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, + "account_id": { + "description": "The tenant ID of the azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", "type": "string" }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, + "client_id": { + "description": "The client ID of the Azure account.", + "example": "1234abcd-1234-abcd-1234-1234abcd1234", "type": "string" }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" + "created_at": { + "description": "The timestamp when the Azure config was created.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, + "dataset_type": { + "description": "The dataset type of the Azure config.", + "example": "actual", "type": "string" }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" + "error_messages": { + "description": "The error messages for the Azure config.", + "items": { + "type": "string" + }, + "type": "array" }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", "type": "string" }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", "type": "string" }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" + "id": { + "description": "The ID of the Azure config.", + "format": "int64", + "type": "integer" }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" + "months": { + "deprecated": true, + "description": "The number of months the report has been backfilled.", + "format": "int32", + "maximum": 36, + "type": "integer" }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, + "scope": { + "description": "The scope of your observed subscription.", + "example": "subscriptions/1234abcd-1234-abcd-1234-1234abcd1234", "type": "string" }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, + "status": { + "description": "The status of the Azure config.", + "example": "active", "type": "string" }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" + "status_updated_at": { + "description": "The timestamp when the Azure config status was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", "type": "string" }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", "type": "string" + }, + "updated_at": { + "description": "The timestamp when the Azure config was last updated.", + "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{6}$", + "type": "string", + "x-merge-override": { + "format": false + } } }, "required": [ - "repository_url", - "sha", - "author_email" + "account_id", + "client_id", + "dataset_type", + "export_name", + "export_path", + "scope", + "status", + "storage_account", + "storage_container" ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } }, + "type": "array" + }, + "id": { + "description": "The ID of the Azure config pair.", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "configs" + ], + "type": "object", + "x-merge-override": { + "properties": false + } + }, + "id": { + "description": "The ID of Cloud Cost Management account.", + "format": "int64", + "type": "integer" + }, + "type": { + "default": "azure_uc_configs", + "description": "Type of Azure config pair.", + "enum": [ + "azure_uc_configs" + ], + "example": "azure_uc_configs", + "type": "string", + "x-enum-varnames": [ + "AZURE_UC_CONFIGS" + ] + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "type": "object" + }, + "BillConfig": { + "description": "Bill config.", + "properties": { + "export_name": { + "description": "The name of the configured Azure Export.", + "example": "dd-actual-export", + "type": "string" + }, + "export_path": { + "description": "The path where the Azure Export is saved.", + "example": "dd-export-path", + "type": "string" + }, + "storage_account": { + "description": "The name of the storage account where the Azure Export is saved.", + "example": "dd-storage-account", + "type": "string" + }, + "storage_container": { + "description": "The name of the storage container where the Azure Export is saved.", + "example": "dd-storage-container", + "type": "string" + } + }, + "required": [ + "export_name", + "export_path", + "storage_account", + "storage_container" + ], + "type": "object" + }, + "BillingDimensionsMappingBody": { + "description": "Billing dimensions mapping data.", + "items": { + "description": "The mapping data for each billing dimension.", + "properties": { + "attributes": { + "description": "Mapping of billing dimensions to endpoint keys.", + "properties": { + "endpoints": { + "description": "List of supported endpoints with their keys mapped to the billing_dimension.", + "items": { + "description": "An endpoint's keys mapped to the billing_dimension.", + "properties": { "id": { - "description": "UUID for the stage. It has to be unique at least in the pipeline scope.", - "example": "562bdbbb-7cab-48c8-851c-b24ca14628bf", + "description": "The URL for the endpoint.", + "example": "api/v1/usage/billable-summary", "type": "string" }, - "level": { - "default": "stage", - "description": "Used to distinguish between pipelines, stages, jobs and steps.", - "enum": [ - "stage" - ], - "example": "stage", - "type": "string", - "x-enum-varnames": [ - "STAGE" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "keys": { + "description": "The billing dimension.", "example": [ - "bundle_size:370", - "build_time:50021" + "apm_host_top99p", + "apm_host_sum" ], "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "example": "apm_host_top99p", "type": "string" }, - "nullable": true, "type": "array" }, - "name": { - "description": "The name for the stage.", - "example": "build", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "start": { - "description": "Time when the stage run started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, "status": { - "description": "The final status of the stage.", + "description": "Denotes whether mapping keys were available for this endpoint.", "enum": [ - "success", - "error", - "canceled", - "skipped" + "OK", + "NOT_FOUND" ], - "example": "success", "type": "string", "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" + "OK", + "NOT_FOUND" ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" } }, - "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status" - ], "type": "object" }, - { - "description": "Details of a CI job.", - "properties": { - "dependencies": { - "description": "A list of job IDs that this job depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" - ], - "items": { - "description": "A list of job IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "end": { - "description": "Time when the job run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "id": { - "description": "The UUID for the job. It has to be unique within each pipeline execution.", - "example": "c865bad4-de82-44b8-ade7-2c987528eb54", - "type": "string" - }, - "level": { - "default": "job", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", - "enum": [ - "job" - ], - "example": "job", - "type": "string", - "x-enum-varnames": [ - "JOB" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the job.", - "example": "test", + "type": "array" + }, + "in_app_label": { + "description": "Label used for the billing dimension in the Plan & Usage charts.", + "example": "APM Hosts", + "type": "string" + }, + "timestamp": { + "description": "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the billing dimension.", + "type": "string" + }, + "type": { + "default": "billing_dimensions", + "description": "Type of active billing dimensions data.", + "enum": [ + "billing_dimensions" + ], + "type": "string", + "x-enum-varnames": [ + "BILLING_DIMENSIONS" + ] + } + }, + "type": "object" + }, + "type": "array" + }, + "BillingDimensionsMappingBodyItem": { + "description": "The mapping data for each billing dimension.", + "properties": { + "attributes": { + "description": "Mapping of billing dimensions to endpoint keys.", + "properties": { + "endpoints": { + "description": "List of supported endpoints with their keys mapped to the billing_dimension.", + "items": { + "description": "An endpoint's keys mapped to the billing_dimension.", + "properties": { + "id": { + "description": "The URL for the endpoint.", + "example": "api/v1/usage/billable-summary", + "type": "string" + }, + "keys": { + "description": "The billing dimension.", + "example": [ + "apm_host_top99p", + "apm_host_sum" + ], + "items": { + "example": "apm_host_top99p", "type": "string" }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, + "type": "array" + }, + "status": { + "description": "Denotes whether mapping keys were available for this endpoint.", + "enum": [ + "OK", + "NOT_FOUND" + ], + "type": "string", + "x-enum-varnames": [ + "OK", + "NOT_FOUND" + ] + } + }, + "type": "object" + }, + "type": "array" + }, + "in_app_label": { + "description": "Label used for the billing dimension in the Plan & Usage charts.", + "example": "APM Hosts", + "type": "string" + }, + "timestamp": { + "description": "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the billing dimension.", + "type": "string" + }, + "type": { + "default": "billing_dimensions", + "description": "Type of active billing dimensions data.", + "enum": [ + "billing_dimensions" + ], + "type": "string", + "x-enum-varnames": [ + "BILLING_DIMENSIONS" + ] + } + }, + "type": "object" + }, + "BillingDimensionsMappingBodyItemAttributes": { + "description": "Mapping of billing dimensions to endpoint keys.", + "properties": { + "endpoints": { + "description": "List of supported endpoints with their keys mapped to the billing_dimension.", + "items": { + "description": "An endpoint's keys mapped to the billing_dimension.", + "properties": { + "id": { + "description": "The URL for the endpoint.", + "example": "api/v1/usage/billable-summary", + "type": "string" + }, + "keys": { + "description": "The billing dimension.", + "example": [ + "apm_host_top99p", + "apm_host_sum" + ], + "items": { + "example": "apm_host_top99p", + "type": "string" + }, + "type": "array" + }, + "status": { + "description": "Denotes whether mapping keys were available for this endpoint.", + "enum": [ + "OK", + "NOT_FOUND" + ], + "type": "string", + "x-enum-varnames": [ + "OK", + "NOT_FOUND" + ] + } + }, + "type": "object" + }, + "type": "array" + }, + "in_app_label": { + "description": "Label used for the billing dimension in the Plan & Usage charts.", + "example": "APM Hosts", + "type": "string" + }, + "timestamp": { + "description": "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "BillingDimensionsMappingBodyItemAttributesEndpointsItems": { + "description": "An endpoint's keys mapped to the billing_dimension.", + "properties": { + "id": { + "description": "The URL for the endpoint.", + "example": "api/v1/usage/billable-summary", + "type": "string" + }, + "keys": { + "description": "The billing dimension.", + "example": [ + "apm_host_top99p", + "apm_host_sum" + ], + "items": { + "example": "apm_host_top99p", + "type": "string" + }, + "type": "array" + }, + "status": { + "description": "Denotes whether mapping keys were available for this endpoint.", + "enum": [ + "OK", + "NOT_FOUND" + ], + "type": "string", + "x-enum-varnames": [ + "OK", + "NOT_FOUND" + ] + } + }, + "type": "object" + }, + "BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus": { + "description": "Denotes whether mapping keys were available for this endpoint.", + "enum": [ + "OK", + "NOT_FOUND" + ], + "type": "string", + "x-enum-varnames": [ + "OK", + "NOT_FOUND" + ] + }, + "BillingDimensionsMappingResponse": { + "description": "Billing dimensions mapping response.", + "properties": { + "data": { + "description": "Billing dimensions mapping data.", + "items": { + "description": "The mapping data for each billing dimension.", + "properties": { + "attributes": { + "description": "Mapping of billing dimensions to endpoint keys.", + "properties": { + "endpoints": { + "description": "List of supported endpoints with their keys mapped to the billing_dimension.", + "items": { + "description": "An endpoint's keys mapped to the billing_dimension.", "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", + "id": { + "description": "The URL for the endpoint.", + "example": "api/v1/usage/billable-summary", "type": "string" }, - "labels": { - "description": "A list of labels used to select or identify the node.", + "keys": { + "description": "The billing dimension.", "example": [ - "ubuntu-18.04", - "n2.large" + "apm_host_top99p", + "apm_host_sum" ], "items": { + "example": "apm_host_top99p", "type": "string" }, "type": "array" }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, - "type": "string" - }, - "start": { - "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "The final status of the job.", - "enum": [ - "success", - "error", - "canceled", - "skipped" - ], - "example": "success", - "type": "string", - "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" - ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "url": { - "description": "The URL to look at the job in the CI provider UI.", - "example": "https://ci-platform.com/job/your-job-name/build/123", - "type": "string" - } - }, - "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status", - "url" - ], - "type": "object" - }, - { - "description": "Details of a CI step.", - "properties": { - "end": { - "description": "Time when the step run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "status": { + "description": "Denotes whether mapping keys were available for this endpoint.", "enum": [ - "provider", - "user", - "unknown" + "OK", + "NOT_FOUND" ], "type": "string", "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" + "OK", + "NOT_FOUND" ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "id": { - "description": "UUID for the step. It has to be unique within each pipeline execution.", - "example": "c2d517a8-4f3a-4b41-b4ae-69df0c864c79", - "type": "string" - }, - "job_id": { - "description": "The parent job UUID (if applicable).", - "nullable": true, - "type": "string" - }, - "job_name": { - "description": "The parent job name (if applicable).", - "nullable": true, - "type": "string" - }, - "level": { - "default": "step", - "description": "Used to distinguish between pipelines, stages, jobs and steps.", - "enum": [ - "step" - ], - "example": "step", - "type": "string", - "x-enum-varnames": [ - "STEP" - ] - }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the step.", - "example": "test-server", - "type": "string" - }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" } }, "type": "object" }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, - "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", - "type": "string" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", - "nullable": true, + "type": "array" + }, + "in_app_label": { + "description": "Label used for the billing dimension in the Plan & Usage charts.", + "example": "APM Hosts", + "type": "string" + }, + "timestamp": { + "description": "Month in ISO-8601 format, UTC, and precise to the second: `[YYYY-MM-DDThh:mm:ss]`.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the billing dimension.", + "type": "string" + }, + "type": { + "default": "billing_dimensions", + "description": "Type of active billing dimensions data.", + "enum": [ + "billing_dimensions" + ], + "type": "string", + "x-enum-varnames": [ + "BILLING_DIMENSIONS" + ] + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkMuteFindingsRequest": { + "description": "The new bulk mute finding request.", + "properties": { + "data": { + "description": "Data object containing the new bulk mute properties of the finding.", + "properties": { + "attributes": { + "additionalProperties": false, + "description": "The mute properties to be updated.", + "properties": { + "mute": { + "additionalProperties": false, + "description": "Object containing the new mute properties of the findings.", + "properties": { + "description": { + "description": "Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.", "type": "string" }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, - "type": "string" + "expiration_date": { + "description": "The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.\nIf this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.\n", + "example": 1778721573794, + "format": "int64", + "type": "integer" }, - "start": { - "description": "Time when the step run started. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" + "muted": { + "description": "Whether those findings should be muted or unmuted.", + "example": true, + "type": "boolean" }, - "status": { - "description": "The final status of the step.", + "reason": { + "description": "The reason why this finding is muted or unmuted.", "enum": [ - "success", - "error" + "PENDING_FIX", + "FALSE_POSITIVE", + "ACCEPTED_RISK", + "NO_PENDING_FIX", + "HUMAN_ERROR", + "NO_LONGER_ACCEPTED_RISK", + "OTHER" ], - "example": "success", + "example": "ACCEPTED_RISK", "type": "string", "x-enum-varnames": [ - "SUCCESS", - "ERROR" + "PENDING_FIX", + "FALSE_POSITIVE", + "ACCEPTED_RISK", + "NO_PENDING_FIX", + "HUMAN_ERROR", + "NO_LONGER_ACCEPTED_RISK", + "OTHER" ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "url": { - "description": "The URL to look at the step in the CI provider UI.", - "nullable": true, - "type": "string" } }, "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status" + "muted", + "reason" ], "type": "object" } - ] + }, + "required": [ + "mute" + ], + "type": "object" }, - "service": { - "description": "If the CI provider is SaaS, use this to differentiate between instances.", + "id": { + "description": "UUID to identify the request", + "example": "dbe5f567-192b-4404-b908-29b70e1c9f76", "type": "string" + }, + "meta": { + "description": "Meta object containing the findings to be updated.", + "properties": { + "findings": { + "description": "Array of findings.", + "items": { + "description": "Finding object containing the finding information.", + "properties": { + "finding_id": { + "description": "The unique ID for this finding.", + "example": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": { + "default": "finding", + "description": "The JSON:API type for findings.", + "enum": [ + "finding" + ], + "example": "finding", + "type": "string", + "x-enum-varnames": [ + "FINDING" + ] } }, "required": [ - "resource" + "id", + "type", + "attributes", + "meta" ], "type": "object" - }, - "type": { - "default": "cipipeline_resource_request", - "description": "Type of the event.", - "enum": [ - "cipipeline_resource_request" - ], - "example": "cipipeline_resource_request", - "type": "string", - "x-enum-varnames": [ - "CIPIPELINE_RESOURCE_REQUEST" - ] } }, - "type": "object" - }, - "CIAppCreatePipelineEventRequestDataType": { - "default": "cipipeline_resource_request", - "description": "Type of the event.", - "enum": [ - "cipipeline_resource_request" + "required": [ + "data" ], - "example": "cipipeline_resource_request", - "type": "string", - "x-enum-varnames": [ - "CIPIPELINE_RESOURCE_REQUEST" - ] + "type": "object" }, - "CIAppEventAttributes": { - "description": "JSON object containing all event attributes and their associated values.", + "BulkMuteFindingsRequestAttributes": { + "additionalProperties": false, + "description": "The mute properties to be updated.", "properties": { - "attributes": { - "additionalProperties": {}, - "description": "JSON object of attributes from CI Visibility test events.", - "example": { - "customAttribute": 123, - "duration": 2345 - }, - "type": "object" - }, - "tags": { - "description": "Array of tags associated with your event.", - "example": [ - "team:A" - ], - "items": { - "description": "Tag associated with your event.", - "type": "string" + "mute": { + "additionalProperties": false, + "description": "Object containing the new mute properties of the findings.", + "properties": { + "description": { + "description": "Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.", + "type": "string" + }, + "expiration_date": { + "description": "The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.\nIf this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.\n", + "example": 1778721573794, + "format": "int64", + "type": "integer" + }, + "muted": { + "description": "Whether those findings should be muted or unmuted.", + "example": true, + "type": "boolean" + }, + "reason": { + "description": "The reason why this finding is muted or unmuted.", + "enum": [ + "PENDING_FIX", + "FALSE_POSITIVE", + "ACCEPTED_RISK", + "NO_PENDING_FIX", + "HUMAN_ERROR", + "NO_LONGER_ACCEPTED_RISK", + "OTHER" + ], + "example": "ACCEPTED_RISK", + "type": "string", + "x-enum-varnames": [ + "PENDING_FIX", + "FALSE_POSITIVE", + "ACCEPTED_RISK", + "NO_PENDING_FIX", + "HUMAN_ERROR", + "NO_LONGER_ACCEPTED_RISK", + "OTHER" + ] + } }, - "type": "array" - }, - "test_level": { - "description": "Test run level.", - "enum": [ - "session", - "module", - "suite", - "test" + "required": [ + "muted", + "reason" ], - "example": "test", - "type": "string", - "x-enum-varnames": [ - "SESSION", - "MODULE", - "SUITE", - "TEST" - ] + "type": "object" } }, + "required": [ + "mute" + ], "type": "object" }, - "CIAppGitInfo": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, + "BulkMuteFindingsRequestData": { + "description": "Data object containing the new bulk mute properties of the finding.", "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" + "attributes": { + "additionalProperties": false, + "description": "The mute properties to be updated.", + "properties": { + "mute": { + "additionalProperties": false, + "description": "Object containing the new mute properties of the findings.", + "properties": { + "description": { + "description": "Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.", + "type": "string" + }, + "expiration_date": { + "description": "The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.\nIf this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.\n", + "example": 1778721573794, + "format": "int64", + "type": "integer" + }, + "muted": { + "description": "Whether those findings should be muted or unmuted.", + "example": true, + "type": "boolean" + }, + "reason": { + "description": "The reason why this finding is muted or unmuted.", + "enum": [ + "PENDING_FIX", + "FALSE_POSITIVE", + "ACCEPTED_RISK", + "NO_PENDING_FIX", + "HUMAN_ERROR", + "NO_LONGER_ACCEPTED_RISK", + "OTHER" + ], + "example": "ACCEPTED_RISK", + "type": "string", + "x-enum-varnames": [ + "PENDING_FIX", + "FALSE_POSITIVE", + "ACCEPTED_RISK", + "NO_PENDING_FIX", + "HUMAN_ERROR", + "NO_LONGER_ACCEPTED_RISK", + "OTHER" + ] + } + }, + "required": [ + "muted", + "reason" + ], + "type": "object" + } + }, + "required": [ + "mute" + ], + "type": "object" }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, + "id": { + "description": "UUID to identify the request", + "example": "dbe5f567-192b-4404-b908-29b70e1c9f76", "type": "string" }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" + "meta": { + "description": "Meta object containing the findings to be updated.", + "properties": { + "findings": { + "description": "Array of findings.", + "items": { + "description": "Finding object containing the finding information.", + "properties": { + "finding_id": { + "description": "The unique ID for this finding.", + "example": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, + "type": { + "default": "finding", + "description": "The JSON:API type for findings.", + "enum": [ + "finding" + ], + "example": "finding", + "type": "string", + "x-enum-varnames": [ + "FINDING" + ] + } + }, + "required": [ + "id", + "type", + "attributes", + "meta" + ], + "type": "object" + }, + "BulkMuteFindingsRequestMeta": { + "description": "Meta object containing the findings to be updated.", + "properties": { + "findings": { + "description": "Array of findings.", + "items": { + "description": "Finding object containing the finding information.", + "properties": { + "finding_id": { + "description": "The unique ID for this finding.", + "example": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkMuteFindingsRequestMetaFindings": { + "description": "Finding object containing the finding information.", + "properties": { + "finding_id": { + "description": "The unique ID for this finding.", + "example": "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==", "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, + } + }, + "type": "object" + }, + "BulkMuteFindingsRequestProperties": { + "additionalProperties": false, + "description": "Object containing the new mute properties of the findings.", + "properties": { + "description": { + "description": "Additional information about the reason why those findings are muted or unmuted. This field has a maximum limit of 280 characters.", "type": "string" }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" + "expiration_date": { + "description": "The expiration date of the mute or unmute action (Unix ms). It must be set to a value greater than the current timestamp.\nIf this field is not provided, the finding will be muted or unmuted indefinitely, which is equivalent to setting the expiration date to 9999999999999.\n", + "example": 1778721573794, + "format": "int64", + "type": "integer" }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" + "muted": { + "description": "Whether those findings should be muted or unmuted.", + "example": true, + "type": "boolean" }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" + "reason": { + "description": "The reason why this finding is muted or unmuted.", + "enum": [ + "PENDING_FIX", + "FALSE_POSITIVE", + "ACCEPTED_RISK", + "NO_PENDING_FIX", + "HUMAN_ERROR", + "NO_LONGER_ACCEPTED_RISK", + "OTHER" + ], + "example": "ACCEPTED_RISK", + "type": "string", + "x-enum-varnames": [ + "PENDING_FIX", + "FALSE_POSITIVE", + "ACCEPTED_RISK", + "NO_PENDING_FIX", + "HUMAN_ERROR", + "NO_LONGER_ACCEPTED_RISK", + "OTHER" + ] } }, "required": [ - "repository_url", - "sha", - "author_email" + "muted", + "reason" ], "type": "object" }, - "CIAppGroupByHistogram": { - "description": "Used to perform a histogram computation (only for measure facets).\nAt most, 100 buckets are allowed, the number of buckets is `(max - min)/interval`.", + "BulkMuteFindingsResponse": { + "description": "The expected response schema.", "properties": { - "interval": { - "description": "The bin size of the histogram buckets.", - "example": 10, - "format": "double", - "type": "number" - }, - "max": { - "description": "The maximum value for the measure used in the histogram\n(values greater than this one are filtered out).", - "example": 100, - "format": "double", - "type": "number" - }, - "min": { - "description": "The minimum value for the measure used in the histogram\n(values smaller than this one are filtered out).", - "example": 50, - "format": "double", - "type": "number" + "data": { + "description": "Data object containing the ID of the request that was updated.", + "properties": { + "id": { + "description": "UUID used to identify the request", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "type": { + "default": "finding", + "description": "The JSON:API type for findings.", + "enum": [ + "finding" + ], + "example": "finding", + "type": "string", + "x-enum-varnames": [ + "FINDING" + ] + } + }, + "type": "object" } }, "required": [ - "interval", - "min", - "max" + "data" ], "type": "object" }, - "CIAppGroupByMissing": { - "description": "The value to use for logs that don't have the facet used to group-by.", - "oneOf": [ - { - "description": "The missing value to use if there is a string valued facet.", + "BulkMuteFindingsResponseData": { + "description": "Data object containing the ID of the request that was updated.", + "properties": { + "id": { + "description": "UUID used to identify the request", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", "type": "string" }, - { - "description": "The missing value to use if there is a number valued facet.", - "format": "double", - "type": "number" + "type": { + "default": "finding", + "description": "The JSON:API type for findings.", + "enum": [ + "finding" + ], + "example": "finding", + "type": "string", + "x-enum-varnames": [ + "FINDING" + ] } - ] - }, - "CIAppGroupByMissingNumber": { - "description": "The missing value to use if there is a number valued facet.", - "format": "double", - "type": "number" - }, - "CIAppGroupByMissingString": { - "description": "The missing value to use if there is a string valued facet.", - "type": "string" + }, + "type": "object" }, - "CIAppGroupByTotal": { - "default": false, - "description": "A resulting object to put the given computes in over all the matching records.", + "CIAppAggregateBucketValue": { + "description": "A bucket value, can either be a timeseries or a single value.", "oneOf": [ { - "description": "If set to true, creates an additional bucket labeled \"$facet_total\".", - "type": "boolean" - }, - { - "description": "A string to use as the key value for the total bucket.", + "description": "A single string value.", "type": "string" }, { - "description": "A number to use as the key value for the total bucket.", + "description": "A single number value.", "format": "double", "type": "number" + }, + { + "description": "A timeseries array.", + "items": { + "description": "A timeseries point.", + "properties": { + "time": { + "description": "The time value for this point.", + "example": "2020-06-08T11:55:00.123Z", + "format": "date-time", + "type": "string" + }, + "value": { + "description": "The value for this point.", + "example": 19, + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "type": "array", + "x-generate-alias-as-model": true } ] }, - "CIAppGroupByTotalBoolean": { - "description": "If set to true, creates an additional bucket labeled \"$facet_total\".", - "type": "boolean" - }, - "CIAppGroupByTotalNumber": { - "description": "A number to use as the key value for the total bucket.", + "CIAppAggregateBucketValueSingleNumber": { + "description": "A single number value.", "format": "double", "type": "number" }, - "CIAppGroupByTotalString": { - "description": "A string to use as the key value for the total bucket.", + "CIAppAggregateBucketValueSingleString": { + "description": "A single string value.", "type": "string" }, - "CIAppHostInfo": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { + "CIAppAggregateBucketValueTimeseries": { + "description": "A timeseries array.", + "items": { + "description": "A timeseries point.", + "properties": { + "time": { + "description": "The time value for this point.", + "example": "2020-06-08T11:55:00.123Z", + "format": "date-time", "type": "string" }, - "type": "array" + "value": { + "description": "The value for this point.", + "example": 19, + "format": "double", + "type": "number" + } }, - "name": { - "description": "Name for the host.", + "type": "object" + }, + "type": "array", + "x-generate-alias-as-model": true + }, + "CIAppAggregateBucketValueTimeseriesPoint": { + "description": "A timeseries point.", + "properties": { + "time": { + "description": "The time value for this point.", + "example": "2020-06-08T11:55:00.123Z", + "format": "date-time", "type": "string" }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" + "value": { + "description": "The value for this point.", + "example": 19, + "format": "double", + "type": "number" } }, "type": "object" }, - "CIAppPipelineEvent": { - "description": "Object description of a pipeline event after being processed and stored by Datadog.", + "CIAppAggregateSort": { + "description": "A sort rule. The `aggregation` field is required when `type` is `measure`.", + "example": { + "aggregation": "count", + "order": "asc" + }, "properties": { - "attributes": { - "description": "JSON object containing all event attributes and their associated values.", - "properties": { - "attributes": { - "additionalProperties": {}, - "description": "JSON object of attributes from CI Visibility pipeline events.", - "example": { - "customAttribute": 123, - "duration": 2345 - }, - "type": "object" - }, - "ci_level": { - "description": "Pipeline execution level.", - "enum": [ - "pipeline", - "stage", - "job", - "step", - "custom" - ], - "example": "pipeline", - "type": "string", - "x-enum-varnames": [ - "PIPELINE", - "STAGE", - "JOB", - "STEP", - "CUSTOM" - ] - }, - "tags": { - "description": "Array of tags associated with your event.", - "example": [ - "team:A" - ], - "items": { - "description": "Tag associated with your event.", - "type": "string" - }, - "type": "array" - } - }, - "type": "object" + "aggregation": { + "description": "An aggregation function.", + "enum": [ + "count", + "cardinality", + "pc75", + "pc90", + "pc95", + "pc98", + "pc99", + "sum", + "min", + "max", + "avg", + "median", + "latest", + "earliest", + "most_frequent", + "delta" + ], + "example": "pc90", + "type": "string", + "x-enum-varnames": [ + "COUNT", + "CARDINALITY", + "PERCENTILE_75", + "PERCENTILE_90", + "PERCENTILE_95", + "PERCENTILE_98", + "PERCENTILE_99", + "SUM", + "MIN", + "MAX", + "AVG", + "MEDIAN", + "LATEST", + "EARLIEST", + "MOST_FREQUENT", + "DELTA" + ] }, - "id": { - "description": "Unique ID of the event.", - "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", + "metric": { + "description": "The metric to sort by (only used for `type=measure`).", + "example": "@duration", "type": "string" }, - "type": { - "description": "Type of the event.", + "order": { + "description": "The order to use, ascending or descending.", "enum": [ - "cipipeline" + "asc", + "desc" ], - "example": "cipipeline", + "example": "asc", "type": "string", "x-enum-varnames": [ - "CIPIPELINE" + "ASCENDING", + "DESCENDING" ] - } - }, - "type": "object" - }, - "CIAppPipelineEventAttributes": { - "description": "JSON object containing all event attributes and their associated values.", - "properties": { - "attributes": { - "additionalProperties": {}, - "description": "JSON object of attributes from CI Visibility pipeline events.", - "example": { - "customAttribute": 123, - "duration": 2345 - }, - "type": "object" }, - "ci_level": { - "description": "Pipeline execution level.", + "type": { + "default": "alphabetical", + "description": "The type of sorting algorithm.", "enum": [ - "pipeline", - "stage", - "job", - "step", - "custom" + "alphabetical", + "measure" ], - "example": "pipeline", "type": "string", "x-enum-varnames": [ - "PIPELINE", - "STAGE", - "JOB", - "STEP", - "CUSTOM" + "ALPHABETICAL", + "MEASURE" ] - }, - "tags": { - "description": "Array of tags associated with your event.", - "example": [ - "team:A" - ], - "items": { - "description": "Tag associated with your event.", - "type": "string" - }, - "type": "array" } }, "type": "object" }, - "CIAppPipelineEventJob": { - "description": "Details of a CI job.", + "CIAppAggregateSortType": { + "default": "alphabetical", + "description": "The type of sorting algorithm.", + "enum": [ + "alphabetical", + "measure" + ], + "type": "string", + "x-enum-varnames": [ + "ALPHABETICAL", + "MEASURE" + ] + }, + "CIAppAggregationFunction": { + "description": "An aggregation function.", + "enum": [ + "count", + "cardinality", + "pc75", + "pc90", + "pc95", + "pc98", + "pc99", + "sum", + "min", + "max", + "avg", + "median", + "latest", + "earliest", + "most_frequent", + "delta" + ], + "example": "pc90", + "type": "string", + "x-enum-varnames": [ + "COUNT", + "CARDINALITY", + "PERCENTILE_75", + "PERCENTILE_90", + "PERCENTILE_95", + "PERCENTILE_98", + "PERCENTILE_99", + "SUM", + "MIN", + "MAX", + "AVG", + "MEDIAN", + "LATEST", + "EARLIEST", + "MOST_FREQUENT", + "DELTA" + ] + }, + "CIAppCIError": { + "description": "Contains information of the CI error.", + "nullable": true, "properties": { - "dependencies": { - "description": "A list of job IDs that this job depends on.", - "example": [ - "f7e6a006-a029-46c3-b0cc-742c9d7d363b", - "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" - ], - "items": { - "description": "A list of job IDs.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "end": { - "description": "Time when the job run finished. The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", - "type": "string" - }, - "error": { - "description": "Contains information of the CI error.", - "nullable": true, - "properties": { - "domain": { - "description": "Error category used to differentiate between issues related to the developer or provider environments.", - "enum": [ - "provider", - "user", - "unknown" - ], - "type": "string", - "x-enum-varnames": [ - "PROVIDER", - "USER", - "UNKNOWN" - ] - }, - "message": { - "description": "Error message.", - "maxLength": 5000, - "nullable": true, - "type": "string" - }, - "stack": { - "description": "The stack trace of the reported errors.", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Short description of the error type.", - "maxLength": 100, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "git": { - "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", - "nullable": true, - "properties": { - "author_email": { - "description": "The commit author email.", - "example": "author@example.com", - "type": "string" - }, - "author_name": { - "description": "The commit author name.", - "example": "John Doe", - "nullable": true, - "type": "string" - }, - "author_time": { - "description": "The commit author timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "branch": { - "description": "The branch name (if a tag use the tag parameter).", - "example": "feature-1", - "nullable": true, - "type": "string" - }, - "commit_time": { - "description": "The commit timestamp in RFC3339 format.", - "example": "2023-05-31T15:30:00Z", - "nullable": true, - "type": "string" - }, - "committer_email": { - "description": "The committer email.", - "example": "committer@example.com", - "nullable": true, - "type": "string" - }, - "committer_name": { - "description": "The committer name.", - "nullable": true, - "type": "string" - }, - "default_branch": { - "description": "The Git repository's default branch.", - "example": "main", - "nullable": true, - "type": "string" - }, - "message": { - "description": "The commit message.", - "example": "Instrumenting tests with CI Visibility.", - "nullable": true, - "type": "string" - }, - "repository_url": { - "description": "The URL of the repository.", - "example": "https://github.com/username/repository", - "type": "string" - }, - "sha": { - "description": "The git commit SHA.", - "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", - "pattern": "^[a-fA-F0-9]{40}$", - "type": "string" - }, - "tag": { - "description": "The tag name (if a branch use the branch parameter).", - "example": "v1.0.0", - "nullable": true, - "type": "string" - } - }, - "required": [ - "repository_url", - "sha", - "author_email" - ], - "type": "object" - }, - "id": { - "description": "The UUID for the job. It has to be unique within each pipeline execution.", - "example": "c865bad4-de82-44b8-ade7-2c987528eb54", - "type": "string" - }, - "level": { - "default": "job", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", "enum": [ - "job" + "provider", + "user", + "unknown" ], - "example": "job", "type": "string", "x-enum-varnames": [ - "JOB" + "PROVIDER", + "USER", + "UNKNOWN" ] }, - "metrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, + "message": { + "description": "Error message.", + "maxLength": 5000, "nullable": true, - "type": "array" - }, - "name": { - "description": "The name for the job.", - "example": "test", "type": "string" }, - "node": { - "description": "Contains information of the host running the pipeline, stage, job, or step.", - "nullable": true, - "properties": { - "hostname": { - "description": "FQDN of the host.", - "example": "www.example.com", - "type": "string" - }, - "labels": { - "description": "A list of labels used to select or identify the node.", - "example": [ - "ubuntu-18.04", - "n2.large" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Name for the host.", - "type": "string" - }, - "workspace": { - "description": "The path where the code is checked out.", - "example": "/home/workspace/code/my-repo", - "type": "string" - } - }, - "type": "object" - }, - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", - "example": { - "LOG_LEVEL": "debug" - }, + "stack": { + "description": "The stack trace of the reported errors.", "nullable": true, - "type": "object" - }, - "pipeline_name": { - "description": "The parent pipeline name.", - "example": "Build", - "type": "string" - }, - "pipeline_unique_id": { - "description": "The parent pipeline UUID.", - "example": "76b572af-a078-42b2-a08a-cc28f98b944f", "type": "string" }, - "queue_time": { - "description": "The queue time in milliseconds, if applicable.", - "example": 1004, - "format": "int64", - "minimum": 0, - "nullable": true, - "type": "integer" - }, - "stage_id": { - "description": "The parent stage UUID (if applicable).", + "type": { + "description": "Short description of the error type.", + "maxLength": 100, "nullable": true, "type": "string" + } + }, + "type": "object" + }, + "CIAppCIErrorDomain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "CIAppCompute": { + "description": "A compute rule to compute metrics or timeseries.", + "properties": { + "aggregation": { + "description": "An aggregation function.", + "enum": [ + "count", + "cardinality", + "pc75", + "pc90", + "pc95", + "pc98", + "pc99", + "sum", + "min", + "max", + "avg", + "median", + "latest", + "earliest", + "most_frequent", + "delta" + ], + "example": "pc90", + "type": "string", + "x-enum-varnames": [ + "COUNT", + "CARDINALITY", + "PERCENTILE_75", + "PERCENTILE_90", + "PERCENTILE_95", + "PERCENTILE_98", + "PERCENTILE_99", + "SUM", + "MIN", + "MAX", + "AVG", + "MEDIAN", + "LATEST", + "EARLIEST", + "MOST_FREQUENT", + "DELTA" + ] }, - "stage_name": { - "description": "The parent stage name (if applicable).", - "nullable": true, + "interval": { + "description": "The time buckets' size (only used for type=timeseries)\nDefaults to a resolution of 150 points.", + "example": "5m", "type": "string" }, - "start": { - "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", - "example": "2023-05-31T15:30:00Z", - "format": "date-time", + "metric": { + "description": "The metric to use.", + "example": "@duration", "type": "string" }, - "status": { - "description": "The final status of the job.", + "type": { + "default": "total", + "description": "The type of compute.", "enum": [ - "success", - "error", - "canceled", - "skipped" + "timeseries", + "total" ], - "example": "success", "type": "string", "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" + "TIMESERIES", + "TOTAL" ] - }, - "tags": { - "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", - "example": [ - "team:backend", - "type:deployment" - ], - "items": { - "description": "Tags in the form of `key:value`.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "url": { - "description": "The URL to look at the job in the CI provider UI.", - "example": "https://ci-platform.com/job/your-job-name/build/123", - "type": "string" } }, "required": [ - "level", - "id", - "name", - "pipeline_unique_id", - "pipeline_name", - "start", - "end", - "status", - "url" + "aggregation" ], "type": "object" }, - "CIAppPipelineEventJobLevel": { - "default": "job", - "description": "Used to distinguish between pipelines, stages, jobs, and steps.", - "enum": [ - "job" - ], - "example": "job", - "type": "string", - "x-enum-varnames": [ - "JOB" - ] - }, - "CIAppPipelineEventJobStatus": { - "description": "The final status of the job.", + "CIAppComputeType": { + "default": "total", + "description": "The type of compute.", "enum": [ - "success", - "error", - "canceled", - "skipped" + "timeseries", + "total" ], - "example": "success", "type": "string", "x-enum-varnames": [ - "SUCCESS", - "ERROR", - "CANCELED", - "SKIPPED" + "TIMESERIES", + "TOTAL" ] }, - "CIAppPipelineEventMetrics": { - "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", - "example": [ - "bundle_size:370", - "build_time:50021" - ], - "items": { - "description": "Metrics in the form of `key:value`. The value needs to be numeric.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "CIAppPipelineEventParameters": { + "CIAppComputes": { + "additionalProperties": { + "description": "A bucket value, can either be a timeseries or a single value.", + "oneOf": [ + { + "description": "A single string value.", + "type": "string" + }, + { + "description": "A single number value.", + "format": "double", + "type": "number" + }, + { + "description": "A timeseries array.", + "items": { + "description": "A timeseries point.", + "properties": { + "time": { + "description": "The time value for this point.", + "example": "2020-06-08T11:55:00.123Z", + "format": "date-time", + "type": "string" + }, + "value": { + "description": "The value for this point.", + "example": 19, + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "type": "array", + "x-generate-alias-as-model": true + } + ] + }, + "description": "A map of the metric name to value for regular compute, or a list of values for a timeseries.", + "type": "object" + }, + "CIAppCreatePipelineEventRequest": { + "description": "Request object.", + "properties": { + "data": { + "description": "Data of the pipeline event to create.", + "properties": { + "attributes": { + "description": "Attributes of the pipeline event to create.", + "properties": { + "env": { + "description": "The Datadog environment.", + "type": "string" + }, + "resource": { + "description": "Details of the CI pipeline event.", + "example": "Details TBD", + "oneOf": [ + { + "description": "Details of the top level pipeline, build, or workflow of your CI.", + "properties": { + "end": { + "description": "Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "is_manual": { + "description": "Whether or not the pipeline was triggered manually by the user.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "is_resumed": { + "description": "Whether or not the pipeline was resumed after being blocked.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "level": { + "default": "pipeline", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "pipeline" + ], + "example": "pipeline", + "type": "string", + "x-enum-varnames": [ + "PIPELINE" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "Name of the pipeline. All pipeline runs for the builds should have the same name.", + "example": "Deploy to AWS", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "parent_pipeline": { + "description": "If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.", + "nullable": true, + "properties": { + "id": { + "description": "UUID of a pipeline.", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://ci-platform.com/pipelines/123456789", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "partial_retry": { + "description": "Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one\nwhich only runs a subset of the original jobs.", + "example": false, + "type": "boolean" + }, + "pipeline_id": { + "description": "Any ID used in the provider to identify the pipeline run even if it is not unique across retries.\nIf the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.", + "example": "#023", + "type": "string" + }, + "previous_attempt": { + "description": "If the pipeline is a retry, this should contain the details of the previous attempt.", + "nullable": true, + "properties": { + "id": { + "description": "UUID of a pipeline.", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://ci-platform.com/pipelines/123456789", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "start": { + "description": "Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the pipeline.", + "enum": [ + "success", + "error", + "canceled", + "skipped", + "blocked" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED", + "BLOCKED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "unique_id": { + "description": "UUID of the pipeline run. The ID has to be unique across retries and pipelines,\nincluding partial retries.", + "example": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://my-ci-provider.example/pipelines/my-pipeline/run/1", + "type": "string" + } + }, + "required": [ + "level", + "unique_id", + "name", + "url", + "start", + "end", + "status", + "partial_retry" + ], + "type": "object" + }, + { + "description": "Details of a CI stage.", + "properties": { + "dependencies": { + "description": "A list of stage IDs that this stage depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of stage IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the stage run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "UUID for the stage. It has to be unique at least in the pipeline scope.", + "example": "562bdbbb-7cab-48c8-851c-b24ca14628bf", + "type": "string" + }, + "level": { + "default": "stage", + "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "enum": [ + "stage" + ], + "example": "stage", + "type": "string", + "x-enum-varnames": [ + "STAGE" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the stage.", + "example": "build", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "start": { + "description": "Time when the stage run started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the stage.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status" + ], + "type": "object" + }, + { + "description": "Details of a CI job.", + "properties": { + "dependencies": { + "description": "A list of job IDs that this job depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of job IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the job run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "The UUID for the job. It has to be unique within each pipeline execution.", + "example": "c865bad4-de82-44b8-ade7-2c987528eb54", + "type": "string" + }, + "level": { + "default": "job", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "job" + ], + "example": "job", + "type": "string", + "x-enum-varnames": [ + "JOB" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the job.", + "example": "test", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the job.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the job in the CI provider UI.", + "example": "https://ci-platform.com/job/your-job-name/build/123", + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status", + "url" + ], + "type": "object" + }, + { + "description": "Details of a CI step.", + "properties": { + "end": { + "description": "Time when the step run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "UUID for the step. It has to be unique within each pipeline execution.", + "example": "c2d517a8-4f3a-4b41-b4ae-69df0c864c79", + "type": "string" + }, + "job_id": { + "description": "The parent job UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "job_name": { + "description": "The parent job name (if applicable).", + "nullable": true, + "type": "string" + }, + "level": { + "default": "step", + "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "enum": [ + "step" + ], + "example": "step", + "type": "string", + "x-enum-varnames": [ + "STEP" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the step.", + "example": "test-server", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the step run started. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the step.", + "enum": [ + "success", + "error" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the step in the CI provider UI.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status" + ], + "type": "object" + } + ] + }, + "service": { + "description": "If the CI provider is SaaS, use this to differentiate between instances.", + "type": "string" + } + }, + "required": [ + "resource" + ], + "type": "object" + }, + "type": { + "default": "cipipeline_resource_request", + "description": "Type of the event.", + "enum": [ + "cipipeline_resource_request" + ], + "example": "cipipeline_resource_request", + "type": "string", + "x-enum-varnames": [ + "CIPIPELINE_RESOURCE_REQUEST" + ] + } + }, + "type": "object" + } + }, + "type": "object" + }, + "CIAppCreatePipelineEventRequestAttributes": { + "description": "Attributes of the pipeline event to create.", + "properties": { + "env": { + "description": "The Datadog environment.", + "type": "string" + }, + "resource": { + "description": "Details of the CI pipeline event.", + "example": "Details TBD", + "oneOf": [ + { + "description": "Details of the top level pipeline, build, or workflow of your CI.", + "properties": { + "end": { + "description": "Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "is_manual": { + "description": "Whether or not the pipeline was triggered manually by the user.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "is_resumed": { + "description": "Whether or not the pipeline was resumed after being blocked.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "level": { + "default": "pipeline", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "pipeline" + ], + "example": "pipeline", + "type": "string", + "x-enum-varnames": [ + "PIPELINE" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "Name of the pipeline. All pipeline runs for the builds should have the same name.", + "example": "Deploy to AWS", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "parent_pipeline": { + "description": "If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.", + "nullable": true, + "properties": { + "id": { + "description": "UUID of a pipeline.", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://ci-platform.com/pipelines/123456789", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "partial_retry": { + "description": "Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one\nwhich only runs a subset of the original jobs.", + "example": false, + "type": "boolean" + }, + "pipeline_id": { + "description": "Any ID used in the provider to identify the pipeline run even if it is not unique across retries.\nIf the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.", + "example": "#023", + "type": "string" + }, + "previous_attempt": { + "description": "If the pipeline is a retry, this should contain the details of the previous attempt.", + "nullable": true, + "properties": { + "id": { + "description": "UUID of a pipeline.", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://ci-platform.com/pipelines/123456789", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "start": { + "description": "Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the pipeline.", + "enum": [ + "success", + "error", + "canceled", + "skipped", + "blocked" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED", + "BLOCKED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "unique_id": { + "description": "UUID of the pipeline run. The ID has to be unique across retries and pipelines,\nincluding partial retries.", + "example": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://my-ci-provider.example/pipelines/my-pipeline/run/1", + "type": "string" + } + }, + "required": [ + "level", + "unique_id", + "name", + "url", + "start", + "end", + "status", + "partial_retry" + ], + "type": "object" + }, + { + "description": "Details of a CI stage.", + "properties": { + "dependencies": { + "description": "A list of stage IDs that this stage depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of stage IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the stage run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "UUID for the stage. It has to be unique at least in the pipeline scope.", + "example": "562bdbbb-7cab-48c8-851c-b24ca14628bf", + "type": "string" + }, + "level": { + "default": "stage", + "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "enum": [ + "stage" + ], + "example": "stage", + "type": "string", + "x-enum-varnames": [ + "STAGE" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the stage.", + "example": "build", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "start": { + "description": "Time when the stage run started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the stage.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status" + ], + "type": "object" + }, + { + "description": "Details of a CI job.", + "properties": { + "dependencies": { + "description": "A list of job IDs that this job depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of job IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the job run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "The UUID for the job. It has to be unique within each pipeline execution.", + "example": "c865bad4-de82-44b8-ade7-2c987528eb54", + "type": "string" + }, + "level": { + "default": "job", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "job" + ], + "example": "job", + "type": "string", + "x-enum-varnames": [ + "JOB" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the job.", + "example": "test", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the job.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the job in the CI provider UI.", + "example": "https://ci-platform.com/job/your-job-name/build/123", + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status", + "url" + ], + "type": "object" + }, + { + "description": "Details of a CI step.", + "properties": { + "end": { + "description": "Time when the step run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "UUID for the step. It has to be unique within each pipeline execution.", + "example": "c2d517a8-4f3a-4b41-b4ae-69df0c864c79", + "type": "string" + }, + "job_id": { + "description": "The parent job UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "job_name": { + "description": "The parent job name (if applicable).", + "nullable": true, + "type": "string" + }, + "level": { + "default": "step", + "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "enum": [ + "step" + ], + "example": "step", + "type": "string", + "x-enum-varnames": [ + "STEP" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the step.", + "example": "test-server", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the step run started. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the step.", + "enum": [ + "success", + "error" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the step in the CI provider UI.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status" + ], + "type": "object" + } + ] + }, + "service": { + "description": "If the CI provider is SaaS, use this to differentiate between instances.", + "type": "string" + } + }, + "required": [ + "resource" + ], + "type": "object" + }, + "CIAppCreatePipelineEventRequestAttributesResource": { + "description": "Details of the CI pipeline event.", + "example": "Details TBD", + "oneOf": [ + { + "description": "Details of the top level pipeline, build, or workflow of your CI.", + "properties": { + "end": { + "description": "Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "is_manual": { + "description": "Whether or not the pipeline was triggered manually by the user.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "is_resumed": { + "description": "Whether or not the pipeline was resumed after being blocked.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "level": { + "default": "pipeline", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "pipeline" + ], + "example": "pipeline", + "type": "string", + "x-enum-varnames": [ + "PIPELINE" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "Name of the pipeline. All pipeline runs for the builds should have the same name.", + "example": "Deploy to AWS", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "parent_pipeline": { + "description": "If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.", + "nullable": true, + "properties": { + "id": { + "description": "UUID of a pipeline.", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://ci-platform.com/pipelines/123456789", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "partial_retry": { + "description": "Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one\nwhich only runs a subset of the original jobs.", + "example": false, + "type": "boolean" + }, + "pipeline_id": { + "description": "Any ID used in the provider to identify the pipeline run even if it is not unique across retries.\nIf the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.", + "example": "#023", + "type": "string" + }, + "previous_attempt": { + "description": "If the pipeline is a retry, this should contain the details of the previous attempt.", + "nullable": true, + "properties": { + "id": { + "description": "UUID of a pipeline.", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://ci-platform.com/pipelines/123456789", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "start": { + "description": "Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the pipeline.", + "enum": [ + "success", + "error", + "canceled", + "skipped", + "blocked" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED", + "BLOCKED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "unique_id": { + "description": "UUID of the pipeline run. The ID has to be unique across retries and pipelines,\nincluding partial retries.", + "example": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://my-ci-provider.example/pipelines/my-pipeline/run/1", + "type": "string" + } + }, + "required": [ + "level", + "unique_id", + "name", + "url", + "start", + "end", + "status", + "partial_retry" + ], + "type": "object" + }, + { + "description": "Details of a CI stage.", + "properties": { + "dependencies": { + "description": "A list of stage IDs that this stage depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of stage IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the stage run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "UUID for the stage. It has to be unique at least in the pipeline scope.", + "example": "562bdbbb-7cab-48c8-851c-b24ca14628bf", + "type": "string" + }, + "level": { + "default": "stage", + "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "enum": [ + "stage" + ], + "example": "stage", + "type": "string", + "x-enum-varnames": [ + "STAGE" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the stage.", + "example": "build", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "start": { + "description": "Time when the stage run started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the stage.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status" + ], + "type": "object" + }, + { + "description": "Details of a CI job.", + "properties": { + "dependencies": { + "description": "A list of job IDs that this job depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of job IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the job run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "The UUID for the job. It has to be unique within each pipeline execution.", + "example": "c865bad4-de82-44b8-ade7-2c987528eb54", + "type": "string" + }, + "level": { + "default": "job", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "job" + ], + "example": "job", + "type": "string", + "x-enum-varnames": [ + "JOB" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the job.", + "example": "test", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the job.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the job in the CI provider UI.", + "example": "https://ci-platform.com/job/your-job-name/build/123", + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status", + "url" + ], + "type": "object" + }, + { + "description": "Details of a CI step.", + "properties": { + "end": { + "description": "Time when the step run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "UUID for the step. It has to be unique within each pipeline execution.", + "example": "c2d517a8-4f3a-4b41-b4ae-69df0c864c79", + "type": "string" + }, + "job_id": { + "description": "The parent job UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "job_name": { + "description": "The parent job name (if applicable).", + "nullable": true, + "type": "string" + }, + "level": { + "default": "step", + "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "enum": [ + "step" + ], + "example": "step", + "type": "string", + "x-enum-varnames": [ + "STEP" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the step.", + "example": "test-server", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the step run started. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the step.", + "enum": [ + "success", + "error" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the step in the CI provider UI.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status" + ], + "type": "object" + } + ] + }, + "CIAppCreatePipelineEventRequestData": { + "description": "Data of the pipeline event to create.", + "properties": { + "attributes": { + "description": "Attributes of the pipeline event to create.", + "properties": { + "env": { + "description": "The Datadog environment.", + "type": "string" + }, + "resource": { + "description": "Details of the CI pipeline event.", + "example": "Details TBD", + "oneOf": [ + { + "description": "Details of the top level pipeline, build, or workflow of your CI.", + "properties": { + "end": { + "description": "Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "is_manual": { + "description": "Whether or not the pipeline was triggered manually by the user.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "is_resumed": { + "description": "Whether or not the pipeline was resumed after being blocked.", + "example": false, + "nullable": true, + "type": "boolean" + }, + "level": { + "default": "pipeline", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "pipeline" + ], + "example": "pipeline", + "type": "string", + "x-enum-varnames": [ + "PIPELINE" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "Name of the pipeline. All pipeline runs for the builds should have the same name.", + "example": "Deploy to AWS", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "parent_pipeline": { + "description": "If the pipeline is triggered as child of another pipeline, this should contain the details of the parent pipeline.", + "nullable": true, + "properties": { + "id": { + "description": "UUID of a pipeline.", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://ci-platform.com/pipelines/123456789", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "partial_retry": { + "description": "Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one\nwhich only runs a subset of the original jobs.", + "example": false, + "type": "boolean" + }, + "pipeline_id": { + "description": "Any ID used in the provider to identify the pipeline run even if it is not unique across retries.\nIf the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.", + "example": "#023", + "type": "string" + }, + "previous_attempt": { + "description": "If the pipeline is a retry, this should contain the details of the previous attempt.", + "nullable": true, + "properties": { + "id": { + "description": "UUID of a pipeline.", + "example": "93bfeb70-af47-424d-908a-948d3f08e37f", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://ci-platform.com/pipelines/123456789", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "start": { + "description": "Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the pipeline.", + "enum": [ + "success", + "error", + "canceled", + "skipped", + "blocked" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED", + "BLOCKED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "unique_id": { + "description": "UUID of the pipeline run. The ID has to be unique across retries and pipelines,\nincluding partial retries.", + "example": "3eacb6f3-ff04-4e10-8a9c-46e6d054024a", + "type": "string" + }, + "url": { + "description": "The URL to look at the pipeline in the CI provider UI.", + "example": "https://my-ci-provider.example/pipelines/my-pipeline/run/1", + "type": "string" + } + }, + "required": [ + "level", + "unique_id", + "name", + "url", + "start", + "end", + "status", + "partial_retry" + ], + "type": "object" + }, + { + "description": "Details of a CI stage.", + "properties": { + "dependencies": { + "description": "A list of stage IDs that this stage depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of stage IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the stage run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "UUID for the stage. It has to be unique at least in the pipeline scope.", + "example": "562bdbbb-7cab-48c8-851c-b24ca14628bf", + "type": "string" + }, + "level": { + "default": "stage", + "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "enum": [ + "stage" + ], + "example": "stage", + "type": "string", + "x-enum-varnames": [ + "STAGE" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the stage.", + "example": "build", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "start": { + "description": "Time when the stage run started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the stage.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status" + ], + "type": "object" + }, + { + "description": "Details of a CI job.", + "properties": { + "dependencies": { + "description": "A list of job IDs that this job depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of job IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the job run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "The UUID for the job. It has to be unique within each pipeline execution.", + "example": "c865bad4-de82-44b8-ade7-2c987528eb54", + "type": "string" + }, + "level": { + "default": "job", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "job" + ], + "example": "job", + "type": "string", + "x-enum-varnames": [ + "JOB" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the job.", + "example": "test", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the job.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the job in the CI provider UI.", + "example": "https://ci-platform.com/job/your-job-name/build/123", + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status", + "url" + ], + "type": "object" + }, + { + "description": "Details of a CI step.", + "properties": { + "end": { + "description": "Time when the step run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "UUID for the step. It has to be unique within each pipeline execution.", + "example": "c2d517a8-4f3a-4b41-b4ae-69df0c864c79", + "type": "string" + }, + "job_id": { + "description": "The parent job UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "job_name": { + "description": "The parent job name (if applicable).", + "nullable": true, + "type": "string" + }, + "level": { + "default": "step", + "description": "Used to distinguish between pipelines, stages, jobs and steps.", + "enum": [ + "step" + ], + "example": "step", + "type": "string", + "x-enum-varnames": [ + "STEP" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the step.", + "example": "test-server", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the step run started. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the step.", + "enum": [ + "success", + "error" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the step in the CI provider UI.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status" + ], + "type": "object" + } + ] + }, + "service": { + "description": "If the CI provider is SaaS, use this to differentiate between instances.", + "type": "string" + } + }, + "required": [ + "resource" + ], + "type": "object" + }, + "type": { + "default": "cipipeline_resource_request", + "description": "Type of the event.", + "enum": [ + "cipipeline_resource_request" + ], + "example": "cipipeline_resource_request", + "type": "string", + "x-enum-varnames": [ + "CIPIPELINE_RESOURCE_REQUEST" + ] + } + }, + "type": "object" + }, + "CIAppCreatePipelineEventRequestDataType": { + "default": "cipipeline_resource_request", + "description": "Type of the event.", + "enum": [ + "cipipeline_resource_request" + ], + "example": "cipipeline_resource_request", + "type": "string", + "x-enum-varnames": [ + "CIPIPELINE_RESOURCE_REQUEST" + ] + }, + "CIAppEventAttributes": { + "description": "JSON object containing all event attributes and their associated values.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "JSON object of attributes from CI Visibility test events.", + "example": { + "customAttribute": 123, + "duration": 2345 + }, + "type": "object" + }, + "tags": { + "description": "Array of tags associated with your event.", + "example": [ + "team:A" + ], + "items": { + "description": "Tag associated with your event.", + "type": "string" + }, + "type": "array" + }, + "test_level": { + "description": "Test run level.", + "enum": [ + "session", + "module", + "suite", + "test" + ], + "example": "test", + "type": "string", + "x-enum-varnames": [ + "SESSION", + "MODULE", + "SUITE", + "TEST" + ] + } + }, + "type": "object" + }, + "CIAppGitInfo": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "CIAppGroupByHistogram": { + "description": "Used to perform a histogram computation (only for measure facets).\nAt most, 100 buckets are allowed, the number of buckets is `(max - min)/interval`.", + "properties": { + "interval": { + "description": "The bin size of the histogram buckets.", + "example": 10, + "format": "double", + "type": "number" + }, + "max": { + "description": "The maximum value for the measure used in the histogram\n(values greater than this one are filtered out).", + "example": 100, + "format": "double", + "type": "number" + }, + "min": { + "description": "The minimum value for the measure used in the histogram\n(values smaller than this one are filtered out).", + "example": 50, + "format": "double", + "type": "number" + } + }, + "required": [ + "interval", + "min", + "max" + ], + "type": "object" + }, + "CIAppGroupByMissing": { + "description": "The value to use for logs that don't have the facet used to group-by.", + "oneOf": [ + { + "description": "The missing value to use if there is a string valued facet.", + "type": "string" + }, + { + "description": "The missing value to use if there is a number valued facet.", + "format": "double", + "type": "number" + } + ] + }, + "CIAppGroupByMissingNumber": { + "description": "The missing value to use if there is a number valued facet.", + "format": "double", + "type": "number" + }, + "CIAppGroupByMissingString": { + "description": "The missing value to use if there is a string valued facet.", + "type": "string" + }, + "CIAppGroupByTotal": { + "default": false, + "description": "A resulting object to put the given computes in over all the matching records.", + "oneOf": [ + { + "description": "If set to true, creates an additional bucket labeled \"$facet_total\".", + "type": "boolean" + }, + { + "description": "A string to use as the key value for the total bucket.", + "type": "string" + }, + { + "description": "A number to use as the key value for the total bucket.", + "format": "double", + "type": "number" + } + ] + }, + "CIAppGroupByTotalBoolean": { + "description": "If set to true, creates an additional bucket labeled \"$facet_total\".", + "type": "boolean" + }, + "CIAppGroupByTotalNumber": { + "description": "A number to use as the key value for the total bucket.", + "format": "double", + "type": "number" + }, + "CIAppGroupByTotalString": { + "description": "A string to use as the key value for the total bucket.", + "type": "string" + }, + "CIAppHostInfo": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "CIAppPipelineEvent": { + "description": "Object description of a pipeline event after being processed and stored by Datadog.", + "properties": { + "attributes": { + "description": "JSON object containing all event attributes and their associated values.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "JSON object of attributes from CI Visibility pipeline events.", + "example": { + "customAttribute": 123, + "duration": 2345 + }, + "type": "object" + }, + "ci_level": { + "description": "Pipeline execution level.", + "enum": [ + "pipeline", + "stage", + "job", + "step", + "custom" + ], + "example": "pipeline", + "type": "string", + "x-enum-varnames": [ + "PIPELINE", + "STAGE", + "JOB", + "STEP", + "CUSTOM" + ] + }, + "tags": { + "description": "Array of tags associated with your event.", + "example": [ + "team:A" + ], + "items": { + "description": "Tag associated with your event.", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "description": "Unique ID of the event.", + "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", + "type": "string" + }, + "type": { + "description": "Type of the event.", + "enum": [ + "cipipeline" + ], + "example": "cipipeline", + "type": "string", + "x-enum-varnames": [ + "CIPIPELINE" + ] + } + }, + "type": "object" + }, + "CIAppPipelineEventAttributes": { + "description": "JSON object containing all event attributes and their associated values.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "JSON object of attributes from CI Visibility pipeline events.", + "example": { + "customAttribute": 123, + "duration": 2345 + }, + "type": "object" + }, + "ci_level": { + "description": "Pipeline execution level.", + "enum": [ + "pipeline", + "stage", + "job", + "step", + "custom" + ], + "example": "pipeline", + "type": "string", + "x-enum-varnames": [ + "PIPELINE", + "STAGE", + "JOB", + "STEP", + "CUSTOM" + ] + }, + "tags": { + "description": "Array of tags associated with your event.", + "example": [ + "team:A" + ], + "items": { + "description": "Tag associated with your event.", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CIAppPipelineEventJob": { + "description": "Details of a CI job.", + "properties": { + "dependencies": { + "description": "A list of job IDs that this job depends on.", + "example": [ + "f7e6a006-a029-46c3-b0cc-742c9d7d363b", + "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe" + ], + "items": { + "description": "A list of job IDs.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "end": { + "description": "Time when the job run finished. The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "error": { + "description": "Contains information of the CI error.", + "nullable": true, + "properties": { + "domain": { + "description": "Error category used to differentiate between issues related to the developer or provider environments.", + "enum": [ + "provider", + "user", + "unknown" + ], + "type": "string", + "x-enum-varnames": [ + "PROVIDER", + "USER", + "UNKNOWN" + ] + }, + "message": { + "description": "Error message.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "stack": { + "description": "The stack trace of the reported errors.", + "nullable": true, + "type": "string" + }, + "type": { + "description": "Short description of the error type.", + "maxLength": 100, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "git": { + "description": "If pipelines are triggered due to actions to a Git repository, then all payloads must contain this.\nNote that either `tag` or `branch` has to be provided, but not both.", + "nullable": true, + "properties": { + "author_email": { + "description": "The commit author email.", + "example": "author@example.com", + "type": "string" + }, + "author_name": { + "description": "The commit author name.", + "example": "John Doe", + "nullable": true, + "type": "string" + }, + "author_time": { + "description": "The commit author timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "branch": { + "description": "The branch name (if a tag use the tag parameter).", + "example": "feature-1", + "nullable": true, + "type": "string" + }, + "commit_time": { + "description": "The commit timestamp in RFC3339 format.", + "example": "2023-05-31T15:30:00Z", + "nullable": true, + "type": "string" + }, + "committer_email": { + "description": "The committer email.", + "example": "committer@example.com", + "nullable": true, + "type": "string" + }, + "committer_name": { + "description": "The committer name.", + "nullable": true, + "type": "string" + }, + "default_branch": { + "description": "The Git repository's default branch.", + "example": "main", + "nullable": true, + "type": "string" + }, + "message": { + "description": "The commit message.", + "example": "Instrumenting tests with CI Visibility.", + "nullable": true, + "type": "string" + }, + "repository_url": { + "description": "The URL of the repository.", + "example": "https://github.com/username/repository", + "type": "string" + }, + "sha": { + "description": "The git commit SHA.", + "example": "da39a3ee5e6b4b0d3255bfef95601890afd80709", + "pattern": "^[a-fA-F0-9]{40}$", + "type": "string" + }, + "tag": { + "description": "The tag name (if a branch use the branch parameter).", + "example": "v1.0.0", + "nullable": true, + "type": "string" + } + }, + "required": [ + "repository_url", + "sha", + "author_email" + ], + "type": "object" + }, + "id": { + "description": "The UUID for the job. It has to be unique within each pipeline execution.", + "example": "c865bad4-de82-44b8-ade7-2c987528eb54", + "type": "string" + }, + "level": { + "default": "job", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "job" + ], + "example": "job", + "type": "string", + "x-enum-varnames": [ + "JOB" + ] + }, + "metrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "name": { + "description": "The name for the job.", + "example": "test", + "type": "string" + }, + "node": { + "description": "Contains information of the host running the pipeline, stage, job, or step.", + "nullable": true, + "properties": { + "hostname": { + "description": "FQDN of the host.", + "example": "www.example.com", + "type": "string" + }, + "labels": { + "description": "A list of labels used to select or identify the node.", + "example": [ + "ubuntu-18.04", + "n2.large" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Name for the host.", + "type": "string" + }, + "workspace": { + "description": "The path where the code is checked out.", + "example": "/home/workspace/code/my-repo", + "type": "string" + } + }, + "type": "object" + }, + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "A map of key-value parameters or environment variables that were defined for the pipeline.", + "example": { + "LOG_LEVEL": "debug" + }, + "nullable": true, + "type": "object" + }, + "pipeline_name": { + "description": "The parent pipeline name.", + "example": "Build", + "type": "string" + }, + "pipeline_unique_id": { + "description": "The parent pipeline UUID.", + "example": "76b572af-a078-42b2-a08a-cc28f98b944f", + "type": "string" + }, + "queue_time": { + "description": "The queue time in milliseconds, if applicable.", + "example": 1004, + "format": "int64", + "minimum": 0, + "nullable": true, + "type": "integer" + }, + "stage_id": { + "description": "The parent stage UUID (if applicable).", + "nullable": true, + "type": "string" + }, + "stage_name": { + "description": "The parent stage name (if applicable).", + "nullable": true, + "type": "string" + }, + "start": { + "description": "Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.", + "example": "2023-05-31T15:30:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The final status of the job.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "tags": { + "description": "A list of user-defined tags. The tags must follow the `key:value` pattern.", + "example": [ + "team:backend", + "type:deployment" + ], + "items": { + "description": "Tags in the form of `key:value`.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "url": { + "description": "The URL to look at the job in the CI provider UI.", + "example": "https://ci-platform.com/job/your-job-name/build/123", + "type": "string" + } + }, + "required": [ + "level", + "id", + "name", + "pipeline_unique_id", + "pipeline_name", + "start", + "end", + "status", + "url" + ], + "type": "object" + }, + "CIAppPipelineEventJobLevel": { + "default": "job", + "description": "Used to distinguish between pipelines, stages, jobs, and steps.", + "enum": [ + "job" + ], + "example": "job", + "type": "string", + "x-enum-varnames": [ + "JOB" + ] + }, + "CIAppPipelineEventJobStatus": { + "description": "The final status of the job.", + "enum": [ + "success", + "error", + "canceled", + "skipped" + ], + "example": "success", + "type": "string", + "x-enum-varnames": [ + "SUCCESS", + "ERROR", + "CANCELED", + "SKIPPED" + ] + }, + "CIAppPipelineEventMetrics": { + "description": "A list of user-defined metrics. The metrics must follow the `key:value` pattern and the value must be numeric.", + "example": [ + "bundle_size:370", + "build_time:50021" + ], + "items": { + "description": "Metrics in the form of `key:value`. The value needs to be numeric.", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "CIAppPipelineEventParameters": { "additionalProperties": { "type": "string" }, @@ -177941,6 +182502,77 @@ } }, "type": "object" + }, + "XRayServicesIncludeAll": { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + "XRayServicesIncludeOnly": { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + }, + "XRayServicesList": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] } }, "securitySchemes": { @@ -217408,9 +222040,938 @@ } } }, - "description": "Schedule a downtime request body.", - "required": true - }, + "description": "Schedule a downtime request body.", + "required": true + }, + "responses": { + "200": { + "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.", + "properties": { + "data": { + "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" + }, + { + "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 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": { + "default": "downtime", + "description": "Downtime resource type.", + "enum": [ + "downtime" + ], + "example": "downtime", + "type": "string", + "x-enum-varnames": [ + "DOWNTIME" + ] + } + }, + "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" + } + } + }, + "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" + }, + "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": "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.", + "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" + }, + "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": "Cancel a downtime", + "tags": [ + "Downtimes" + ], + "x-menu-order": 4, + "x-permission": { + "operator": "OR", + "permissions": [ + "monitors_downtime" + ] + }, + "x-undo": { + "type": "idempotent" + } + }, + "get": { + "description": "Get downtime detail by `downtime_id`.", + "operationId": "GetDowntime", + "parameters": [ + { + "description": "ID of the downtime to fetch.", + "in": "path", + "name": "downtime_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`.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "example": "created_by,monitor", + "type": "string" + } + } + ], "responses": { "200": { "content": { @@ -218109,129 +223670,6 @@ }, "description": "Forbidden" }, - "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": "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.", - "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" - }, - "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": { @@ -218258,7 +223696,7 @@ } } }, - "description": "Downtime not found" + "description": "Not Found" }, "429": { "content": { @@ -218300,11 +223738,11 @@ ] } ], - "summary": "Cancel a downtime", + "summary": "Get a downtime", "tags": [ "Downtimes" ], - "x-menu-order": 4, + "x-menu-order": 5, "x-permission": { "operator": "OR", "permissions": [ @@ -218312,34 +223750,257 @@ ] }, "x-undo": { - "type": "idempotent" + "type": "safe" } }, - "get": { - "description": "Get downtime detail by `downtime_id`.", - "operationId": "GetDowntime", + "patch": { + "description": "Update a downtime by `downtime_id`.", + "operationId": "UpdateDowntime", "parameters": [ { - "description": "ID of the downtime to fetch.", + "description": "ID of the downtime to update.", "in": "path", "name": "downtime_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`.", - "in": "query", - "name": "include", - "required": false, - "schema": { - "example": "created_by,monitor", + "example": "00e000000-0000-1234-0000-000000000000", "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request for editing a downtime.", + "properties": { + "data": { + "description": "Object to update a downtime.", + "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", + "type": "string" + }, + "type": { + "default": "downtime", + "description": "Downtime resource type.", + "enum": [ + "downtime" + ], + "example": "downtime", + "type": "string", + "x-enum-varnames": [ + "DOWNTIME" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Update a downtime request body.", + "required": true + }, "responses": { "200": { "content": { @@ -219064,7 +224725,7 @@ } } }, - "description": "Not Found" + "description": "Downtime not found" }, "429": { "content": { @@ -219106,11 +224767,12 @@ ] } ], - "summary": "Get a downtime", + "summary": "Update a downtime", "tags": [ "Downtimes" ], - "x-menu-order": 5, + "x-codegen-request-body-name": "body", + "x-menu-order": 6, "x-permission": { "operator": "OR", "permissions": [ @@ -219118,891 +224780,1002 @@ ] }, "x-undo": { - "type": "safe" + "type": "idempotent" } - }, - "patch": { - "description": "Update a downtime by `downtime_id`.", - "operationId": "UpdateDowntime", + } + }, + "/api/v2/events": { + "get": { + "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.", + "operationId": "ListEvents", "parameters": [ { - "description": "ID of the downtime to update.", - "in": "path", - "name": "downtime_id", - "required": true, + "description": "Search query following events syntax.", + "in": "query", + "name": "filter[query]", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Minimum timestamp for requested events, in milliseconds.", + "in": "query", + "name": "filter[from]", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Maximum timestamp for requested events, in milliseconds.", + "in": "query", + "name": "filter[to]", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": "Order of events in results.", + "in": "query", + "name": "sort", + "required": false, + "schema": { + "description": "The sort parameters when querying events.", + "enum": [ + "timestamp", + "-timestamp" + ], + "type": "string", + "x-enum-varnames": [ + "TIMESTAMP_ASCENDING", + "TIMESTAMP_DESCENDING" + ] + } + }, + { + "description": "List following results with a cursor provided in the previous query.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "in": "query", + "name": "page[cursor]", + "required": false, "schema": { - "example": "00e000000-0000-1234-0000-000000000000", "type": "string" } + }, + { + "description": "Maximum number of events in the response.", + "example": 25, + "in": "query", + "name": "page[limit]", + "required": false, + "schema": { + "default": 10, + "format": "int32", + "maximum": 1000, + "type": "integer" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Request for editing a downtime.", - "properties": { - "data": { - "description": "Object to update a downtime.", - "properties": { - "attributes": { - "description": "Attributes of the downtime to update.", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The response object with all events matching the request and pagination information.", + "properties": { + "data": { + "description": "An array of events matching the request.", + "items": { + "description": "The object description of an event after being processed and stored by Datadog.", "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.", + "attributes": { + "description": "The object description of an event response attribute.", + "properties": { + "attributes": { + "description": "Object description of attributes from your event.", "properties": { - "monitor_id": { - "description": "ID of the monitor to prevent notifications.", - "example": 123, + "aggregation_key": { + "description": "Aggregation key of the event.", + "type": "string" + }, + "date_happened": { + "description": "POSIX timestamp of the event. Must be sent as an integer (no quotation marks).\nLimited to events no older than 18 hours.", "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" + }, + "device_name": { + "description": "A device name.", + "type": "string" + }, + "duration": { + "description": "The duration between the triggering of the event and its recovery in nanoseconds.", + "format": "int64", + "type": "integer" + }, + "event_object": { + "description": "The event title.", + "example": "Did you hear the news today?", + "type": "string" + }, + "evt": { + "description": "The metadata associated with a request.", + "properties": { + "id": { + "description": "Event ID.", + "example": "6509751066204996294", + "type": "string" + }, + "name": { + "description": "The event name.", + "type": "string" + }, + "source_id": { + "description": "Event source ID.", + "example": 36, + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Event type.", + "example": "error_tracking_alert", + "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": "object" + }, + "hostname": { + "description": "Host name to associate with the event.\nAny tags associated with the host are also applied to this event.", + "type": "string" + }, + "monitor": { + "description": "Attributes from the monitor that triggered the event.", + "nullable": true, + "properties": { + "created_at": { + "description": "The POSIX timestamp of the monitor's creation in nanoseconds.", + "example": 1646318692000, + "format": "int64", + "type": "integer" + }, + "group_status": { + "description": "Monitor group status used when there is no `result_groups`.", + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "groups": { + "description": "Groups to which the monitor belongs.", + "items": { + "description": "A group.", "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": "array" + }, + "id": { + "description": "The monitor ID.", + "format": "int64", + "type": "integer" + }, + "message": { + "description": "The monitor message.", + "type": "string" + }, + "modified": { + "description": "The monitor's last-modified timestamp.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The monitor name.", + "type": "string" + }, + "query": { + "description": "The query that triggers the alert.", + "type": "string" + }, + "tags": { + "description": "A list of tags attached to the monitor.", + "example": [ + "environment:test" + ], + "items": { + "description": "A tag.", "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" - } + "type": "array" }, - "required": [ - "duration", - "rrule" - ], - "type": "object" + "templated_name": { + "description": "The templated name of the monitor before resolving any template variables.", + "type": "string" + }, + "type": { + "description": "The monitor type.", + "type": "string" + } + }, + "type": "object" + }, + "monitor_groups": { + "description": "List of groups referred to in the event.", + "items": { + "description": "Group referred to in the event.", + "type": "string" }, + "nullable": true, "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", + "monitor_id": { + "description": "ID of the monitor that triggered the event. When an event isn't related to a monitor, this field is empty.", + "format": "int64", "nullable": true, - "type": "string" + "type": "integer" }, - "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", + "priority": { + "description": "The priority of the event's monitor. For example, `normal` or `low`.", + "enum": [ + "normal", + "low" + ], + "example": "normal", "nullable": true, + "type": "string", + "x-enum-varnames": [ + "NORMAL", + "LOW" + ] + }, + "related_event_id": { + "description": "Related event ID.", + "format": "int64", + "type": "integer" + }, + "service": { + "description": "Service that triggered the event.", + "example": "datadog-api", + "type": "string" + }, + "source_type_name": { + "description": "The type of event being posted.\nFor example, `nagios`, `hudson`, `jenkins`, `my_apps`, `chef`, `puppet`, `git` or `bitbucket`.\nThe list of standard source attribute values is [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).", + "type": "string" + }, + "sourcecategory": { + "description": "Identifier for the source of the event, such as a monitor alert, an externally-submitted event, or an integration.", + "type": "string" + }, + "status": { + "description": "If an alert event is enabled, its status is one of the following:\n`failure`, `error`, `warning`, `info`, `success`, `user_update`,\n`recommendation`, or `snapshot`.", + "enum": [ + "failure", + "error", + "warning", + "info", + "success", + "user_update", + "recommendation", + "snapshot" + ], + "example": "info", + "type": "string", + "x-enum-varnames": [ + "FAILURE", + "ERROR", + "WARNING", + "INFO", + "SUCCESS", + "USER_UPDATE", + "RECOMMENDATION", + "SNAPSHOT" + ] + }, + "tags": { + "description": "A list of tags to apply to the event.", + "example": [ + "environment:test" + ], + "items": { + "description": "A tag.", + "type": "string" + }, + "type": "array" + }, + "timestamp": { + "description": "POSIX timestamp of your event in milliseconds.", + "example": 1652274265000, + "format": "int64", + "type": "integer" + }, + "title": { + "description": "The event title.", + "example": "Oh boy!", "type": "string" } }, "type": "object" + }, + "message": { + "description": "The message of the event.", + "type": "string" + }, + "tags": { + "description": "An array of tags associated with the event.", + "example": [ + "team:A" + ], + "items": { + "description": "The tag associated with the event.", + "type": "string" + }, + "type": "array" + }, + "timestamp": { + "description": "The timestamp of the event.", + "example": "2019-01-02T09:42:36.320Z", + "format": "date-time", + "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", + "id": { + "description": "the unique ID of the event.", + "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", "type": "string" + }, + "type": { + "default": "event", + "description": "Type of the event.", + "enum": [ + "event" + ], + "example": "event", + "type": "string", + "x-enum-varnames": [ + "EVENT" + ] } }, "type": "object" }, - "id": { - "description": "ID of this downtime.", - "example": "00000000-0000-1234-0000-000000000000", + "type": "array" + }, + "links": { + "description": "Links attributes.", + "properties": { + "next": { + "description": "Link for the next set of results. Note that the request can also be made using the\nPOST endpoint.", + "example": "https://app.datadoghq.com/api/v2/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "description": "The metadata associated with a request.", + "properties": { + "elapsed": { + "description": "The time elapsed in milliseconds.", + "example": 132, + "format": "int64", + "type": "integer" + }, + "page": { + "description": "Pagination attributes.", + "properties": { + "after": { + "description": "The cursor to use to get the next results, if any. To make the next request, use the same\nparameters with the addition of the `page[cursor]`.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + } + }, + "type": "object" + }, + "request_id": { + "description": "The identifier of the request.", + "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", + "type": "string" + }, + "status": { + "description": "The request status.", + "example": "done", + "type": "string" + }, + "warnings": { + "description": "A list of warnings (non-fatal errors) encountered. Partial results might be returned if\nwarnings are present in the response.", + "items": { + "description": "A warning message indicating something is wrong with the query.", + "properties": { + "code": { + "description": "A unique code for this type of warning.", + "example": "unknown_index", + "type": "string" + }, + "detail": { + "description": "A detailed explanation of this specific warning.", + "example": "indexes: foo, bar", + "type": "string" + }, + "title": { + "description": "A short human-readable summary of the warning.", + "example": "One or several indexes are missing or invalid. Results hold data from the other indexes.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "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": "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": { - "default": "downtime", - "description": "Downtime resource type.", - "enum": [ - "downtime" - ], - "example": "downtime", - "type": "string", - "x-enum-varnames": [ - "DOWNTIME" - ] + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "events_read" + ] + } + ], + "summary": "Get a list of events", + "tags": [ + "Events" + ], + "x-menu-order": 1, + "x-pagination": { + "cursorParam": "page[cursor]", + "cursorPath": "meta.page.after", + "limitParam": "page[limit]", + "resultsPath": "data" + }, + "x-permission": { + "operator": "OR", + "permissions": [ + "events_read" + ] + }, + "x-undo": { + "type": "safe" + } + }, + "x-merge-override": { + "get": false + } + }, + "/api/v2/events/search": { + "post": { + "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 build complex events filtering and search.", + "operationId": "SearchEvents", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "The object sent with the request to retrieve a list of events from your organization.", + "properties": { + "filter": { + "description": "The search and filter query settings.", + "properties": { + "from": { + "default": "now-15m", + "description": "The minimum time for the requested events. Supports date math and regular timestamps in milliseconds.", + "example": "now-15m", + "type": "string" + }, + "query": { + "default": "*", + "description": "The search query following the event search syntax.", + "example": "service:web* AND @http.status_code:[200 TO 299]", + "type": "string" + }, + "to": { + "default": "now", + "description": "The maximum time for the requested events. Supports date math and regular timestamps in milliseconds.", + "example": "now", + "type": "string" + } + }, + "type": "object" + }, + "options": { + "description": "The global query options that are used. Either provide a timezone or a time offset but not both,\notherwise the query fails.", + "properties": { + "timeOffset": { + "description": "The time offset to apply to the query in seconds.", + "format": "int64", + "type": "integer" + }, + "timezone": { + "default": "UTC", + "description": "The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).", + "example": "GMT", + "type": "string" + } + }, + "type": "object" + }, + "page": { + "description": "Pagination settings.", + "properties": { + "cursor": { + "description": "The returned paging point to use to get the next results.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + }, + "limit": { + "default": 10, + "description": "The maximum number of logs in the response.", + "example": 25, + "format": "int32", + "maximum": 1000, + "type": "integer" } }, - "required": [ - "id", - "type", - "attributes" - ], "type": "object" + }, + "sort": { + "description": "The sort parameters when querying events.", + "enum": [ + "timestamp", + "-timestamp" + ], + "type": "string", + "x-enum-varnames": [ + "TIMESTAMP_ASCENDING", + "TIMESTAMP_DESCENDING" + ] } }, - "required": [ - "data" - ], "type": "object" } } }, - "description": "Update a downtime request body.", - "required": true + "required": false }, "responses": { "200": { "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": "The response object with all events matching the request and pagination information.", "properties": { "data": { - "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" - } + "description": "An array of events matching the request.", + "items": { + "description": "The object description of an event after being processed and stored by Datadog.", + "properties": { + "attributes": { + "description": "The object description of an event response attribute.", + "properties": { + "attributes": { + "description": "Object description of attributes from your event.", + "properties": { + "aggregation_key": { + "description": "Aggregation key of the event.", + "type": "string" }, - "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", + "date_happened": { + "description": "POSIX timestamp of the event. Must be sent as an integer (no quotation marks).\nLimited to events no older than 18 hours.", + "format": "int64", + "type": "integer" + }, + "device_name": { + "description": "A device name.", + "type": "string" + }, + "duration": { + "description": "The duration between the triggering of the event and its recovery in nanoseconds.", + "format": "int64", + "type": "integer" + }, + "event_object": { + "description": "The event title.", + "example": "Did you hear the news today?", + "type": "string" + }, + "evt": { + "description": "The metadata associated with a request.", + "properties": { + "id": { + "description": "Event ID.", + "example": "6509751066204996294", "type": "string" }, - "minItems": 1, - "type": "array" - } + "name": { + "description": "The event name.", + "type": "string" + }, + "source_id": { + "description": "Event source ID.", + "example": 36, + "format": "int64", + "type": "integer" + }, + "type": { + "description": "Event type.", + "example": "error_tracking_alert", + "type": "string" + } + }, + "type": "object" }, - "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, + "hostname": { + "description": "Host name to associate with the event.\nAny tags associated with the host are also applied to this event.", + "type": "string" + }, + "monitor": { + "description": "Attributes from the monitor that triggered the event.", + "nullable": true, + "properties": { + "created_at": { + "description": "The POSIX timestamp of the monitor's creation in nanoseconds.", + "example": 1646318692000, + "format": "int64", + "type": "integer" + }, + "group_status": { + "description": "Monitor group status used when there is no `result_groups`.", + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "groups": { + "description": "Groups to which the monitor belongs.", + "items": { + "description": "A group.", "type": "string" }, - "start": { - "description": "The start of the current downtime.", - "example": "2020-01-02T03:04:00.000Z", - "format": "date-time", - "type": "string" - } + "type": "array" }, - "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" - } + "id": { + "description": "The monitor ID.", + "format": "int64", + "type": "integer" + }, + "message": { + "description": "The monitor message.", + "type": "string" + }, + "modified": { + "description": "The monitor's last-modified timestamp.", + "format": "int64", + "type": "integer" + }, + "name": { + "description": "The monitor name.", + "type": "string" + }, + "query": { + "description": "The query that triggers the alert.", + "type": "string" + }, + "tags": { + "description": "A list of tags attached to the monitor.", + "example": [ + "environment:test" + ], + "items": { + "description": "A tag.", + "type": "string" }, - "type": "object" + "type": "array" }, - "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 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" + "templated_name": { + "description": "The templated name of the monitor before resolving any template variables.", + "type": "string" + }, + "type": { + "description": "The monitor type.", + "type": "string" + } }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } + "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", + "monitor_groups": { + "description": "List of groups referred to in the event.", + "items": { + "description": "Group referred to in the event.", "type": "string" }, - "type": { - "default": "monitors", - "description": "Monitor resource type.", - "enum": [ - "monitors" - ], - "example": "monitors", - "type": "string", - "x-enum-varnames": [ - "MONITORS" - ] - } + "nullable": true, + "type": "array" }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "downtime", - "description": "Downtime resource type.", - "enum": [ - "downtime" - ], - "example": "downtime", - "type": "string", - "x-enum-varnames": [ - "DOWNTIME" - ] - } - }, - "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" + "monitor_id": { + "description": "ID of the monitor that triggered the event. When an event isn't related to a monitor, this field is empty.", + "format": "int64", + "nullable": true, + "type": "integer" }, - "disabled": { - "description": "Whether the user is disabled.", - "type": "boolean" + "priority": { + "description": "The priority of the event's monitor. For example, `normal` or `low`.", + "enum": [ + "normal", + "low" + ], + "example": "normal", + "nullable": true, + "type": "string", + "x-enum-varnames": [ + "NORMAL", + "LOW" + ] }, - "email": { - "description": "Email of the user.", - "type": "string" + "related_event_id": { + "description": "Related event ID.", + "format": "int64", + "type": "integer" }, - "handle": { - "description": "Handle of the user.", + "service": { + "description": "Service that triggered the event.", + "example": "datadog-api", "type": "string" }, - "icon": { - "description": "URL of the user's icon.", + "source_type_name": { + "description": "The type of event being posted.\nFor example, `nagios`, `hudson`, `jenkins`, `my_apps`, `chef`, `puppet`, `git` or `bitbucket`.\nThe list of standard source attribute values is [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).", "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", + "sourcecategory": { + "description": "Identifier for the source of the event, such as a monitor alert, an externally-submitted event, or an integration.", "type": "string" }, - "name": { - "description": "Name of the user.", - "nullable": true, - "type": "string" + "status": { + "description": "If an alert event is enabled, its status is one of the following:\n`failure`, `error`, `warning`, `info`, `success`, `user_update`,\n`recommendation`, or `snapshot`.", + "enum": [ + "failure", + "error", + "warning", + "info", + "success", + "user_update", + "recommendation", + "snapshot" + ], + "example": "info", + "type": "string", + "x-enum-varnames": [ + "FAILURE", + "ERROR", + "WARNING", + "INFO", + "SUCCESS", + "USER_UPDATE", + "RECOMMENDATION", + "SNAPSHOT" + ] }, - "service_account": { - "description": "Whether the user is a service account.", - "type": "boolean" + "tags": { + "description": "A list of tags to apply to the event.", + "example": [ + "environment:test" + ], + "items": { + "description": "A tag.", + "type": "string" + }, + "type": "array" }, - "status": { - "description": "Status of the user.", - "type": "string" + "timestamp": { + "description": "POSIX timestamp of your event in milliseconds.", + "example": 1652274265000, + "format": "int64", + "type": "integer" }, "title": { - "description": "Title of the user.", - "nullable": true, + "description": "The event title.", + "example": "Oh boy!", "type": "string" - }, - "verified": { - "description": "Whether the user is verified.", - "type": "boolean" } }, "type": "object" }, - "id": { - "description": "ID of the user.", + "message": { + "description": "The message of the event.", "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 - } - } + "tags": { + "description": "An array of tags associated with the event.", + "example": [ + "team:A" + ], + "items": { + "description": "The tag associated with the event.", + "type": "string" }, - "type": "object", - "x-merge-override": { - "properties": false - } + "type": "array" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "timestamp": { + "description": "The timestamp of the event.", + "example": "2019-01-02T09:42:36.320Z", + "format": "date-time", + "type": "string" } }, - "type": "object", - "x-merge-override": { - "required": false + "type": "object" + }, + "id": { + "description": "the unique ID of the event.", + "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", + "type": "string" + }, + "type": { + "default": "event", + "description": "Type of the event.", + "enum": [ + "event" + ], + "example": "event", + "type": "string", + "x-enum-varnames": [ + "EVENT" + ] + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "description": "Links attributes.", + "properties": { + "next": { + "description": "Link for the next set of results. Note that the request can also be made using the\nPOST endpoint.", + "example": "https://app.datadoghq.com/api/v2/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "description": "The metadata associated with a request.", + "properties": { + "elapsed": { + "description": "The time elapsed in milliseconds.", + "example": 132, + "format": "int64", + "type": "integer" + }, + "page": { + "description": "Pagination attributes.", + "properties": { + "after": { + "description": "The cursor to use to get the next results, if any. To make the next request, use the same\nparameters with the addition of the `page[cursor]`.", + "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "type": "string" } }, - { - "description": "Information about the monitor identified by the downtime.", + "type": "object" + }, + "request_id": { + "description": "The identifier of the request.", + "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", + "type": "string" + }, + "status": { + "description": "The request status.", + "example": "done", + "type": "string" + }, + "warnings": { + "description": "A list of warnings (non-fatal errors) encountered. Partial results might be returned if\nwarnings are present in the response.", + "items": { + "description": "A warning message indicating something is wrong with the query.", "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" + "code": { + "description": "A unique code for this type of warning.", + "example": "unknown_index", + "type": "string" }, - "id": { - "description": "ID of the monitor identified by the downtime.", - "example": 12345, - "format": "int64", - "type": "integer" + "detail": { + "description": "A detailed explanation of this specific warning.", + "example": "indexes: foo, bar", + "type": "string" }, - "type": { - "default": "monitors", - "description": "Monitor resource type.", - "enum": [ - "monitors" - ], - "example": "monitors", - "type": "string", - "x-enum-varnames": [ - "MONITORS" - ] + "title": { + "description": "A short human-readable summary of the warning.", + "example": "One or several indexes are missing or invalid. Results hold data from the other indexes.", + "type": "string" } }, "type": "object" - } - ] + }, + "type": "array" + } }, - "type": "array" + "type": "object" } }, "type": "object" @@ -220065,35 +225838,7 @@ } } }, - "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" + "description": "Not Authorized" }, "429": { "content": { @@ -220124,104 +225869,80 @@ "description": "Too many requests" } }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "monitors_downtime" - ] - } - ], - "summary": "Update a downtime", + "summary": "Search events", "tags": [ - "Downtimes" + "Events" ], "x-codegen-request-body-name": "body", - "x-menu-order": 6, + "x-menu-order": 2, + "x-pagination": { + "cursorParam": "body.page.cursor", + "cursorPath": "meta.page.after", + "limitParam": "body.page.limit", + "resultsPath": "data" + }, "x-permission": { "operator": "OR", "permissions": [ - "monitors_downtime" + "events_read" ] }, "x-undo": { - "type": "idempotent" + "type": "safe" } + }, + "x-merge-override": { + "post": false } }, - "/api/v2/events": { + "/api/v2/incidents": { "get": { - "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.", - "operationId": "ListEvents", + "description": "Get all incidents for the user's organization.", + "operationId": "ListIncidents", "parameters": [ { - "description": "Search query following events syntax.", - "in": "query", - "name": "filter[query]", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Minimum timestamp for requested events, in milliseconds.", - "in": "query", - "name": "filter[from]", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Maximum timestamp for requested events, in milliseconds.", - "in": "query", - "name": "filter[to]", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Order of events in results.", + "description": "Specifies which types of related objects should be included in the response.", + "explode": false, "in": "query", - "name": "sort", + "name": "include", "required": false, "schema": { - "description": "The sort parameters when querying events.", - "enum": [ - "timestamp", - "-timestamp" - ], - "type": "string", - "x-enum-varnames": [ - "TIMESTAMP_ASCENDING", - "TIMESTAMP_DESCENDING" - ] + "items": { + "description": "Object related to an incident.", + "enum": [ + "users", + "attachments" + ], + "type": "string", + "x-enum-varnames": [ + "USERS", + "ATTACHMENTS" + ] + }, + "type": "array" } }, { - "description": "List following results with a cursor provided in the previous query.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + "description": "Size for a given page. The maximum allowed value is 100.", "in": "query", - "name": "page[cursor]", + "name": "page[size]", "required": false, "schema": { - "type": "string" + "default": 10, + "example": 10, + "format": "int64", + "type": "integer" } }, { - "description": "Maximum number of events in the response.", - "example": 25, + "description": "Specific offset to use as the beginning of the returned page.", "in": "query", - "name": "page[limit]", + "name": "page[offset]", "required": false, "schema": { - "default": 10, - "format": "int32", - "maximum": 1000, + "default": 0, + "example": 0, + "format": "int64", "type": "integer" } } @@ -220231,353 +225952,1096 @@ "content": { "application/json": { "schema": { - "description": "The response object with all events matching the request and pagination information.", + "description": "Response with a list of incidents.", "properties": { "data": { - "description": "An array of events matching the request.", + "description": "An array of incidents.", + "example": [ + { + "attributes": { + "created": "2020-04-21T15:34:08.627205+00:00", + "creation_idempotency_key": null, + "customer_impact_duration": 0, + "customer_impact_end": null, + "customer_impact_scope": null, + "customer_impact_start": null, + "customer_impacted": false, + "detected": "2020-04-14T00:00:00+00:00", + "incident_type_uuid": "00000000-0000-0000-0000-000000000001", + "modified": "2020-09-17T14:16:58.696424+00:00", + "public_id": 1, + "resolved": null, + "severity": "SEV-1", + "time_to_detect": 0, + "time_to_internal_response": 0, + "time_to_repair": 0, + "time_to_resolve": 0, + "title": "Example Incident" + }, + "id": "00000000-aaaa-0000-0000-000000000000", + "relationships": { + "attachments": { + "data": [ + { + "id": "00000000-9999-0000-0000-000000000000", + "type": "incident_attachments" + }, + { + "id": "00000000-1234-0000-0000-000000000000", + "type": "incident_attachments" + } + ] + }, + "commander_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + }, + "created_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + }, + "integrations": { + "data": [ + { + "id": "00000000-0000-0000-4444-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-0000-0000-5555-000000000000", + "type": "incident_integrations" + } + ] + }, + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + } + }, + "type": "incidents" + }, + { + "attributes": { + "created": "2020-04-21T15:34:08.627205+00:00", + "creation_idempotency_key": null, + "customer_impact_duration": 0, + "customer_impact_end": null, + "customer_impact_scope": null, + "customer_impact_start": null, + "customer_impacted": false, + "detected": "2020-04-14T00:00:00+00:00", + "incident_type_uuid": "00000000-0000-0000-0000-000000000002", + "modified": "2020-09-17T14:16:58.696424+00:00", + "public_id": 2, + "resolved": null, + "severity": "SEV-5", + "time_to_detect": 0, + "time_to_internal_response": 0, + "time_to_repair": 0, + "time_to_resolve": 0, + "title": "Example Incident 2" + }, + "id": "00000000-1111-0000-0000-000000000000", + "relationships": { + "attachments": { + "data": [ + { + "id": "00000000-9999-0000-0000-000000000000", + "type": "incident_attachments" + } + ] + }, + "commander_user": { + "data": { + "id": "00000000-aaaa-0000-0000-000000000000", + "type": "users" + } + }, + "created_by_user": { + "data": { + "id": "00000000-aaaa-0000-0000-000000000000", + "type": "users" + } + }, + "integrations": { + "data": [ + { + "id": "00000000-0000-0000-0001-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-0000-0000-0002-000000000000", + "type": "incident_integrations" + } + ] + }, + "last_modified_by_user": { + "data": { + "id": "00000000-aaaa-0000-0000-000000000000", + "type": "users" + } + } + }, + "type": "incidents" + } + ], "items": { - "description": "The object description of an event after being processed and stored by Datadog.", + "description": "Incident data from a response.", "properties": { "attributes": { - "description": "The object description of an event response attribute.", + "description": "The incident's attributes from a response.", "properties": { - "attributes": { - "description": "Object description of attributes from your event.", + "archived": { + "description": "Timestamp of when the incident was archived.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "case_id": { + "description": "The incident case id.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "created": { + "description": "Timestamp when the incident was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "customer_impact_duration": { + "description": "Length of the incident's customer impact in seconds.\nEquals the difference between `customer_impact_start` and `customer_impact_end`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "customer_impact_end": { + "description": "Timestamp when customers were no longer impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impact_scope": { + "description": "A summary of the impact customers experienced during the incident.", + "example": "An example customer impact scope", + "nullable": true, + "type": "string" + }, + "customer_impact_start": { + "description": "Timestamp when customers began being impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impacted": { + "description": "A flag indicating whether the incident caused customer impact.", + "example": false, + "type": "boolean" + }, + "detected": { + "description": "Timestamp when the incident was detected.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "fields": { + "additionalProperties": { + "description": "Dynamic fields for which selections can be made, with field names as keys.", + "oneOf": [ + { + "description": "A field with a single value selected.", + "properties": { + "type": { + "default": "dropdown", + "description": "Type of the single value field definitions.", + "enum": [ + "dropdown", + "textbox" + ], + "example": "dropdown", + "type": "string", + "x-enum-varnames": [ + "DROPDOWN", + "TEXTBOX" + ] + }, + "value": { + "description": "The single value selected for this field.", + "example": "SEV-1", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + { + "description": "A field with potentially multiple values selected.", + "properties": { + "type": { + "default": "multiselect", + "description": "Type of the multiple value field definitions.", + "enum": [ + "multiselect", + "textarray", + "metrictag", + "autocomplete" + ], + "example": "multiselect", + "type": "string", + "x-enum-varnames": [ + "MULTISELECT", + "TEXTARRAY", + "METRICTAG", + "AUTOCOMPLETE" + ] + }, + "value": { + "description": "The multiple values selected for this field.", + "example": [ + "1.0", + "1.1" + ], + "items": { + "description": "A value which has been selected for the parent field.", + "example": "1.1", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "description": "A condensed view of the user-defined fields attached to incidents.", + "example": { + "severity": { + "type": "dropdown", + "value": "SEV-5" + } + }, + "type": "object" + }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "modified": { + "description": "Timestamp when the incident was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "non_datadog_creator": { + "description": "Incident's non Datadog creator.", + "nullable": true, "properties": { - "aggregation_key": { - "description": "Aggregation key of the event.", + "image_48_px": { + "description": "Non Datadog creator `48px` image.", "type": "string" }, - "date_happened": { - "description": "POSIX timestamp of the event. Must be sent as an integer (no quotation marks).\nLimited to events no older than 18 hours.", - "format": "int64", - "type": "integer" + "name": { + "description": "Non Datadog creator name.", + "type": "string" + } + }, + "type": "object" + }, + "notification_handles": { + "description": "Notification handles that will be notified of the incident during update.", + "example": [ + { + "display_name": "Jane Doe", + "handle": "@user@email.com" }, - "device_name": { - "description": "A device name.", + { + "display_name": "Slack Channel", + "handle": "@slack-channel" + }, + { + "display_name": "Incident Workflow", + "handle": "@workflow-from-incident" + } + ], + "items": { + "description": "A notification handle that will be notified at incident creation.", + "properties": { + "display_name": { + "description": "The name of the notified handle.", + "example": "Jane Doe", + "type": "string" + }, + "handle": { + "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", + "example": "@test.user@test.com", + "type": "string" + } + }, + "type": "object" + }, + "nullable": true, + "type": "array" + }, + "public_id": { + "description": "The monotonically increasing integer ID for the incident.", + "example": 1, + "format": "int64", + "type": "integer" + }, + "resolved": { + "description": "Timestamp when the incident's state was last changed from active or stable to resolved or completed.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "severity": { + "description": "The incident severity.", + "enum": [ + "UNKNOWN", + "SEV-1", + "SEV-2", + "SEV-3", + "SEV-4", + "SEV-5" + ], + "example": "UNKNOWN", + "type": "string", + "x-enum-varnames": [ + "UNKNOWN", + "SEV_1", + "SEV_2", + "SEV_3", + "SEV_4", + "SEV_5" + ] + }, + "state": { + "description": "The state incident.", + "nullable": true, + "type": "string" + }, + "time_to_detect": { + "description": "The amount of time in seconds to detect the incident.\nEquals the difference between `customer_impact_start` and `detected`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_internal_response": { + "description": "The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_repair": { + "description": "The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_resolve": { + "description": "The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "title": { + "description": "The title of the incident, which summarizes what happened.", + "example": "A test incident title", + "type": "string" + }, + "visibility": { + "description": "The incident visibility status.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "title" + ], + "type": "object" + }, + "id": { + "description": "The incident's ID.", + "example": "00000000-0000-0000-1234-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident's relationships from a response.", + "properties": { + "attachments": { + "description": "A relationship reference for attachments.", + "properties": { + "data": { + "description": "An array of incident attachments.", + "items": { + "description": "The attachment relationship data.", + "properties": { + "id": { + "description": "A unique identifier that represents the attachment.", + "example": "00000000-0000-abcd-1000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "commander_user": { + "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": "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "impacts": { + "description": "Relationship to impacts.", + "properties": { + "data": { + "description": "An array of incident impacts.", + "items": { + "description": "Relationship to impact object.", + "properties": { + "id": { + "description": "A unique identifier that represents the impact.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "description": "The incident impacts type.", + "enum": [ + "incident_impacts" + ], + "example": "incident_impacts", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_IMPACTS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "integrations": { + "description": "A relationship reference for multiple integration metadata objects.", + "example": { + "data": [ + { + "id": "00000000-abcd-0005-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0006-0000-000000000000", + "type": "incident_integrations" + } + ] + }, + "properties": { + "data": { + "description": "Integration metadata relationship array", + "example": [ + { + "id": "00000000-abcd-0003-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0004-0000-000000000000", + "type": "incident_integrations" + } + ], + "items": { + "description": "A relationship reference for an integration metadata object.", + "example": { + "id": "00000000-abcd-0002-0000-000000000000", + "type": "incident_integrations" + }, + "properties": { + "id": { + "description": "A unique identifier that represents the integration metadata.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_integrations", + "description": "Integration metadata resource type.", + "enum": [ + "incident_integrations" + ], + "example": "incident_integrations", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_INTEGRATIONS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "responders": { + "description": "Relationship to incident responders.", + "properties": { + "data": { + "description": "An array of incident responders.", + "items": { + "description": "Relationship to impact object.", + "properties": { + "id": { + "description": "A unique identifier that represents the responder.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "description": "The incident responders type.", + "enum": [ + "incident_responders" + ], + "example": "incident_responders", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_RESPONDERS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "user_defined_fields": { + "description": "Relationship to incident user defined fields.", + "properties": { + "data": { + "description": "An array of user defined fields.", + "items": { + "description": "Relationship to impact object.", + "properties": { + "id": { + "description": "A unique identifier that represents the responder.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "description": "The incident user defined fields type.", + "enum": [ + "user_defined_field" + ], + "example": "user_defined_field", + "type": "string", + "x-enum-varnames": [ + "USER_DEFINED_FIELD" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "incidents", + "description": "Incident resource type.", + "enum": [ + "incidents" + ], + "example": "incidents", + "type": "string", + "x-enum-varnames": [ + "INCIDENTS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + }, + "included": { + "description": "Included related resources that the user requested.", + "items": { + "description": "An object related to an incident that is included in the response.", + "oneOf": [ + { + "description": "User object returned by the API.", + "properties": { + "attributes": { + "description": "Attributes of user object returned by the API.", + "properties": { + "email": { + "description": "Email of the user.", "type": "string" }, - "duration": { - "description": "The duration between the triggering of the event and its recovery in nanoseconds.", - "format": "int64", - "type": "integer" + "handle": { + "description": "Handle of the user.", + "type": "string" + }, + "icon": { + "description": "URL of the user's icon.", + "type": "string" }, - "event_object": { - "description": "The event title.", - "example": "Did you hear the news today?", + "name": { + "description": "Name of the user.", + "nullable": true, "type": "string" }, - "evt": { - "description": "The metadata associated with a request.", + "uuid": { + "description": "UUID of the user.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the user.", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + }, + { + "description": "A single incident attachment.", + "example": { + "attributes": { + "attachment": { + "documentUrl": "", + "title": "Postmortem IR-123" + }, + "attachment_type": "postmortem" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + }, + "properties": { + "attributes": { + "description": "The attributes object for an attachment.", + "oneOf": [ + { + "description": "The attributes object for a postmortem attachment.", "properties": { - "id": { - "description": "Event ID.", - "example": "6509751066204996294", - "type": "string" - }, - "name": { - "description": "The event name.", - "type": "string" - }, - "source_id": { - "description": "Event source ID.", - "example": 36, - "format": "int64", - "type": "integer" + "attachment": { + "description": "The postmortem attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this notebook attachment.", + "example": "https://app.datadoghq.com/notebook/123", + "type": "string" + }, + "title": { + "description": "The title of this postmortem attachment.", + "example": "Postmortem IR-123", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" }, - "type": { - "description": "Event type.", - "example": "error_tracking_alert", - "type": "string" + "attachment_type": { + "default": "postmortem", + "description": "The type of postmortem attachment attributes.", + "enum": [ + "postmortem" + ], + "example": "postmortem", + "type": "string", + "x-enum-varnames": [ + "POSTMORTEM" + ] } }, + "required": [ + "attachment_type", + "attachment" + ], "type": "object" }, - "hostname": { - "description": "Host name to associate with the event.\nAny tags associated with the host are also applied to this event.", - "type": "string" - }, - "monitor": { - "description": "Attributes from the monitor that triggered the event.", - "nullable": true, + { + "description": "The attributes object for a link attachment.", "properties": { - "created_at": { - "description": "The POSIX timestamp of the monitor's creation in nanoseconds.", - "example": 1646318692000, - "format": "int64", - "type": "integer" - }, - "group_status": { - "description": "Monitor group status used when there is no `result_groups`.", - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "groups": { - "description": "Groups to which the monitor belongs.", - "items": { - "description": "A group.", - "type": "string" + "attachment": { + "description": "The link attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this link attachment.", + "example": "https://www.example.com/webstore-failure-runbook", + "type": "string" + }, + "title": { + "description": "The title of this link attachment.", + "example": "Runbook for webstore service failures", + "type": "string" + } }, - "type": "array" - }, - "id": { - "description": "The monitor ID.", - "format": "int64", - "type": "integer" - }, - "message": { - "description": "The monitor message.", - "type": "string" - }, - "modified": { - "description": "The monitor's last-modified timestamp.", - "format": "int64", - "type": "integer" - }, - "name": { - "description": "The monitor name.", - "type": "string" - }, - "query": { - "description": "The query that triggers the alert.", - "type": "string" - }, - "tags": { - "description": "A list of tags attached to the monitor.", - "example": [ - "environment:test" + "required": [ + "documentUrl", + "title" ], - "items": { - "description": "A tag.", - "type": "string" - }, - "type": "array" + "type": "object" }, - "templated_name": { - "description": "The templated name of the monitor before resolving any template variables.", - "type": "string" + "attachment_type": { + "default": "link", + "description": "The type of link attachment attributes.", + "enum": [ + "link" + ], + "example": "link", + "type": "string", + "x-enum-varnames": [ + "LINK" + ] }, - "type": { - "description": "The monitor type.", + "modified": { + "description": "Timestamp when the incident attachment link was last modified.", + "format": "date-time", + "readOnly": true, "type": "string" } }, + "required": [ + "attachment_type", + "attachment" + ], "type": "object" - }, - "monitor_groups": { - "description": "List of groups referred to in the event.", - "items": { - "description": "Group referred to in the event.", - "type": "string" + } + ] + }, + "id": { + "description": "A unique identifier that represents the incident attachment.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident attachment's relationships.", + "properties": { + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } }, - "nullable": true, - "type": "array" - }, - "monitor_id": { - "description": "ID of the monitor that triggered the event. When an event isn't related to a monitor, this field is empty.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "priority": { - "description": "The priority of the event's monitor. For example, `normal` or `low`.", - "enum": [ - "normal", - "low" - ], - "example": "normal", - "nullable": true, - "type": "string", - "x-enum-varnames": [ - "NORMAL", - "LOW" - ] - }, - "related_event_id": { - "description": "Related event ID.", - "format": "int64", - "type": "integer" - }, - "service": { - "description": "Service that triggered the event.", - "example": "datadog-api", - "type": "string" - }, - "source_type_name": { - "description": "The type of event being posted.\nFor example, `nagios`, `hudson`, `jenkins`, `my_apps`, `chef`, `puppet`, `git` or `bitbucket`.\nThe list of standard source attribute values is [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).", - "type": "string" - }, - "sourcecategory": { - "description": "Identifier for the source of the event, such as a monitor alert, an externally-submitted event, or an integration.", - "type": "string" - }, - "status": { - "description": "If an alert event is enabled, its status is one of the following:\n`failure`, `error`, `warning`, `info`, `success`, `user_update`,\n`recommendation`, or `snapshot`.", - "enum": [ - "failure", - "error", - "warning", - "info", - "success", - "user_update", - "recommendation", - "snapshot" - ], - "example": "info", - "type": "string", - "x-enum-varnames": [ - "FAILURE", - "ERROR", - "WARNING", - "INFO", - "SUCCESS", - "USER_UPDATE", - "RECOMMENDATION", - "SNAPSHOT" - ] - }, - "tags": { - "description": "A list of tags to apply to the event.", - "example": [ - "environment:test" + "required": [ + "data" ], - "items": { - "description": "A tag.", - "type": "string" - }, - "type": "array" - }, - "timestamp": { - "description": "POSIX timestamp of your event in milliseconds.", - "example": 1652274265000, - "format": "int64", - "type": "integer" - }, - "title": { - "description": "The event title.", - "example": "Oh boy!", - "type": "string" + "type": "object" } }, "type": "object" }, - "message": { - "description": "The message of the event.", - "type": "string" - }, - "tags": { - "description": "An array of tags associated with the event.", - "example": [ - "team:A" + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" ], - "items": { - "description": "The tag associated with the event.", - "type": "string" - }, - "type": "array" - }, - "timestamp": { - "description": "The timestamp of the event.", - "example": "2019-01-02T09:42:36.320Z", - "format": "date-time", - "type": "string" + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] } }, - "type": "object" - }, - "id": { - "description": "the unique ID of the event.", - "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", - "type": "string" - }, - "type": { - "default": "event", - "description": "Type of the event.", - "enum": [ - "event" + "required": [ + "type", + "attributes", + "id", + "relationships" ], - "example": "event", - "type": "string", - "x-enum-varnames": [ - "EVENT" - ] + "type": "object" } - }, - "type": "object" + ] }, + "readOnly": true, "type": "array" }, - "links": { - "description": "Links attributes.", - "properties": { - "next": { - "description": "Link for the next set of results. Note that the request can also be made using the\nPOST endpoint.", - "example": "https://app.datadoghq.com/api/v2/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - } - }, - "type": "object" - }, "meta": { - "description": "The metadata associated with a request.", + "description": "The metadata object containing pagination metadata.", "properties": { - "elapsed": { - "description": "The time elapsed in milliseconds.", - "example": 132, - "format": "int64", - "type": "integer" - }, - "page": { - "description": "Pagination attributes.", + "pagination": { + "description": "Pagination properties.", "properties": { - "after": { - "description": "The cursor to use to get the next results, if any. To make the next request, use the same\nparameters with the addition of the `page[cursor]`.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" + "next_offset": { + "description": "The index of the first element in the next page of results. Equal to page size added to the current offset.", + "example": 1000, + "format": "int64", + "type": "integer" + }, + "offset": { + "description": "The index of the first element in the results.", + "example": 10, + "format": "int64", + "type": "integer" + }, + "size": { + "description": "Maximum size of pages to return.", + "example": 1000, + "format": "int64", + "type": "integer" } }, "type": "object" - }, - "request_id": { - "description": "The identifier of the request.", - "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", - "type": "string" - }, - "status": { - "description": "The request status.", - "example": "done", - "type": "string" - }, - "warnings": { - "description": "A list of warnings (non-fatal errors) encountered. Partial results might be returned if\nwarnings are present in the response.", - "items": { - "description": "A warning message indicating something is wrong with the query.", - "properties": { - "code": { - "description": "A unique code for this type of warning.", - "example": "unknown_index", - "type": "string" - }, - "detail": { - "description": "A detailed explanation of this specific warning.", - "example": "indexes: foo, bar", - "type": "string" - }, - "title": { - "description": "A short human-readable summary of the warning.", - "example": "One or several indexes are missing or invalid. Results hold data from the other indexes.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" } }, + "readOnly": true, "type": "object" } }, + "required": [ + "data" + ], "type": "object" } } @@ -220612,547 +227076,35 @@ }, "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": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "events_read" - ] - } - ], - "summary": "Get a list of events", - "tags": [ - "Events" - ], - "x-menu-order": 1, - "x-pagination": { - "cursorParam": "page[cursor]", - "cursorPath": "meta.page.after", - "limitParam": "page[limit]", - "resultsPath": "data" - }, - "x-permission": { - "operator": "OR", - "permissions": [ - "events_read" - ] - }, - "x-undo": { - "type": "safe" - } - }, - "x-merge-override": { - "get": false - } - }, - "/api/v2/events/search": { - "post": { - "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 build complex events filtering and search.", - "operationId": "SearchEvents", - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "The object sent with the request to retrieve a list of events from your organization.", - "properties": { - "filter": { - "description": "The search and filter query settings.", - "properties": { - "from": { - "default": "now-15m", - "description": "The minimum time for the requested events. Supports date math and regular timestamps in milliseconds.", - "example": "now-15m", - "type": "string" - }, - "query": { - "default": "*", - "description": "The search query following the event search syntax.", - "example": "service:web* AND @http.status_code:[200 TO 299]", - "type": "string" - }, - "to": { - "default": "now", - "description": "The maximum time for the requested events. Supports date math and regular timestamps in milliseconds.", - "example": "now", - "type": "string" - } - }, - "type": "object" - }, - "options": { - "description": "The global query options that are used. Either provide a timezone or a time offset but not both,\notherwise the query fails.", - "properties": { - "timeOffset": { - "description": "The time offset to apply to the query in seconds.", - "format": "int64", - "type": "integer" - }, - "timezone": { - "default": "UTC", - "description": "The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).", - "example": "GMT", - "type": "string" - } - }, - "type": "object" - }, - "page": { - "description": "Pagination settings.", - "properties": { - "cursor": { - "description": "The returned paging point to use to get the next results.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - }, - "limit": { - "default": 10, - "description": "The maximum number of logs in the response.", - "example": 25, - "format": "int32", - "maximum": 1000, - "type": "integer" - } - }, - "type": "object" - }, - "sort": { - "description": "The sort parameters when querying events.", - "enum": [ - "timestamp", - "-timestamp" - ], - "type": "string", - "x-enum-varnames": [ - "TIMESTAMP_ASCENDING", - "TIMESTAMP_DESCENDING" - ] - } - }, - "type": "object" - } - } - }, - "required": false - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "The response object with all events matching the request and pagination information.", - "properties": { - "data": { - "description": "An array of events matching the request.", - "items": { - "description": "The object description of an event after being processed and stored by Datadog.", - "properties": { - "attributes": { - "description": "The object description of an event response attribute.", - "properties": { - "attributes": { - "description": "Object description of attributes from your event.", - "properties": { - "aggregation_key": { - "description": "Aggregation key of the event.", - "type": "string" - }, - "date_happened": { - "description": "POSIX timestamp of the event. Must be sent as an integer (no quotation marks).\nLimited to events no older than 18 hours.", - "format": "int64", - "type": "integer" - }, - "device_name": { - "description": "A device name.", - "type": "string" - }, - "duration": { - "description": "The duration between the triggering of the event and its recovery in nanoseconds.", - "format": "int64", - "type": "integer" - }, - "event_object": { - "description": "The event title.", - "example": "Did you hear the news today?", - "type": "string" - }, - "evt": { - "description": "The metadata associated with a request.", - "properties": { - "id": { - "description": "Event ID.", - "example": "6509751066204996294", - "type": "string" - }, - "name": { - "description": "The event name.", - "type": "string" - }, - "source_id": { - "description": "Event source ID.", - "example": 36, - "format": "int64", - "type": "integer" - }, - "type": { - "description": "Event type.", - "example": "error_tracking_alert", - "type": "string" - } - }, - "type": "object" - }, - "hostname": { - "description": "Host name to associate with the event.\nAny tags associated with the host are also applied to this event.", - "type": "string" - }, - "monitor": { - "description": "Attributes from the monitor that triggered the event.", - "nullable": true, - "properties": { - "created_at": { - "description": "The POSIX timestamp of the monitor's creation in nanoseconds.", - "example": 1646318692000, - "format": "int64", - "type": "integer" - }, - "group_status": { - "description": "Monitor group status used when there is no `result_groups`.", - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "groups": { - "description": "Groups to which the monitor belongs.", - "items": { - "description": "A group.", - "type": "string" - }, - "type": "array" - }, - "id": { - "description": "The monitor ID.", - "format": "int64", - "type": "integer" - }, - "message": { - "description": "The monitor message.", - "type": "string" - }, - "modified": { - "description": "The monitor's last-modified timestamp.", - "format": "int64", - "type": "integer" - }, - "name": { - "description": "The monitor name.", - "type": "string" - }, - "query": { - "description": "The query that triggers the alert.", - "type": "string" - }, - "tags": { - "description": "A list of tags attached to the monitor.", - "example": [ - "environment:test" - ], - "items": { - "description": "A tag.", - "type": "string" - }, - "type": "array" - }, - "templated_name": { - "description": "The templated name of the monitor before resolving any template variables.", - "type": "string" - }, - "type": { - "description": "The monitor type.", - "type": "string" - } - }, - "type": "object" - }, - "monitor_groups": { - "description": "List of groups referred to in the event.", - "items": { - "description": "Group referred to in the event.", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "monitor_id": { - "description": "ID of the monitor that triggered the event. When an event isn't related to a monitor, this field is empty.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "priority": { - "description": "The priority of the event's monitor. For example, `normal` or `low`.", - "enum": [ - "normal", - "low" - ], - "example": "normal", - "nullable": true, - "type": "string", - "x-enum-varnames": [ - "NORMAL", - "LOW" - ] - }, - "related_event_id": { - "description": "Related event ID.", - "format": "int64", - "type": "integer" - }, - "service": { - "description": "Service that triggered the event.", - "example": "datadog-api", - "type": "string" - }, - "source_type_name": { - "description": "The type of event being posted.\nFor example, `nagios`, `hudson`, `jenkins`, `my_apps`, `chef`, `puppet`, `git` or `bitbucket`.\nThe list of standard source attribute values is [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).", - "type": "string" - }, - "sourcecategory": { - "description": "Identifier for the source of the event, such as a monitor alert, an externally-submitted event, or an integration.", - "type": "string" - }, - "status": { - "description": "If an alert event is enabled, its status is one of the following:\n`failure`, `error`, `warning`, `info`, `success`, `user_update`,\n`recommendation`, or `snapshot`.", - "enum": [ - "failure", - "error", - "warning", - "info", - "success", - "user_update", - "recommendation", - "snapshot" - ], - "example": "info", - "type": "string", - "x-enum-varnames": [ - "FAILURE", - "ERROR", - "WARNING", - "INFO", - "SUCCESS", - "USER_UPDATE", - "RECOMMENDATION", - "SNAPSHOT" - ] - }, - "tags": { - "description": "A list of tags to apply to the event.", - "example": [ - "environment:test" - ], - "items": { - "description": "A tag.", - "type": "string" - }, - "type": "array" - }, - "timestamp": { - "description": "POSIX timestamp of your event in milliseconds.", - "example": 1652274265000, - "format": "int64", - "type": "integer" - }, - "title": { - "description": "The event title.", - "example": "Oh boy!", - "type": "string" - } - }, - "type": "object" - }, - "message": { - "description": "The message of the event.", - "type": "string" - }, - "tags": { - "description": "An array of tags associated with the event.", - "example": [ - "team:A" - ], - "items": { - "description": "The tag associated with the event.", - "type": "string" - }, - "type": "array" - }, - "timestamp": { - "description": "The timestamp of the event.", - "example": "2019-01-02T09:42:36.320Z", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "the unique ID of the event.", - "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", - "type": "string" - }, - "type": { - "default": "event", - "description": "Type of the event.", - "enum": [ - "event" - ], - "example": "event", - "type": "string", - "x-enum-varnames": [ - "EVENT" - ] - } - }, - "type": "object" - }, - "type": "array" - }, - "links": { - "description": "Links attributes.", - "properties": { - "next": { - "description": "Link for the next set of results. Note that the request can also be made using the\nPOST endpoint.", - "example": "https://app.datadoghq.com/api/v2/events?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - } - }, - "type": "object" - }, - "meta": { - "description": "The metadata associated with a request.", - "properties": { - "elapsed": { - "description": "The time elapsed in milliseconds.", - "example": 132, - "format": "int64", - "type": "integer" - }, - "page": { - "description": "Pagination attributes.", - "properties": { - "after": { - "description": "The cursor to use to get the next results, if any. To make the next request, use the same\nparameters with the addition of the `page[cursor]`.", - "example": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", - "type": "string" - } - }, - "type": "object" - }, - "request_id": { - "description": "The identifier of the request.", - "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", - "type": "string" - }, - "status": { - "description": "The request status.", - "example": "done", - "type": "string" - }, - "warnings": { - "description": "A list of warnings (non-fatal errors) encountered. Partial results might be returned if\nwarnings are present in the response.", - "items": { - "description": "A warning message indicating something is wrong with the query.", - "properties": { - "code": { - "description": "A unique code for this type of warning.", - "example": "unknown_index", - "type": "string" - }, - "detail": { - "description": "A detailed explanation of this specific warning.", - "example": "indexes: foo, bar", - "type": "string" - }, - "title": { - "description": "A short human-readable summary of the warning.", - "example": "One or several indexes are missing or invalid. Results hold data from the other indexes.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } + "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": "object" + "type": "array" } }, + "required": [ + "errors" + ], "type": "object" } } }, - "description": "OK" + "description": "Unauthorized" }, - "400": { + "403": { "content": { "application/json": { "schema": { @@ -221178,9 +227130,9 @@ } } }, - "description": "Bad Request" + "description": "Forbidden" }, - "403": { + "404": { "content": { "application/json": { "schema": { @@ -221206,7 +227158,7 @@ } } }, - "description": "Not Authorized" + "description": "Not Found" }, "429": { "content": { @@ -221237,579 +227189,641 @@ "description": "Too many requests" } }, - "summary": "Search events", + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_read" + ] + } + ], + "summary": "Get a list of incidents", "tags": [ - "Events" + "Incidents" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 2, + "x-menu-order": 5, "x-pagination": { - "cursorParam": "body.page.cursor", - "cursorPath": "meta.page.after", - "limitParam": "body.page.limit", + "limitParam": "page[size]", + "pageOffsetParam": "page[offset]", "resultsPath": "data" }, "x-permission": { "operator": "OR", "permissions": [ - "events_read" + "incident_read" ] }, "x-undo": { "type": "safe" - } + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." }, - "x-merge-override": { - "post": false - } - }, - "/api/v2/incidents": { - "get": { - "description": "Get all incidents for the user's organization.", - "operationId": "ListIncidents", - "parameters": [ - { - "description": "Specifies which types of related objects should be included in the response.", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "description": "Object related to an incident.", - "enum": [ - "users", - "attachments" - ], - "type": "string", - "x-enum-varnames": [ - "USERS", - "ATTACHMENTS" - ] - }, - "type": "array" - } - }, - { - "description": "Size for a given page. The maximum allowed value is 100.", - "in": "query", - "name": "page[size]", - "required": false, - "schema": { - "default": 10, - "example": 10, - "format": "int64", - "type": "integer" - } - }, - { - "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" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "Response with a list of incidents.", - "properties": { - "data": { - "description": "An array of incidents.", - "example": [ - { - "attributes": { - "created": "2020-04-21T15:34:08.627205+00:00", - "creation_idempotency_key": null, - "customer_impact_duration": 0, - "customer_impact_end": null, - "customer_impact_scope": null, - "customer_impact_start": null, - "customer_impacted": false, - "detected": "2020-04-14T00:00:00+00:00", - "incident_type_uuid": "00000000-0000-0000-0000-000000000001", - "modified": "2020-09-17T14:16:58.696424+00:00", - "public_id": 1, - "resolved": null, - "severity": "SEV-1", - "time_to_detect": 0, - "time_to_internal_response": 0, - "time_to_repair": 0, - "time_to_resolve": 0, - "title": "Example Incident" + "post": { + "description": "Create an incident.", + "operationId": "CreateIncident", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Create request for an incident.", + "properties": { + "data": { + "description": "Incident data for a create request.", + "properties": { + "attributes": { + "description": "The incident's attributes for a create request.", + "properties": { + "customer_impact_scope": { + "description": "Required if `customer_impacted:\"true\"`. A summary of the impact customers experienced during the incident.", + "example": "Example customer impact scope", + "type": "string" }, - "id": "00000000-aaaa-0000-0000-000000000000", - "relationships": { - "attachments": { - "data": [ + "customer_impacted": { + "description": "A flag indicating whether the incident caused customer impact.", + "example": false, + "type": "boolean" + }, + "fields": { + "additionalProperties": { + "description": "Dynamic fields for which selections can be made, with field names as keys.", + "oneOf": [ { - "id": "00000000-9999-0000-0000-000000000000", - "type": "incident_attachments" + "description": "A field with a single value selected.", + "properties": { + "type": { + "default": "dropdown", + "description": "Type of the single value field definitions.", + "enum": [ + "dropdown", + "textbox" + ], + "example": "dropdown", + "type": "string", + "x-enum-varnames": [ + "DROPDOWN", + "TEXTBOX" + ] + }, + "value": { + "description": "The single value selected for this field.", + "example": "SEV-1", + "nullable": true, + "type": "string" + } + }, + "type": "object" }, { - "id": "00000000-1234-0000-0000-000000000000", - "type": "incident_attachments" + "description": "A field with potentially multiple values selected.", + "properties": { + "type": { + "default": "multiselect", + "description": "Type of the multiple value field definitions.", + "enum": [ + "multiselect", + "textarray", + "metrictag", + "autocomplete" + ], + "example": "multiselect", + "type": "string", + "x-enum-varnames": [ + "MULTISELECT", + "TEXTARRAY", + "METRICTAG", + "AUTOCOMPLETE" + ] + }, + "value": { + "description": "The multiple values selected for this field.", + "example": [ + "1.0", + "1.1" + ], + "items": { + "description": "A value which has been selected for the parent field.", + "example": "1.1", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" } ] }, - "commander_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - }, - "created_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" + "description": "A condensed view of the user-defined fields for which to create initial selections.", + "example": { + "severity": { + "type": "dropdown", + "value": "SEV-5" } }, - "integrations": { - "data": [ - { - "id": "00000000-0000-0000-4444-000000000000", - "type": "incident_integrations" - }, - { - "id": "00000000-0000-0000-5555-000000000000", - "type": "incident_integrations" - } - ] - }, - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - } + "type": "object" }, - "type": "incidents" - }, - { - "attributes": { - "created": "2020-04-21T15:34:08.627205+00:00", - "creation_idempotency_key": null, - "customer_impact_duration": 0, - "customer_impact_end": null, - "customer_impact_scope": null, - "customer_impact_start": null, - "customer_impacted": false, - "detected": "2020-04-14T00:00:00+00:00", - "incident_type_uuid": "00000000-0000-0000-0000-000000000002", - "modified": "2020-09-17T14:16:58.696424+00:00", - "public_id": 2, - "resolved": null, - "severity": "SEV-5", - "time_to_detect": 0, - "time_to_internal_response": 0, - "time_to_repair": 0, - "time_to_resolve": 0, - "title": "Example Incident 2" + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type. The default incident type will be used if this property is not provided.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" }, - "id": "00000000-1111-0000-0000-000000000000", - "relationships": { - "attachments": { - "data": [ - { - "id": "00000000-9999-0000-0000-000000000000", - "type": "incident_attachments" - } - ] - }, - "commander_user": { - "data": { - "id": "00000000-aaaa-0000-0000-000000000000", - "type": "users" - } - }, - "created_by_user": { - "data": { - "id": "00000000-aaaa-0000-0000-000000000000", - "type": "users" - } - }, - "integrations": { - "data": [ - { - "id": "00000000-0000-0000-0001-000000000000", - "type": "incident_integrations" - }, + "initial_cells": { + "description": "An array of initial timeline cells to be placed at the beginning of the incident timeline.", + "items": { + "description": "The timeline cell's attributes for a create request.", + "oneOf": [ { - "id": "00000000-0000-0000-0002-000000000000", - "type": "incident_integrations" - } - ] - }, - "last_modified_by_user": { - "data": { - "id": "00000000-aaaa-0000-0000-000000000000", - "type": "users" - } - } - }, - "type": "incidents" - } - ], - "items": { - "description": "Incident data from a response.", - "properties": { - "attributes": { - "description": "The incident's attributes from a response.", - "properties": { - "archived": { - "description": "Timestamp of when the incident was archived.", - "format": "date-time", - "nullable": true, - "readOnly": true, - "type": "string" - }, - "case_id": { - "description": "The incident case id.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "created": { - "description": "Timestamp when the incident was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "customer_impact_duration": { - "description": "Length of the incident's customer impact in seconds.\nEquals the difference between `customer_impact_start` and `customer_impact_end`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "customer_impact_end": { - "description": "Timestamp when customers were no longer impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impact_scope": { - "description": "A summary of the impact customers experienced during the incident.", - "example": "An example customer impact scope", - "nullable": true, - "type": "string" - }, - "customer_impact_start": { - "description": "Timestamp when customers began being impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impacted": { - "description": "A flag indicating whether the incident caused customer impact.", - "example": false, - "type": "boolean" - }, - "detected": { - "description": "Timestamp when the incident was detected.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "fields": { - "additionalProperties": { - "description": "Dynamic fields for which selections can be made, with field names as keys.", - "oneOf": [ - { - "description": "A field with a single value selected.", + "description": "Timeline cell data for Markdown timeline cells for a create request.", + "properties": { + "cell_type": { + "default": "markdown", + "description": "Type of the Markdown timeline cell.", + "enum": [ + "markdown" + ], + "example": "markdown", + "type": "string", + "x-enum-varnames": [ + "MARKDOWN" + ] + }, + "content": { + "description": "The Markdown timeline cell contents.", "properties": { - "type": { - "default": "dropdown", - "description": "Type of the single value field definitions.", - "enum": [ - "dropdown", - "textbox" - ], - "example": "dropdown", - "type": "string", - "x-enum-varnames": [ - "DROPDOWN", - "TEXTBOX" - ] - }, - "value": { - "description": "The single value selected for this field.", - "example": "SEV-1", - "nullable": true, + "content": { + "description": "The Markdown content of the cell.", + "example": "An example timeline cell message.", + "nullable": false, "type": "string" } }, "type": "object" }, - { - "description": "A field with potentially multiple values selected.", - "properties": { - "type": { - "default": "multiselect", - "description": "Type of the multiple value field definitions.", - "enum": [ - "multiselect", - "textarray", - "metrictag", - "autocomplete" - ], - "example": "multiselect", - "type": "string", - "x-enum-varnames": [ - "MULTISELECT", - "TEXTARRAY", - "METRICTAG", - "AUTOCOMPLETE" - ] - }, - "value": { - "description": "The multiple values selected for this field.", - "example": [ - "1.0", - "1.1" - ], - "items": { - "description": "A value which has been selected for the parent field.", - "example": "1.1", - "type": "string" - }, - "nullable": true, - "type": "array" - } - }, - "type": "object" + "important": { + "default": false, + "description": "A flag indicating whether the timeline cell is important and should be highlighted.", + "example": false, + "type": "boolean" } - ] - }, - "description": "A condensed view of the user-defined fields attached to incidents.", - "example": { - "severity": { - "type": "dropdown", - "value": "SEV-5" - } - }, - "type": "object" + }, + "required": [ + "content", + "cell_type" + ], + "type": "object" + } + ] + }, + "type": "array" + }, + "notification_handles": { + "description": "Notification handles that will be notified of the incident at creation.", + "example": [ + { + "display_name": "Jane Doe", + "handle": "@user@email.com" }, - "incident_type_uuid": { - "description": "A unique identifier that represents an incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "type": "string" + { + "display_name": "Slack Channel", + "handle": "@slack-channel" }, - "modified": { - "description": "Timestamp when the incident was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" + { + "display_name": "Incident Workflow", + "handle": "@workflow-from-incident" + } + ], + "items": { + "description": "A notification handle that will be notified at incident creation.", + "properties": { + "display_name": { + "description": "The name of the notified handle.", + "example": "Jane Doe", + "type": "string" + }, + "handle": { + "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", + "example": "@test.user@test.com", + "type": "string" + } }, - "non_datadog_creator": { - "description": "Incident's non Datadog creator.", + "type": "object" + }, + "type": "array" + }, + "title": { + "description": "The title of the incident, which summarizes what happened.", + "example": "A test incident title", + "type": "string" + } + }, + "required": [ + "title", + "customer_impacted" + ], + "type": "object" + }, + "relationships": { + "description": "The relationships the incident will have with other resources once created.", + "properties": { + "commander_user": { + "description": "Relationship to user.", + "nullable": true, + "properties": { + "data": { + "description": "Relationship to user object.", "nullable": true, "properties": { - "image_48_px": { - "description": "Non Datadog creator `48px` image.", - "type": "string" - }, - "name": { - "description": "Non Datadog creator name.", + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" - } - }, - "type": "object" - }, - "notification_handles": { - "description": "Notification handles that will be notified of the incident during update.", - "example": [ - { - "display_name": "Jane Doe", - "handle": "@user@email.com" - }, - { - "display_name": "Slack Channel", - "handle": "@slack-channel" }, - { - "display_name": "Incident Workflow", - "handle": "@workflow-from-incident" + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] } - ], - "items": { - "description": "A notification handle that will be notified at incident creation.", - "properties": { - "display_name": { - "description": "The name of the notified handle.", - "example": "Jane Doe", - "type": "string" - }, - "handle": { - "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", - "example": "@test.user@test.com", - "type": "string" - } - }, - "type": "object" }, - "nullable": true, - "type": "array" - }, - "public_id": { - "description": "The monotonically increasing integer ID for the incident.", - "example": 1, - "format": "int64", - "type": "integer" - }, - "resolved": { - "description": "Timestamp when the incident's state was last changed from active or stable to resolved or completed.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "severity": { - "description": "The incident severity.", - "enum": [ - "UNKNOWN", - "SEV-1", - "SEV-2", - "SEV-3", - "SEV-4", - "SEV-5" + "required": [ + "id", + "type" ], - "example": "UNKNOWN", - "type": "string", - "x-enum-varnames": [ - "UNKNOWN", - "SEV_1", - "SEV_2", - "SEV_3", - "SEV_4", - "SEV_5" - ] - }, - "state": { - "description": "The state incident.", - "nullable": true, - "type": "string" - }, - "time_to_detect": { - "description": "The amount of time in seconds to detect the incident.\nEquals the difference between `customer_impact_start` and `detected`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_internal_response": { - "description": "The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_repair": { - "description": "The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_resolve": { - "description": "The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "title": { - "description": "The title of the incident, which summarizes what happened.", - "example": "A test incident title", - "type": "string" - }, - "visibility": { - "description": "The incident visibility status.", - "nullable": true, - "type": "string" + "type": "object", + "x-merge-override": { + "required": false + } } }, "required": [ - "title" + "data" ], "type": "object" - }, - "id": { - "description": "The incident's ID.", - "example": "00000000-0000-0000-1234-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident's relationships from a response.", - "properties": { - "attachments": { - "description": "A relationship reference for attachments.", - "properties": { - "data": { - "description": "An array of incident attachments.", - "items": { - "description": "The attachment relationship data.", - "properties": { - "id": { - "description": "A unique identifier that represents the attachment.", - "example": "00000000-0000-abcd-1000-000000000000", + } + }, + "required": [ + "commander_user" + ], + "type": "object" + }, + "type": { + "default": "incidents", + "description": "Incident resource type.", + "enum": [ + "incidents" + ], + "example": "incidents", + "type": "string", + "x-enum-varnames": [ + "INCIDENTS" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Incident payload.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Response with an incident.", + "properties": { + "data": { + "description": "Incident data from a response.", + "properties": { + "attributes": { + "description": "The incident's attributes from a response.", + "properties": { + "archived": { + "description": "Timestamp of when the incident was archived.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "case_id": { + "description": "The incident case id.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "created": { + "description": "Timestamp when the incident was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "customer_impact_duration": { + "description": "Length of the incident's customer impact in seconds.\nEquals the difference between `customer_impact_start` and `customer_impact_end`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "customer_impact_end": { + "description": "Timestamp when customers were no longer impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impact_scope": { + "description": "A summary of the impact customers experienced during the incident.", + "example": "An example customer impact scope", + "nullable": true, + "type": "string" + }, + "customer_impact_start": { + "description": "Timestamp when customers began being impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impacted": { + "description": "A flag indicating whether the incident caused customer impact.", + "example": false, + "type": "boolean" + }, + "detected": { + "description": "Timestamp when the incident was detected.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "fields": { + "additionalProperties": { + "description": "Dynamic fields for which selections can be made, with field names as keys.", + "oneOf": [ + { + "description": "A field with a single value selected.", + "properties": { + "type": { + "default": "dropdown", + "description": "Type of the single value field definitions.", + "enum": [ + "dropdown", + "textbox" + ], + "example": "dropdown", + "type": "string", + "x-enum-varnames": [ + "DROPDOWN", + "TEXTBOX" + ] + }, + "value": { + "description": "The single value selected for this field.", + "example": "SEV-1", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + { + "description": "A field with potentially multiple values selected.", + "properties": { + "type": { + "default": "multiselect", + "description": "Type of the multiple value field definitions.", + "enum": [ + "multiselect", + "textarray", + "metrictag", + "autocomplete" + ], + "example": "multiselect", + "type": "string", + "x-enum-varnames": [ + "MULTISELECT", + "TEXTARRAY", + "METRICTAG", + "AUTOCOMPLETE" + ] + }, + "value": { + "description": "The multiple values selected for this field.", + "example": [ + "1.0", + "1.1" + ], + "items": { + "description": "A value which has been selected for the parent field.", + "example": "1.1", "type": "string" }, - "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", - "enum": [ - "incident_attachments" - ], - "example": "incident_attachments", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "nullable": true, + "type": "array" } }, - "type": "array" + "type": "object" } + ] + }, + "description": "A condensed view of the user-defined fields attached to incidents.", + "example": { + "severity": { + "type": "dropdown", + "value": "SEV-5" + } + }, + "type": "object" + }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "modified": { + "description": "Timestamp when the incident was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "non_datadog_creator": { + "description": "Incident's non Datadog creator.", + "nullable": true, + "properties": { + "image_48_px": { + "description": "Non Datadog creator `48px` image.", + "type": "string" }, - "required": [ - "data" - ], - "type": "object" + "name": { + "description": "Non Datadog creator name.", + "type": "string" + } }, - "commander_user": { - "description": "Relationship to user.", - "nullable": true, + "type": "object" + }, + "notification_handles": { + "description": "Notification handles that will be notified of the incident during update.", + "example": [ + { + "display_name": "Jane Doe", + "handle": "@user@email.com" + }, + { + "display_name": "Slack Channel", + "handle": "@slack-channel" + }, + { + "display_name": "Incident Workflow", + "handle": "@workflow-from-incident" + } + ], + "items": { + "description": "A notification handle that will be notified at incident creation.", "properties": { - "data": { - "description": "Relationship to user object.", - "nullable": true, + "display_name": { + "description": "The name of the notified handle.", + "example": "Jane Doe", + "type": "string" + }, + "handle": { + "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", + "example": "@test.user@test.com", + "type": "string" + } + }, + "type": "object" + }, + "nullable": true, + "type": "array" + }, + "public_id": { + "description": "The monotonically increasing integer ID for the incident.", + "example": 1, + "format": "int64", + "type": "integer" + }, + "resolved": { + "description": "Timestamp when the incident's state was last changed from active or stable to resolved or completed.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "severity": { + "description": "The incident severity.", + "enum": [ + "UNKNOWN", + "SEV-1", + "SEV-2", + "SEV-3", + "SEV-4", + "SEV-5" + ], + "example": "UNKNOWN", + "type": "string", + "x-enum-varnames": [ + "UNKNOWN", + "SEV_1", + "SEV_2", + "SEV_3", + "SEV_4", + "SEV_5" + ] + }, + "state": { + "description": "The state incident.", + "nullable": true, + "type": "string" + }, + "time_to_detect": { + "description": "The amount of time in seconds to detect the incident.\nEquals the difference between `customer_impact_start` and `detected`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_internal_response": { + "description": "The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_repair": { + "description": "The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_resolve": { + "description": "The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "title": { + "description": "The title of the incident, which summarizes what happened.", + "example": "A test incident title", + "type": "string" + }, + "visibility": { + "description": "The incident visibility status.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "title" + ], + "type": "object" + }, + "id": { + "description": "The incident's ID.", + "example": "00000000-0000-0000-1234-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident's relationships from a response.", + "properties": { + "attachments": { + "description": "A relationship reference for attachments.", + "properties": { + "data": { + "description": "An array of incident attachments.", + "items": { + "description": "The attachment relationship data.", "properties": { "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-0000-000000000000", + "description": "A unique identifier that represents the attachment.", + "example": "00000000-0000-abcd-1000-000000000000", "type": "string" }, "type": { - "default": "users", - "description": "Users resource type.", + "default": "incident_attachments", + "description": "The incident attachment resource type.", "enum": [ - "users" + "incident_attachments" ], - "example": "users", + "example": "incident_attachments", "type": "string", "x-enum-varnames": [ - "USERS" + "INCIDENT_ATTACHMENTS" ] } }, @@ -221821,34 +227835,117 @@ "x-merge-override": { "required": false } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "commander_user": { + "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": "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 } - }, - "required": [ - "data" - ], - "type": "object" + } }, - "created_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "description": "Relationship to user object.", + "required": [ + "data" + ], + "type": "object" + }, + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "impacts": { + "description": "Relationship to impacts.", + "properties": { + "data": { + "description": "An array of incident impacts.", + "items": { + "description": "Relationship to impact object.", "properties": { "id": { - "description": "A unique identifier that represents the user.", + "description": "A unique identifier that represents the impact.", "example": "00000000-0000-0000-2345-000000000000", "type": "string" }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "The incident impacts type.", "enum": [ - "users" + "incident_impacts" ], - "example": "users", + "example": "incident_impacts", "type": "string", "x-enum-varnames": [ - "USERS" + "INCIDENT_IMPACTS" ] } }, @@ -221860,145 +227957,145 @@ "x-merge-override": { "required": false } - } - }, - "required": [ - "data" - ], - "type": "object" + }, + "type": "array" + } }, - "impacts": { - "description": "Relationship to impacts.", - "properties": { - "data": { - "description": "An array of incident impacts.", - "items": { - "description": "Relationship to impact object.", - "properties": { - "id": { - "description": "A unique identifier that represents the impact.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "description": "The incident impacts type.", - "enum": [ - "incident_impacts" - ], - "example": "incident_impacts", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_IMPACTS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" + "required": [ + "data" + ], + "type": "object" + }, + "integrations": { + "description": "A relationship reference for multiple integration metadata objects.", + "example": { + "data": [ + { + "id": "00000000-abcd-0005-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0006-0000-000000000000", + "type": "incident_integrations" } - }, - "required": [ - "data" - ], - "type": "object" + ] }, - "integrations": { - "description": "A relationship reference for multiple integration metadata objects.", - "example": { - "data": [ + "properties": { + "data": { + "description": "Integration metadata relationship array", + "example": [ { - "id": "00000000-abcd-0005-0000-000000000000", + "id": "00000000-abcd-0003-0000-000000000000", "type": "incident_integrations" }, { - "id": "00000000-abcd-0006-0000-000000000000", + "id": "00000000-abcd-0004-0000-000000000000", "type": "incident_integrations" } - ] - }, - "properties": { - "data": { - "description": "Integration metadata relationship array", - "example": [ - { - "id": "00000000-abcd-0003-0000-000000000000", - "type": "incident_integrations" + ], + "items": { + "description": "A relationship reference for an integration metadata object.", + "example": { + "id": "00000000-abcd-0002-0000-000000000000", + "type": "incident_integrations" + }, + "properties": { + "id": { + "description": "A unique identifier that represents the integration metadata.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" }, - { - "id": "00000000-abcd-0004-0000-000000000000", - "type": "incident_integrations" + "type": { + "default": "incident_integrations", + "description": "Integration metadata resource type.", + "enum": [ + "incident_integrations" + ], + "example": "incident_integrations", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_INTEGRATIONS" + ] } + }, + "required": [ + "id", + "type" ], - "items": { - "description": "A relationship reference for an integration metadata object.", - "example": { - "id": "00000000-abcd-0002-0000-000000000000", - "type": "incident_integrations" - }, - "properties": { - "id": { - "description": "A unique identifier that represents the integration metadata.", - "example": "00000000-abcd-0001-0000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", - "enum": [ - "incident_integrations" - ], - "example": "incident_integrations", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" }, - "type": "array" + "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 } - }, - "required": [ - "data" - ], - "type": "object" + } }, - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "description": "Relationship to user object.", + "required": [ + "data" + ], + "type": "object" + }, + "responders": { + "description": "Relationship to incident responders.", + "properties": { + "data": { + "description": "An array of incident responders.", + "items": { + "description": "Relationship to impact object.", "properties": { "id": { - "description": "A unique identifier that represents the user.", + "description": "A unique identifier that represents the responder.", "example": "00000000-0000-0000-2345-000000000000", "type": "string" }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "The incident responders type.", "enum": [ - "users" + "incident_responders" ], - "example": "users", + "example": "incident_responders", "type": "string", "x-enum-varnames": [ - "USERS" + "INCIDENT_RESPONDERS" ] } }, @@ -222010,123 +228107,81 @@ "x-merge-override": { "required": false } - } - }, - "required": [ - "data" - ], - "type": "object" + }, + "type": "array" + } }, - "responders": { - "description": "Relationship to incident responders.", - "properties": { - "data": { - "description": "An array of incident responders.", - "items": { - "description": "Relationship to impact object.", - "properties": { - "id": { - "description": "A unique identifier that represents the responder.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "description": "The incident responders type.", - "enum": [ - "incident_responders" - ], - "example": "incident_responders", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_RESPONDERS" - ] - } + "required": [ + "data" + ], + "type": "object" + }, + "user_defined_fields": { + "description": "Relationship to incident user defined fields.", + "properties": { + "data": { + "description": "An array of user defined fields.", + "items": { + "description": "Relationship to impact object.", + "properties": { + "id": { + "description": "A unique identifier that represents the responder.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "type": { + "description": "The incident user defined fields type.", + "enum": [ + "user_defined_field" + ], + "example": "user_defined_field", + "type": "string", + "x-enum-varnames": [ + "USER_DEFINED_FIELD" + ] } }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } }, - "user_defined_fields": { - "description": "Relationship to incident user defined fields.", - "properties": { - "data": { - "description": "An array of user defined fields.", - "items": { - "description": "Relationship to impact object.", - "properties": { - "id": { - "description": "A unique identifier that represents the responder.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "description": "The incident user defined fields type.", - "enum": [ - "user_defined_field" - ], - "example": "user_defined_field", - "type": "string", - "x-enum-varnames": [ - "USER_DEFINED_FIELD" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + "required": [ + "data" + ], + "type": "object" + } }, - "type": { - "default": "incidents", - "description": "Incident resource type.", - "enum": [ - "incidents" - ], - "example": "incidents", - "type": "string", - "x-enum-varnames": [ - "INCIDENTS" - ] - } + "type": "object" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "type": { + "default": "incidents", + "description": "Incident resource type.", + "enum": [ + "incidents" + ], + "example": "incidents", + "type": "string", + "x-enum-varnames": [ + "INCIDENTS" + ] } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } }, "included": { "description": "Included related resources that the user requested.", @@ -222201,209 +228256,1311 @@ } } }, - "type": "incident_attachments" - }, - "properties": { - "attributes": { - "description": "The attributes object for an attachment.", - "oneOf": [ - { - "description": "The attributes object for a postmortem attachment.", - "properties": { - "attachment": { - "description": "The postmortem attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this notebook attachment.", - "example": "https://app.datadoghq.com/notebook/123", - "type": "string" - }, - "title": { - "description": "The title of this postmortem attachment.", - "example": "Postmortem IR-123", - "type": "string" - } - }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" - }, - "attachment_type": { - "default": "postmortem", - "description": "The type of postmortem attachment attributes.", - "enum": [ - "postmortem" - ], - "example": "postmortem", - "type": "string", - "x-enum-varnames": [ - "POSTMORTEM" - ] - } - }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - }, - { - "description": "The attributes object for a link attachment.", - "properties": { - "attachment": { - "description": "The link attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this link attachment.", - "example": "https://www.example.com/webstore-failure-runbook", - "type": "string" - }, - "title": { - "description": "The title of this link attachment.", - "example": "Runbook for webstore service failures", - "type": "string" - } - }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" - }, - "attachment_type": { - "default": "link", - "description": "The type of link attachment attributes.", - "enum": [ - "link" - ], - "example": "link", - "type": "string", - "x-enum-varnames": [ - "LINK" - ] - }, - "modified": { - "description": "Timestamp when the incident attachment link was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - } - }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - } - ] + "type": "incident_attachments" + }, + "properties": { + "attributes": { + "description": "The attributes object for an attachment.", + "oneOf": [ + { + "description": "The attributes object for a postmortem attachment.", + "properties": { + "attachment": { + "description": "The postmortem attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this notebook attachment.", + "example": "https://app.datadoghq.com/notebook/123", + "type": "string" + }, + "title": { + "description": "The title of this postmortem attachment.", + "example": "Postmortem IR-123", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" + }, + "attachment_type": { + "default": "postmortem", + "description": "The type of postmortem attachment attributes.", + "enum": [ + "postmortem" + ], + "example": "postmortem", + "type": "string", + "x-enum-varnames": [ + "POSTMORTEM" + ] + } + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + }, + { + "description": "The attributes object for a link attachment.", + "properties": { + "attachment": { + "description": "The link attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this link attachment.", + "example": "https://www.example.com/webstore-failure-runbook", + "type": "string" + }, + "title": { + "description": "The title of this link attachment.", + "example": "Runbook for webstore service failures", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" + }, + "attachment_type": { + "default": "link", + "description": "The type of link attachment attributes.", + "enum": [ + "link" + ], + "example": "link", + "type": "string", + "x-enum-varnames": [ + "LINK" + ] + }, + "modified": { + "description": "Timestamp when the incident attachment link was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + } + ] + }, + "id": { + "description": "A unique identifier that represents the incident attachment.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident attachment's relationships.", + "properties": { + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] + } + }, + "required": [ + "type", + "attributes", + "id", + "relationships" + ], + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "CREATED" + }, + "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": [ + "incident_write" + ] + } + ], + "summary": "Create an incident", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-given": { + "incident": { + "parameters": [ + { + "name": "body", + "value": "{\n \"data\": {\n \"attributes\": {\n \"title\": \"{{ unique }}\",\n \"customer_impacted\": false\n },\n \"type\": \"incidents\"\n }\n}" + } + ], + "step": "there is a valid \"incident\" in the system" + } + }, + "x-menu-order": 1, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_write" + ] + }, + "x-undo": { + "operationId": "DeleteIncident", + "parameters": [ + { + "name": "incident_id", + "source": "data.id" + } + ], + "type": "unsafe" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + } + }, + "/api/v2/incidents/config/types": { + "get": { + "description": "Get all incident types.", + "operationId": "ListIncidentTypes", + "parameters": [ + { + "description": "Include deleted incident types in the response.", + "in": "query", + "name": "include_deleted", + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response with a list of incident types.", + "properties": { + "data": { + "description": "An array of incident type objects.", + "items": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", + "example": false, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" }, - "id": { - "description": "A unique identifier that represents the incident attachment.", - "example": "00000000-abcd-0001-0000-000000000000", + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, "type": "string" }, - "relationships": { - "description": "The incident attachment's relationships.", - "properties": { - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" }, - "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", - "enum": [ - "incident_attachments" - ], - "example": "incident_attachments", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" - ] + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" } }, "required": [ - "type", - "attributes", - "id", - "relationships" + "name" ], "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] } - ] + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "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" + }, + "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" }, - "readOnly": true, "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_settings_read", + "incident_read" + ] + } + ], + "summary": "Get a list of incident types", + "tags": [ + "Incidents" + ], + "x-menu-order": 20, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_settings_read", + "incident_read" + ] + }, + "x-undo": { + "type": "safe" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "post": { + "description": "Create an incident type.", + "operationId": "CreateIncidentType", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Create request for an incident type.", + "properties": { + "data": { + "description": "Incident type data for a create request.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", + "example": false, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } }, - "meta": { - "description": "The metadata object containing pagination metadata.", + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Incident type payload.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Incident type response data.", + "properties": { + "data": { + "description": "Incident type response data.", "properties": { - "pagination": { - "description": "Pagination properties.", + "attributes": { + "description": "Incident type's attributes.", "properties": { - "next_offset": { - "description": "The index of the first element in the next page of results. Equal to page size added to the current offset.", - "example": 1000, - "format": "int64", - "type": "integer" + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" }, - "offset": { - "description": "The index of the first element in the results.", - "example": 10, - "format": "int64", - "type": "integer" + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" }, - "size": { - "description": "Maximum size of pages to return.", - "example": 1000, - "format": "int64", - "type": "integer" + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", + "example": false, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "CREATED" + }, + "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": [ + "incident_settings_write" + ] + } + ], + "summary": "Create an incident type", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-given": { + "incident_type": { + "parameters": [ + { + "name": "body", + "value": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Security Incident\",\n \"description\": \"Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.\",\n \"is_default\": false\n },\n \"type\": \"incident_types\"\n }\n}" + } + ], + "step": "there is a valid \"incident_type\" in the system" + } + }, + "x-menu-order": 19, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_settings_write" + ] + }, + "x-undo": { + "operationId": "DeleteIncidentType", + "parameters": [ + { + "name": "incident_type_id", + "source": "data.id" + } + ], + "type": "unsafe" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + } + }, + "/api/v2/incidents/config/types/{incident_type_id}": { + "delete": { + "description": "Delete an incident type.", + "operationId": "DeleteIncidentType", + "parameters": [ + { + "description": "The UUID of the incident type.", + "in": "path", + "name": "incident_type_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "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": [ + "incident_settings_write" + ] + } + ], + "summary": "Delete an incident type", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 23, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_settings_write" + ] + }, + "x-undo": { + "type": "idempotent" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "get": { + "description": "Get incident type details.", + "operationId": "GetIncidentType", + "parameters": [ + { + "description": "The UUID of the incident type.", + "in": "path", + "name": "incident_type_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Incident type response data.", + "properties": { + "data": { + "description": "Incident type response data.", + "properties": { + "attributes": { + "description": "Incident type's attributes.", + "properties": { + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", + "type": "string" + }, + "is_default": { + "default": false, + "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", + "example": false, + "type": "boolean" + }, + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" + }, + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, + "type": "string" } }, + "required": [ + "name" + ], "type": "object" + }, + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] } }, - "readOnly": true, + "required": [ + "id", + "type" + ], "type": "object" } }, @@ -222564,23 +229721,20 @@ }, { "AuthZ": [ + "incident_settings_read", "incident_read" ] } ], - "summary": "Get a list of incidents", + "summary": "Get incident type details", "tags": [ "Incidents" ], - "x-menu-order": 5, - "x-pagination": { - "limitParam": "page[size]", - "pageOffsetParam": "page[offset]", - "resultsPath": "data" - }, + "x-menu-order": 21, "x-permission": { "operator": "OR", "permissions": [ + "incident_settings_read", "incident_read" ] }, @@ -222589,281 +229743,104 @@ }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." }, - "post": { - "description": "Create an incident.", - "operationId": "CreateIncident", + "patch": { + "description": "Update an incident type.", + "operationId": "UpdateIncidentType", + "parameters": [ + { + "description": "The UUID of the incident type.", + "in": "path", + "name": "incident_type_id", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "description": "Create request for an incident.", + "description": "Patch request for an incident type.", "properties": { "data": { - "description": "Incident data for a create request.", + "description": "Incident type data for a patch request.", "properties": { "attributes": { - "description": "The incident's attributes for a create request.", + "description": "Incident type's attributes for updates.", "properties": { - "customer_impact_scope": { - "description": "Required if `customer_impacted:\"true\"`. A summary of the impact customers experienced during the incident.", - "example": "Example customer impact scope", + "createdAt": { + "description": "Timestamp when the incident type was created.", + "format": "date-time", + "readOnly": true, "type": "string" }, - "customer_impacted": { - "description": "A flag indicating whether the incident caused customer impact.", + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", + "type": "string" + }, + "is_default": { + "description": "When true, this incident type will be used as the default type when an incident type is not specified.", "example": false, "type": "boolean" }, - "fields": { - "additionalProperties": { - "description": "Dynamic fields for which selections can be made, with field names as keys.", - "oneOf": [ - { - "description": "A field with a single value selected.", - "properties": { - "type": { - "default": "dropdown", - "description": "Type of the single value field definitions.", - "enum": [ - "dropdown", - "textbox" - ], - "example": "dropdown", - "type": "string", - "x-enum-varnames": [ - "DROPDOWN", - "TEXTBOX" - ] - }, - "value": { - "description": "The single value selected for this field.", - "example": "SEV-1", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - { - "description": "A field with potentially multiple values selected.", - "properties": { - "type": { - "default": "multiselect", - "description": "Type of the multiple value field definitions.", - "enum": [ - "multiselect", - "textarray", - "metrictag", - "autocomplete" - ], - "example": "multiselect", - "type": "string", - "x-enum-varnames": [ - "MULTISELECT", - "TEXTARRAY", - "METRICTAG", - "AUTOCOMPLETE" - ] - }, - "value": { - "description": "The multiple values selected for this field.", - "example": [ - "1.0", - "1.1" - ], - "items": { - "description": "A value which has been selected for the parent field.", - "example": "1.1", - "type": "string" - }, - "nullable": true, - "type": "array" - } - }, - "type": "object" - } - ] - }, - "description": "A condensed view of the user-defined fields for which to create initial selections.", - "example": { - "severity": { - "type": "dropdown", - "value": "SEV-5" - } - }, - "type": "object" - }, - "incident_type_uuid": { - "description": "A unique identifier that represents an incident type. The default incident type will be used if this property is not provided.", + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", "example": "00000000-0000-0000-0000-000000000000", + "readOnly": true, "type": "string" }, - "initial_cells": { - "description": "An array of initial timeline cells to be placed at the beginning of the incident timeline.", - "items": { - "description": "The timeline cell's attributes for a create request.", - "oneOf": [ - { - "description": "Timeline cell data for Markdown timeline cells for a create request.", - "properties": { - "cell_type": { - "default": "markdown", - "description": "Type of the Markdown timeline cell.", - "enum": [ - "markdown" - ], - "example": "markdown", - "type": "string", - "x-enum-varnames": [ - "MARKDOWN" - ] - }, - "content": { - "description": "The Markdown timeline cell contents.", - "properties": { - "content": { - "description": "The Markdown content of the cell.", - "example": "An example timeline cell message.", - "nullable": false, - "type": "string" - } - }, - "type": "object" - }, - "important": { - "default": false, - "description": "A flag indicating whether the timeline cell is important and should be highlighted.", - "example": false, - "type": "boolean" - } - }, - "required": [ - "content", - "cell_type" - ], - "type": "object" - } - ] - }, - "type": "array" + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" }, - "notification_handles": { - "description": "Notification handles that will be notified of the incident at creation.", - "example": [ - { - "display_name": "Jane Doe", - "handle": "@user@email.com" - }, - { - "display_name": "Slack Channel", - "handle": "@slack-channel" - }, - { - "display_name": "Incident Workflow", - "handle": "@workflow-from-incident" - } - ], - "items": { - "description": "A notification handle that will be notified at incident creation.", - "properties": { - "display_name": { - "description": "The name of the notified handle.", - "example": "Jane Doe", - "type": "string" - }, - "handle": { - "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", - "example": "@test.user@test.com", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", + "type": "string" }, - "title": { - "description": "The title of the incident, which summarizes what happened.", - "example": "A test incident title", + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", + "readOnly": true, "type": "string" } }, - "required": [ - "title", - "customer_impacted" - ], "type": "object" }, - "relationships": { - "description": "The relationships the incident will have with other resources once created.", - "properties": { - "commander_user": { - "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": "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "required": [ - "commander_user" - ], - "type": "object" + "id": { + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" }, "type": { - "default": "incidents", - "description": "Incident resource type.", + "default": "incident_types", + "description": "Incident type resource type.", "enum": [ - "incidents" + "incident_types" ], - "example": "incidents", + "example": "incident_types", "type": "string", "x-enum-varnames": [ - "INCIDENTS" + "INCIDENT_TYPES" ] } }, "required": [ + "id", "type", "attributes" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, "required": [ @@ -222873,639 +229850,1410 @@ } } }, - "description": "Incident payload.", + "description": "Incident type payload.", "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "description": "Response with an incident.", + "description": "Incident type response data.", "properties": { "data": { - "description": "Incident data from a response.", + "description": "Incident type response data.", "properties": { "attributes": { - "description": "The incident's attributes from a response.", + "description": "Incident type's attributes.", "properties": { - "archived": { - "description": "Timestamp of when the incident was archived.", - "format": "date-time", - "nullable": true, - "readOnly": true, - "type": "string" - }, - "case_id": { - "description": "The incident case id.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "created": { - "description": "Timestamp when the incident was created.", + "createdAt": { + "description": "Timestamp when the incident type was created.", "format": "date-time", "readOnly": true, "type": "string" }, - "customer_impact_duration": { - "description": "Length of the incident's customer impact in seconds.\nEquals the difference between `customer_impact_start` and `customer_impact_end`.", - "format": "int64", + "createdBy": { + "description": "A unique identifier that represents the user that created the incident type.", + "example": "00000000-0000-0000-0000-000000000000", "readOnly": true, - "type": "integer" - }, - "customer_impact_end": { - "description": "Timestamp when customers were no longer impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impact_scope": { - "description": "A summary of the impact customers experienced during the incident.", - "example": "An example customer impact scope", - "nullable": true, "type": "string" }, - "customer_impact_start": { - "description": "Timestamp when customers began being impacted by the incident.", - "format": "date-time", - "nullable": true, + "description": { + "description": "Text that describes the incident type.", + "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", "type": "string" }, - "customer_impacted": { - "description": "A flag indicating whether the incident caused customer impact.", + "is_default": { + "default": false, + "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", "example": false, "type": "boolean" }, - "detected": { - "description": "Timestamp when the incident was detected.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "fields": { - "additionalProperties": { - "description": "Dynamic fields for which selections can be made, with field names as keys.", - "oneOf": [ - { - "description": "A field with a single value selected.", - "properties": { - "type": { - "default": "dropdown", - "description": "Type of the single value field definitions.", - "enum": [ - "dropdown", - "textbox" - ], - "example": "dropdown", - "type": "string", - "x-enum-varnames": [ - "DROPDOWN", - "TEXTBOX" - ] - }, - "value": { - "description": "The single value selected for this field.", - "example": "SEV-1", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - { - "description": "A field with potentially multiple values selected.", - "properties": { - "type": { - "default": "multiselect", - "description": "Type of the multiple value field definitions.", - "enum": [ - "multiselect", - "textarray", - "metrictag", - "autocomplete" - ], - "example": "multiselect", - "type": "string", - "x-enum-varnames": [ - "MULTISELECT", - "TEXTARRAY", - "METRICTAG", - "AUTOCOMPLETE" - ] - }, - "value": { - "description": "The multiple values selected for this field.", - "example": [ - "1.0", - "1.1" - ], - "items": { - "description": "A value which has been selected for the parent field.", - "example": "1.1", - "type": "string" - }, - "nullable": true, - "type": "array" - } - }, - "type": "object" - } - ] - }, - "description": "A condensed view of the user-defined fields attached to incidents.", - "example": { - "severity": { - "type": "dropdown", - "value": "SEV-5" - } - }, - "type": "object" - }, - "incident_type_uuid": { - "description": "A unique identifier that represents an incident type.", + "lastModifiedBy": { + "description": "A unique identifier that represents the user that last modified the incident type.", "example": "00000000-0000-0000-0000-000000000000", - "type": "string" - }, - "modified": { - "description": "Timestamp when the incident was last modified.", - "format": "date-time", "readOnly": true, "type": "string" }, - "non_datadog_creator": { - "description": "Incident's non Datadog creator.", - "nullable": true, - "properties": { - "image_48_px": { - "description": "Non Datadog creator `48px` image.", - "type": "string" - }, - "name": { - "description": "Non Datadog creator name.", - "type": "string" - } - }, - "type": "object" - }, - "notification_handles": { - "description": "Notification handles that will be notified of the incident during update.", - "example": [ - { - "display_name": "Jane Doe", - "handle": "@user@email.com" - }, - { - "display_name": "Slack Channel", - "handle": "@slack-channel" - }, - { - "display_name": "Incident Workflow", - "handle": "@workflow-from-incident" - } - ], - "items": { - "description": "A notification handle that will be notified at incident creation.", - "properties": { - "display_name": { - "description": "The name of the notified handle.", - "example": "Jane Doe", - "type": "string" - }, - "handle": { - "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", - "example": "@test.user@test.com", - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "public_id": { - "description": "The monotonically increasing integer ID for the incident.", - "example": 1, - "format": "int64", - "type": "integer" - }, - "resolved": { - "description": "Timestamp when the incident's state was last changed from active or stable to resolved or completed.", + "modifiedAt": { + "description": "Timestamp when the incident type was last modified.", "format": "date-time", - "nullable": true, + "readOnly": true, "type": "string" }, - "severity": { - "description": "The incident severity.", - "enum": [ - "UNKNOWN", - "SEV-1", - "SEV-2", - "SEV-3", - "SEV-4", - "SEV-5" - ], - "example": "UNKNOWN", - "type": "string", - "x-enum-varnames": [ - "UNKNOWN", - "SEV_1", - "SEV_2", - "SEV_3", - "SEV_4", - "SEV_5" - ] - }, - "state": { - "description": "The state incident.", - "nullable": true, + "name": { + "description": "The name of the incident type.", + "example": "Security Incident", "type": "string" }, - "time_to_detect": { - "description": "The amount of time in seconds to detect the incident.\nEquals the difference between `customer_impact_start` and `detected`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_internal_response": { - "description": "The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_repair": { - "description": "The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_resolve": { - "description": "The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`.", - "format": "int64", + "prefix": { + "description": "The string that will be prepended to the incident title across the Datadog app.", + "example": "IR", "readOnly": true, - "type": "integer" - }, - "title": { - "description": "The title of the incident, which summarizes what happened.", - "example": "A test incident title", - "type": "string" - }, - "visibility": { - "description": "The incident visibility status.", - "nullable": true, "type": "string" } }, "required": [ - "title" + "name" ], "type": "object" }, "id": { - "description": "The incident's ID.", - "example": "00000000-0000-0000-1234-000000000000", + "description": "The incident type's ID.", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" }, - "relationships": { - "description": "The incident's relationships from a response.", + "type": { + "default": "incident_types", + "description": "Incident type resource type.", + "enum": [ + "incident_types" + ], + "example": "incident_types", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TYPES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "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": [ + "incident_settings_write" + ] + } + ], + "summary": "Update an incident type", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 22, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_settings_write" + ] + }, + "x-undo": { + "type": "idempotent" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + } + }, + "/api/v2/incidents/search": { + "get": { + "description": "Search for incidents matching a certain query.", + "operationId": "SearchIncidents", + "parameters": [ + { + "description": "Specifies which types of related objects should be included in the response.", + "in": "query", + "name": "include", + "required": false, + "schema": { + "description": "Object related to an incident.", + "enum": [ + "users", + "attachments" + ], + "type": "string", + "x-enum-varnames": [ + "USERS", + "ATTACHMENTS" + ] + } + }, + { + "description": "Specifies which incidents should be returned. The query can contain any number of incident facets\njoined by `ANDs`, along with multiple values for each of those facets joined by `OR`s. For\nexample: `state:active AND severity:(SEV-2 OR SEV-1)`.", + "explode": false, + "in": "query", + "name": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Specifies the order of returned incidents.", + "explode": false, + "in": "query", + "name": "sort", + "required": false, + "schema": { + "description": "The ways searched incidents can be sorted.", + "enum": [ + "created", + "-created" + ], + "type": "string", + "x-enum-varnames": [ + "CREATED_ASCENDING", + "CREATED_DESCENDING" + ] + } + }, + { + "description": "Size for a given page. The maximum allowed value is 100.", + "in": "query", + "name": "page[size]", + "required": false, + "schema": { + "default": 10, + "example": 10, + "format": "int64", + "type": "integer" + } + }, + { + "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" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response with incidents and facets.", + "properties": { + "data": { + "description": "Data returned by an incident search.", + "properties": { + "attributes": { + "description": "Attributes returned by an incident search.", "properties": { - "attachments": { - "description": "A relationship reference for attachments.", + "facets": { + "description": "Facet data for incidents returned by a search query.", "properties": { - "data": { - "description": "An array of incident attachments.", + "commander": { + "description": "Facet data for incident commander users.", "items": { - "description": "The attachment relationship data.", + "description": "Facet data for user attributes of an incident.", "properties": { - "id": { - "description": "A unique identifier that represents the attachment.", - "example": "00000000-0000-abcd-1000-000000000000", + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "email": { + "description": "Email of the user.", + "example": "datadog.user@example.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "@datadog.user@example.com", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "Datadog User", + "type": "string" + }, + "uuid": { + "description": "ID of the user.", + "example": "773b045d-ccf8-4808-bd3b-955ef6a8c940", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "created_by": { + "description": "Facet data for incident creator users.", + "items": { + "description": "Facet data for user attributes of an incident.", + "properties": { + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "email": { + "description": "Email of the user.", + "example": "datadog.user@example.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "@datadog.user@example.com", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "Datadog User", "type": "string" }, - "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", - "enum": [ - "incident_attachments" - ], - "example": "incident_attachments", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" - ] + "uuid": { + "description": "ID of the user.", + "example": "773b045d-ccf8-4808-bd3b-955ef6a8c940", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "fields": { + "description": "Facet data for incident property fields.", + "items": { + "description": "Facet data for the incident property fields.", + "properties": { + "aggregates": { + "description": "Aggregate information for numeric incident data.", + "properties": { + "max": { + "description": "Maximum value of the numeric aggregates.", + "example": 1234, + "format": "double", + "nullable": true, + "type": "number" + }, + "min": { + "description": "Minimum value of the numeric aggregates.", + "example": 20, + "format": "double", + "nullable": true, + "type": "number" + } + }, + "type": "object" + }, + "facets": { + "description": "Facet data for the property field of an incident.", + "items": { + "description": "Facet value and number of occurrences for a property field of an incident.", + "properties": { + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "name": { + "description": "The facet value appearing in search results.", + "example": "SEV-2", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "name": { + "description": "Name of the incident property field.", + "example": "Severity", + "type": "string" } }, "required": [ - "id", - "type" + "facets", + "name" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "commander_user": { - "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": "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "created_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + }, + "impact": { + "description": "Facet data for incident impact attributes.", + "items": { + "description": "Facet value and number of occurrences for a property field of an incident.", + "properties": { + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "name": { + "description": "The facet value appearing in search results.", + "example": "SEV-2", + "type": "string" + } }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } + "type": "object" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "impacts": { - "description": "Relationship to impacts.", - "properties": { - "data": { - "description": "An array of incident impacts.", + "type": "array" + }, + "last_modified_by": { + "description": "Facet data for incident last modified by users.", "items": { - "description": "Relationship to impact object.", + "description": "Facet data for user attributes of an incident.", "properties": { - "id": { - "description": "A unique identifier that represents the impact.", - "example": "00000000-0000-0000-2345-000000000000", + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "email": { + "description": "Email of the user.", + "example": "datadog.user@example.com", "type": "string" }, - "type": { - "description": "The incident impacts type.", - "enum": [ - "incident_impacts" - ], - "example": "incident_impacts", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_IMPACTS" - ] + "handle": { + "description": "Handle of the user.", + "example": "@datadog.user@example.com", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "Datadog User", + "type": "string" + }, + "uuid": { + "description": "ID of the user.", + "example": "773b045d-ccf8-4808-bd3b-955ef6a8c940", + "type": "string" } }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "integrations": { - "description": "A relationship reference for multiple integration metadata objects.", - "example": { - "data": [ - { - "id": "00000000-abcd-0005-0000-000000000000", - "type": "incident_integrations" + }, + "postmortem": { + "description": "Facet data for incident postmortem existence.", + "items": { + "description": "Facet value and number of occurrences for a property field of an incident.", + "properties": { + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "name": { + "description": "The facet value appearing in search results.", + "example": "SEV-2", + "type": "string" + } + }, + "type": "object" }, - { - "id": "00000000-abcd-0006-0000-000000000000", - "type": "incident_integrations" - } - ] - }, - "properties": { - "data": { - "description": "Integration metadata relationship array", - "example": [ - { - "id": "00000000-abcd-0003-0000-000000000000", - "type": "incident_integrations" + "type": "array" + }, + "responder": { + "description": "Facet data for incident responder users.", + "items": { + "description": "Facet data for user attributes of an incident.", + "properties": { + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "email": { + "description": "Email of the user.", + "example": "datadog.user@example.com", + "type": "string" + }, + "handle": { + "description": "Handle of the user.", + "example": "@datadog.user@example.com", + "type": "string" + }, + "name": { + "description": "Name of the user.", + "example": "Datadog User", + "type": "string" + }, + "uuid": { + "description": "ID of the user.", + "example": "773b045d-ccf8-4808-bd3b-955ef6a8c940", + "type": "string" + } }, - { - "id": "00000000-abcd-0004-0000-000000000000", - "type": "incident_integrations" - } - ], + "type": "object" + }, + "type": "array" + }, + "severity": { + "description": "Facet data for incident severity attributes.", "items": { - "description": "A relationship reference for an integration metadata object.", - "example": { - "id": "00000000-abcd-0002-0000-000000000000", - "type": "incident_integrations" + "description": "Facet value and number of occurrences for a property field of an incident.", + "properties": { + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "name": { + "description": "The facet value appearing in search results.", + "example": "SEV-2", + "type": "string" + } }, + "type": "object" + }, + "type": "array" + }, + "state": { + "description": "Facet data for incident state attributes.", + "items": { + "description": "Facet value and number of occurrences for a property field of an incident.", "properties": { - "id": { - "description": "A unique identifier that represents the integration metadata.", - "example": "00000000-abcd-0001-0000-000000000000", + "count": { + "description": "Count of the facet value appearing in search results.", + "example": 5, + "format": "int32", + "maximum": 2147483647, + "type": "integer" + }, + "name": { + "description": "The facet value appearing in search results.", + "example": "SEV-2", "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "time_to_repair": { + "description": "Facet data for incident time to repair metrics.", + "items": { + "description": "Facet data numeric attributes of an incident.", + "properties": { + "aggregates": { + "description": "Aggregate information for numeric incident data.", + "properties": { + "max": { + "description": "Maximum value of the numeric aggregates.", + "example": 1234, + "format": "double", + "nullable": true, + "type": "number" + }, + "min": { + "description": "Minimum value of the numeric aggregates.", + "example": 20, + "format": "double", + "nullable": true, + "type": "number" + } + }, + "type": "object" }, - "type": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", - "enum": [ - "incident_integrations" - ], - "example": "incident_integrations", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" - ] + "name": { + "description": "Name of the incident property field.", + "example": "time_to_repair", + "type": "string" } }, "required": [ - "id", - "type" + "name", + "aggregates" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "responders": { - "description": "Relationship to incident responders.", - "properties": { - "data": { - "description": "An array of incident responders.", + }, + "time_to_resolve": { + "description": "Facet data for incident time to resolve metrics.", "items": { - "description": "Relationship to impact object.", + "description": "Facet data numeric attributes of an incident.", "properties": { - "id": { - "description": "A unique identifier that represents the responder.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + "aggregates": { + "description": "Aggregate information for numeric incident data.", + "properties": { + "max": { + "description": "Maximum value of the numeric aggregates.", + "example": 1234, + "format": "double", + "nullable": true, + "type": "number" + }, + "min": { + "description": "Minimum value of the numeric aggregates.", + "example": 20, + "format": "double", + "nullable": true, + "type": "number" + } + }, + "type": "object" }, - "type": { - "description": "The incident responders type.", - "enum": [ - "incident_responders" - ], - "example": "incident_responders", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_RESPONDERS" - ] + "name": { + "description": "Name of the incident property field.", + "example": "time_to_repair", + "type": "string" } }, "required": [ - "id", - "type" + "name", + "aggregates" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, "type": "array" } }, - "required": [ - "data" - ], "type": "object" }, - "user_defined_fields": { - "description": "Relationship to incident user defined fields.", - "properties": { - "data": { - "description": "An array of user defined fields.", - "items": { - "description": "Relationship to impact object.", + "incidents": { + "description": "Incidents returned by the search.", + "items": { + "description": "Incident returned by the search.", + "properties": { + "data": { + "description": "Incident data from a response.", "properties": { + "attributes": { + "description": "The incident's attributes from a response.", + "properties": { + "archived": { + "description": "Timestamp of when the incident was archived.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "case_id": { + "description": "The incident case id.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "created": { + "description": "Timestamp when the incident was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "customer_impact_duration": { + "description": "Length of the incident's customer impact in seconds.\nEquals the difference between `customer_impact_start` and `customer_impact_end`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "customer_impact_end": { + "description": "Timestamp when customers were no longer impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impact_scope": { + "description": "A summary of the impact customers experienced during the incident.", + "example": "An example customer impact scope", + "nullable": true, + "type": "string" + }, + "customer_impact_start": { + "description": "Timestamp when customers began being impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impacted": { + "description": "A flag indicating whether the incident caused customer impact.", + "example": false, + "type": "boolean" + }, + "detected": { + "description": "Timestamp when the incident was detected.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "fields": { + "additionalProperties": { + "description": "Dynamic fields for which selections can be made, with field names as keys.", + "oneOf": [ + { + "description": "A field with a single value selected.", + "properties": { + "type": { + "default": "dropdown", + "description": "Type of the single value field definitions.", + "enum": [ + "dropdown", + "textbox" + ], + "example": "dropdown", + "type": "string", + "x-enum-varnames": [ + "DROPDOWN", + "TEXTBOX" + ] + }, + "value": { + "description": "The single value selected for this field.", + "example": "SEV-1", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + { + "description": "A field with potentially multiple values selected.", + "properties": { + "type": { + "default": "multiselect", + "description": "Type of the multiple value field definitions.", + "enum": [ + "multiselect", + "textarray", + "metrictag", + "autocomplete" + ], + "example": "multiselect", + "type": "string", + "x-enum-varnames": [ + "MULTISELECT", + "TEXTARRAY", + "METRICTAG", + "AUTOCOMPLETE" + ] + }, + "value": { + "description": "The multiple values selected for this field.", + "example": [ + "1.0", + "1.1" + ], + "items": { + "description": "A value which has been selected for the parent field.", + "example": "1.1", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "description": "A condensed view of the user-defined fields attached to incidents.", + "example": { + "severity": { + "type": "dropdown", + "value": "SEV-5" + } + }, + "type": "object" + }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "modified": { + "description": "Timestamp when the incident was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "non_datadog_creator": { + "description": "Incident's non Datadog creator.", + "nullable": true, + "properties": { + "image_48_px": { + "description": "Non Datadog creator `48px` image.", + "type": "string" + }, + "name": { + "description": "Non Datadog creator name.", + "type": "string" + } + }, + "type": "object" + }, + "notification_handles": { + "description": "Notification handles that will be notified of the incident during update.", + "example": [ + { + "display_name": "Jane Doe", + "handle": "@user@email.com" + }, + { + "display_name": "Slack Channel", + "handle": "@slack-channel" + }, + { + "display_name": "Incident Workflow", + "handle": "@workflow-from-incident" + } + ], + "items": { + "description": "A notification handle that will be notified at incident creation.", + "properties": { + "display_name": { + "description": "The name of the notified handle.", + "example": "Jane Doe", + "type": "string" + }, + "handle": { + "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", + "example": "@test.user@test.com", + "type": "string" + } + }, + "type": "object" + }, + "nullable": true, + "type": "array" + }, + "public_id": { + "description": "The monotonically increasing integer ID for the incident.", + "example": 1, + "format": "int64", + "type": "integer" + }, + "resolved": { + "description": "Timestamp when the incident's state was last changed from active or stable to resolved or completed.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "severity": { + "description": "The incident severity.", + "enum": [ + "UNKNOWN", + "SEV-1", + "SEV-2", + "SEV-3", + "SEV-4", + "SEV-5" + ], + "example": "UNKNOWN", + "type": "string", + "x-enum-varnames": [ + "UNKNOWN", + "SEV_1", + "SEV_2", + "SEV_3", + "SEV_4", + "SEV_5" + ] + }, + "state": { + "description": "The state incident.", + "nullable": true, + "type": "string" + }, + "time_to_detect": { + "description": "The amount of time in seconds to detect the incident.\nEquals the difference between `customer_impact_start` and `detected`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_internal_response": { + "description": "The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_repair": { + "description": "The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_resolve": { + "description": "The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "title": { + "description": "The title of the incident, which summarizes what happened.", + "example": "A test incident title", + "type": "string" + }, + "visibility": { + "description": "The incident visibility status.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "title" + ], + "type": "object" + }, "id": { - "description": "A unique identifier that represents the responder.", - "example": "00000000-0000-0000-2345-000000000000", + "description": "The incident's ID.", + "example": "00000000-0000-0000-1234-000000000000", "type": "string" }, + "relationships": { + "description": "The incident's relationships from a response.", + "properties": { + "attachments": { + "description": "A relationship reference for attachments.", + "properties": { + "data": { + "description": "An array of incident attachments.", + "items": { + "description": "The attachment relationship data.", + "properties": { + "id": { + "description": "A unique identifier that represents the attachment.", + "example": "00000000-0000-abcd-1000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "commander_user": { + "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": "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "impacts": { + "description": "Relationship to impacts.", + "properties": { + "data": { + "description": "An array of incident impacts.", + "items": { + "description": "Relationship to impact object.", + "properties": { + "id": { + "description": "A unique identifier that represents the impact.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "description": "The incident impacts type.", + "enum": [ + "incident_impacts" + ], + "example": "incident_impacts", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_IMPACTS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "integrations": { + "description": "A relationship reference for multiple integration metadata objects.", + "example": { + "data": [ + { + "id": "00000000-abcd-0005-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0006-0000-000000000000", + "type": "incident_integrations" + } + ] + }, + "properties": { + "data": { + "description": "Integration metadata relationship array", + "example": [ + { + "id": "00000000-abcd-0003-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0004-0000-000000000000", + "type": "incident_integrations" + } + ], + "items": { + "description": "A relationship reference for an integration metadata object.", + "example": { + "id": "00000000-abcd-0002-0000-000000000000", + "type": "incident_integrations" + }, + "properties": { + "id": { + "description": "A unique identifier that represents the integration metadata.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_integrations", + "description": "Integration metadata resource type.", + "enum": [ + "incident_integrations" + ], + "example": "incident_integrations", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_INTEGRATIONS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "responders": { + "description": "Relationship to incident responders.", + "properties": { + "data": { + "description": "An array of incident responders.", + "items": { + "description": "Relationship to impact object.", + "properties": { + "id": { + "description": "A unique identifier that represents the responder.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "description": "The incident responders type.", + "enum": [ + "incident_responders" + ], + "example": "incident_responders", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_RESPONDERS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "user_defined_fields": { + "description": "Relationship to incident user defined fields.", + "properties": { + "data": { + "description": "An array of user defined fields.", + "items": { + "description": "Relationship to impact object.", + "properties": { + "id": { + "description": "A unique identifier that represents the responder.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" + }, + "type": { + "description": "The incident user defined fields type.", + "enum": [ + "user_defined_field" + ], + "example": "user_defined_field", + "type": "string", + "x-enum-varnames": [ + "USER_DEFINED_FIELD" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, "type": { - "description": "The incident user defined fields type.", + "default": "incidents", + "description": "Incident resource type.", "enum": [ - "user_defined_field" + "incidents" ], - "example": "user_defined_field", + "example": "incidents", "type": "string", "x-enum-varnames": [ - "USER_DEFINED_FIELD" + "INCIDENTS" ] } }, @@ -223517,1418 +231265,321 @@ "x-merge-override": { "required": false } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "incidents", - "description": "Incident resource type.", - "enum": [ - "incidents" - ], - "example": "incidents", - "type": "string", - "x-enum-varnames": [ - "INCIDENTS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "included": { - "description": "Included related resources that the user requested.", - "items": { - "description": "An object related to an incident that is included in the response.", - "oneOf": [ - { - "description": "User object returned by the API.", - "properties": { - "attributes": { - "description": "Attributes of user object returned by the API.", - "properties": { - "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" - }, - "name": { - "description": "Name of the user.", - "nullable": true, - "type": "string" - }, - "uuid": { - "description": "UUID of the user.", - "type": "string" } }, - "type": "object" - }, - "id": { - "description": "ID of the user.", - "type": "string" - }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" + "required": [ + "data" ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object" - }, - { - "description": "A single incident attachment.", - "example": { - "attributes": { - "attachment": { - "documentUrl": "", - "title": "Postmortem IR-123" - }, - "attachment_type": "postmortem" - }, - "id": "00000000-abcd-0002-0000-000000000000", - "relationships": { - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - } - }, - "type": "incident_attachments" - }, - "properties": { - "attributes": { - "description": "The attributes object for an attachment.", - "oneOf": [ - { - "description": "The attributes object for a postmortem attachment.", - "properties": { - "attachment": { - "description": "The postmortem attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this notebook attachment.", - "example": "https://app.datadoghq.com/notebook/123", - "type": "string" - }, - "title": { - "description": "The title of this postmortem attachment.", - "example": "Postmortem IR-123", - "type": "string" - } - }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" - }, - "attachment_type": { - "default": "postmortem", - "description": "The type of postmortem attachment attributes.", - "enum": [ - "postmortem" - ], - "example": "postmortem", - "type": "string", - "x-enum-varnames": [ - "POSTMORTEM" - ] - } - }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - }, - { - "description": "The attributes object for a link attachment.", - "properties": { - "attachment": { - "description": "The link attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this link attachment.", - "example": "https://www.example.com/webstore-failure-runbook", - "type": "string" - }, - "title": { - "description": "The title of this link attachment.", - "example": "Runbook for webstore service failures", - "type": "string" - } - }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" - }, - "attachment_type": { - "default": "link", - "description": "The type of link attachment attributes.", - "enum": [ - "link" - ], - "example": "link", - "type": "string", - "x-enum-varnames": [ - "LINK" - ] - }, - "modified": { - "description": "Timestamp when the incident attachment link was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - } - }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - } - ] - }, - "id": { - "description": "A unique identifier that represents the incident attachment.", - "example": "00000000-abcd-0001-0000-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident attachment's relationships.", - "properties": { - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, "type": "object" }, - "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", - "enum": [ - "incident_attachments" - ], - "example": "incident_attachments", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" - ] - } - }, - "required": [ - "type", - "attributes", - "id", - "relationships" - ], - "type": "object" - } - ] - }, - "readOnly": true, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "description": "CREATED" - }, - "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": [ - "incident_write" - ] - } - ], - "summary": "Create an incident", - "tags": [ - "Incidents" - ], - "x-codegen-request-body-name": "body", - "x-given": { - "incident": { - "parameters": [ - { - "name": "body", - "value": "{\n \"data\": {\n \"attributes\": {\n \"title\": \"{{ unique }}\",\n \"customer_impacted\": false\n },\n \"type\": \"incidents\"\n }\n}" - } - ], - "step": "there is a valid \"incident\" in the system" - } - }, - "x-menu-order": 1, - "x-permission": { - "operator": "OR", - "permissions": [ - "incident_write" - ] - }, - "x-undo": { - "operationId": "DeleteIncident", - "parameters": [ - { - "name": "incident_id", - "source": "data.id" - } - ], - "type": "unsafe" - }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - } - }, - "/api/v2/incidents/config/types": { - "get": { - "description": "Get all incident types.", - "operationId": "ListIncidentTypes", - "parameters": [ - { - "description": "Include deleted incident types in the response.", - "in": "query", - "name": "include_deleted", - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "Response with a list of incident types.", - "properties": { - "data": { - "description": "An array of incident type objects.", - "items": { - "description": "Incident type response data.", - "properties": { - "attributes": { - "description": "Incident type's attributes.", - "properties": { - "createdAt": { - "description": "Timestamp when the incident type was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "createdBy": { - "description": "A unique identifier that represents the user that created the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Text that describes the incident type.", - "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", - "type": "string" - }, - "is_default": { - "default": false, - "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", - "example": false, - "type": "boolean" - }, - "lastModifiedBy": { - "description": "A unique identifier that represents the user that last modified the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "modifiedAt": { - "description": "Timestamp when the incident type was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the incident type.", - "example": "Security Incident", - "type": "string" - }, - "prefix": { - "description": "The string that will be prepended to the incident title across the Datadog app.", - "example": "IR", - "readOnly": true, - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "id": { - "description": "The incident type's ID.", - "example": "00000000-0000-0000-0000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_types", - "description": "Incident type resource type.", - "enum": [ - "incident_types" - ], - "example": "incident_types", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_TYPES" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "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" - }, - "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": [ - "incident_settings_read", - "incident_read" - ] - } - ], - "summary": "Get a list of incident types", - "tags": [ - "Incidents" - ], - "x-menu-order": 20, - "x-permission": { - "operator": "OR", - "permissions": [ - "incident_settings_read", - "incident_read" - ] - }, - "x-undo": { - "type": "safe" - }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - }, - "post": { - "description": "Create an incident type.", - "operationId": "CreateIncidentType", - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Create request for an incident type.", - "properties": { - "data": { - "description": "Incident type data for a create request.", - "properties": { - "attributes": { - "description": "Incident type's attributes.", - "properties": { - "createdAt": { - "description": "Timestamp when the incident type was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "createdBy": { - "description": "A unique identifier that represents the user that created the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Text that describes the incident type.", - "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", - "type": "string" - }, - "is_default": { - "default": false, - "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", - "example": false, - "type": "boolean" - }, - "lastModifiedBy": { - "description": "A unique identifier that represents the user that last modified the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "modifiedAt": { - "description": "Timestamp when the incident type was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the incident type.", - "example": "Security Incident", - "type": "string" - }, - "prefix": { - "description": "The string that will be prepended to the incident title across the Datadog app.", - "example": "IR", - "readOnly": true, - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "type": { - "default": "incident_types", - "description": "Incident type resource type.", - "enum": [ - "incident_types" - ], - "example": "incident_types", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_TYPES" - ] - } - }, - "required": [ - "type", - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "description": "Incident type payload.", - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "description": "Incident type response data.", - "properties": { - "data": { - "description": "Incident type response data.", - "properties": { - "attributes": { - "description": "Incident type's attributes.", - "properties": { - "createdAt": { - "description": "Timestamp when the incident type was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "createdBy": { - "description": "A unique identifier that represents the user that created the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Text that describes the incident type.", - "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", - "type": "string" - }, - "is_default": { - "default": false, - "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", - "example": false, - "type": "boolean" - }, - "lastModifiedBy": { - "description": "A unique identifier that represents the user that last modified the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "modifiedAt": { - "description": "Timestamp when the incident type was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the incident type.", - "example": "Security Incident", - "type": "string" + "type": "array" }, - "prefix": { - "description": "The string that will be prepended to the incident title across the Datadog app.", - "example": "IR", - "readOnly": true, - "type": "string" + "total": { + "description": "Number of incidents returned by the search.", + "example": 10, + "format": "int32", + "maximum": 2147483647, + "type": "integer" } }, "required": [ - "name" - ], - "type": "object" - }, - "id": { - "description": "The incident type's ID.", - "example": "00000000-0000-0000-0000-000000000000", - "type": "string" + "facets", + "incidents", + "total" + ], + "type": "object" }, "type": { - "default": "incident_types", - "description": "Incident type resource type.", + "default": "incidents_search_results", + "description": "Incident search result type.", "enum": [ - "incident_types" + "incidents_search_results" ], - "example": "incident_types", + "example": "incidents_search_results", "type": "string", "x-enum-varnames": [ - "INCIDENT_TYPES" + "INCIDENTS_SEARCH_RESULTS" ] } }, - "required": [ - "id", - "type" - ], "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "description": "CREATED" - }, - "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": [ - "incident_settings_write" - ] - } - ], - "summary": "Create an incident type", - "tags": [ - "Incidents" - ], - "x-codegen-request-body-name": "body", - "x-given": { - "incident_type": { - "parameters": [ - { - "name": "body", - "value": "{\n \"data\": {\n \"attributes\": {\n \"name\": \"Security Incident\",\n \"description\": \"Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.\",\n \"is_default\": false\n },\n \"type\": \"incident_types\"\n }\n}" - } - ], - "step": "there is a valid \"incident_type\" in the system" - } - }, - "x-menu-order": 19, - "x-permission": { - "operator": "OR", - "permissions": [ - "incident_settings_write" - ] - }, - "x-undo": { - "operationId": "DeleteIncidentType", - "parameters": [ - { - "name": "incident_type_id", - "source": "data.id" - } - ], - "type": "unsafe" - }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - } - }, - "/api/v2/incidents/config/types/{incident_type_id}": { - "delete": { - "description": "Delete an incident type.", - "operationId": "DeleteIncidentType", - "parameters": [ - { - "description": "The UUID of the incident type.", - "in": "path", - "name": "incident_type_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "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" - ], + }, + "included": { + "description": "Included related resources that the user requested.", "items": { - "description": "A list of items.", - "example": "Bad Request", - "type": "string" + "description": "An object related to an incident that is included in the response.", + "oneOf": [ + { + "description": "User object returned by the API.", + "properties": { + "attributes": { + "description": "Attributes of user object returned by the API.", + "properties": { + "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" + }, + "name": { + "description": "Name of the user.", + "nullable": true, + "type": "string" + }, + "uuid": { + "description": "UUID of the user.", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "ID of the user.", + "type": "string" + }, + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } + }, + "type": "object" + }, + { + "description": "A single incident attachment.", + "example": { + "attributes": { + "attachment": { + "documentUrl": "", + "title": "Postmortem IR-123" + }, + "attachment_type": "postmortem" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + }, + "properties": { + "attributes": { + "description": "The attributes object for an attachment.", + "oneOf": [ + { + "description": "The attributes object for a postmortem attachment.", + "properties": { + "attachment": { + "description": "The postmortem attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this notebook attachment.", + "example": "https://app.datadoghq.com/notebook/123", + "type": "string" + }, + "title": { + "description": "The title of this postmortem attachment.", + "example": "Postmortem IR-123", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" + }, + "attachment_type": { + "default": "postmortem", + "description": "The type of postmortem attachment attributes.", + "enum": [ + "postmortem" + ], + "example": "postmortem", + "type": "string", + "x-enum-varnames": [ + "POSTMORTEM" + ] + } + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + }, + { + "description": "The attributes object for a link attachment.", + "properties": { + "attachment": { + "description": "The link attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this link attachment.", + "example": "https://www.example.com/webstore-failure-runbook", + "type": "string" + }, + "title": { + "description": "The title of this link attachment.", + "example": "Runbook for webstore service failures", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" + }, + "attachment_type": { + "default": "link", + "description": "The type of link attachment attributes.", + "enum": [ + "link" + ], + "example": "link", + "type": "string", + "x-enum-varnames": [ + "LINK" + ] + }, + "modified": { + "description": "Timestamp when the incident attachment link was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + } + ] + }, + "id": { + "description": "A unique identifier that represents the incident attachment.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident attachment's relationships.", + "properties": { + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] + } + }, + "required": [ + "type", + "attributes", + "id", + "relationships" + ], + "type": "object" + } + ] }, + "readOnly": true, "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - } - } - }, - "description": "Too many requests" - } - }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "incident_settings_write" - ] - } - ], - "summary": "Delete an incident type", - "tags": [ - "Incidents" - ], - "x-codegen-request-body-name": "body", - "x-menu-order": 23, - "x-permission": { - "operator": "OR", - "permissions": [ - "incident_settings_write" - ] - }, - "x-undo": { - "type": "idempotent" - }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - }, - "get": { - "description": "Get incident type details.", - "operationId": "GetIncidentType", - "parameters": [ - { - "description": "The UUID of the incident type.", - "in": "path", - "name": "incident_type_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "Incident type response data.", - "properties": { - "data": { - "description": "Incident type response data.", + }, + "meta": { + "description": "The metadata object containing pagination metadata.", "properties": { - "attributes": { - "description": "Incident type's attributes.", + "pagination": { + "description": "Pagination properties.", "properties": { - "createdAt": { - "description": "Timestamp when the incident type was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "createdBy": { - "description": "A unique identifier that represents the user that created the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Text that describes the incident type.", - "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", - "type": "string" - }, - "is_default": { - "default": false, - "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", - "example": false, - "type": "boolean" - }, - "lastModifiedBy": { - "description": "A unique identifier that represents the user that last modified the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "modifiedAt": { - "description": "Timestamp when the incident type was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" + "next_offset": { + "description": "The index of the first element in the next page of results. Equal to page size added to the current offset.", + "example": 1000, + "format": "int64", + "type": "integer" }, - "name": { - "description": "The name of the incident type.", - "example": "Security Incident", - "type": "string" + "offset": { + "description": "The index of the first element in the results.", + "example": 10, + "format": "int64", + "type": "integer" }, - "prefix": { - "description": "The string that will be prepended to the incident title across the Datadog app.", - "example": "IR", - "readOnly": true, - "type": "string" + "size": { + "description": "Maximum size of pages to return.", + "example": 1000, + "format": "int64", + "type": "integer" } }, - "required": [ - "name" - ], "type": "object" - }, - "id": { - "description": "The incident type's ID.", - "example": "00000000-0000-0000-0000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_types", - "description": "Incident type resource type.", - "enum": [ - "incident_types" - ], - "example": "incident_types", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_TYPES" - ] } }, - "required": [ - "id", - "type" - ], + "readOnly": true, "type": "object" } }, @@ -225037,287 +231688,101 @@ "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": [ - "incident_settings_read", - "incident_read" - ] - } - ], - "summary": "Get incident type details", - "tags": [ - "Incidents" - ], - "x-menu-order": 21, - "x-permission": { - "operator": "OR", - "permissions": [ - "incident_settings_read", - "incident_read" - ] - }, - "x-undo": { - "type": "safe" - }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - }, - "patch": { - "description": "Update an incident type.", - "operationId": "UpdateIncidentType", - "parameters": [ - { - "description": "The UUID of the incident type.", - "in": "path", - "name": "incident_type_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Patch request for an incident type.", - "properties": { - "data": { - "description": "Incident type data for a patch request.", - "properties": { - "attributes": { - "description": "Incident type's attributes for updates.", - "properties": { - "createdAt": { - "description": "Timestamp when the incident type was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "createdBy": { - "description": "A unique identifier that represents the user that created the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Text that describes the incident type.", - "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", - "type": "string" - }, - "is_default": { - "description": "When true, this incident type will be used as the default type when an incident type is not specified.", - "example": false, - "type": "boolean" - }, - "lastModifiedBy": { - "description": "A unique identifier that represents the user that last modified the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "modifiedAt": { - "description": "Timestamp when the incident type was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the incident type.", - "example": "Security Incident", - "type": "string" - }, - "prefix": { - "description": "The string that will be prepended to the incident title across the Datadog app.", - "example": "IR", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "The incident type's ID.", - "example": "00000000-0000-0000-0000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_types", - "description": "Incident type resource type.", - "enum": [ - "incident_types" - ], - "example": "incident_types", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_TYPES" - ] - } - }, - "required": [ - "id", - "type", - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "description": "Incident type payload.", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "Incident type response data.", - "properties": { - "data": { - "description": "Incident type response data.", - "properties": { - "attributes": { - "description": "Incident type's attributes.", - "properties": { - "createdAt": { - "description": "Timestamp when the incident type was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "createdBy": { - "description": "A unique identifier that represents the user that created the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Text that describes the incident type.", - "example": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", - "type": "string" - }, - "is_default": { - "default": false, - "description": "If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources.", - "example": false, - "type": "boolean" - }, - "lastModifiedBy": { - "description": "A unique identifier that represents the user that last modified the incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "readOnly": true, - "type": "string" - }, - "modifiedAt": { - "description": "Timestamp when the incident type was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the incident type.", - "example": "Security Incident", - "type": "string" - }, - "prefix": { - "description": "The string that will be prepended to the incident title across the Datadog app.", - "example": "IR", - "readOnly": true, - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "id": { - "description": "The incident type's ID.", - "example": "00000000-0000-0000-0000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_types", - "description": "Incident type resource type.", - "enum": [ - "incident_types" - ], - "example": "incident_types", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_TYPES" - ] - } + "description": "A list of items.", + "example": "Bad Request", + "type": "string" }, - "required": [ - "id", - "type" + "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" ], - "type": "object" + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" } }, "required": [ - "data" + "errors" ], "type": "object" } } }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_read" + ] + } + ], + "summary": "Search for incidents", + "tags": [ + "Incidents" + ], + "x-menu-order": 6, + "x-pagination": { + "limitParam": "page[size]", + "pageOffsetParam": "page[offset]", + "resultsPath": "data.attributes.incidents" + }, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_read" + ] + }, + "x-undo": { + "type": "safe" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + } + }, + "/api/v2/incidents/{incident_id}": { + "delete": { + "description": "Deletes an existing incident from the users organization.", + "operationId": "DeleteIncident", + "parameters": [ + { + "description": "The UUID of the incident.", + "in": "path", + "name": "incident_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { "description": "OK" }, "400": { @@ -225468,102 +231933,59 @@ }, { "AuthZ": [ - "incident_settings_write" + "incident_write" ] } ], - "summary": "Update an incident type", + "summary": "Delete an existing incident", "tags": [ "Incidents" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 22, + "x-menu-order": 4, "x-permission": { "operator": "OR", "permissions": [ - "incident_settings_write" + "incident_write" ] }, "x-undo": { "type": "idempotent" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - } - }, - "/api/v2/incidents/search": { + }, "get": { - "description": "Search for incidents matching a certain query.", - "operationId": "SearchIncidents", + "description": "Get the details of an incident by `incident_id`.", + "operationId": "GetIncident", "parameters": [ { - "description": "Specifies which types of related objects should be included in the response.", - "in": "query", - "name": "include", - "required": false, - "schema": { - "description": "Object related to an incident.", - "enum": [ - "users", - "attachments" - ], - "type": "string", - "x-enum-varnames": [ - "USERS", - "ATTACHMENTS" - ] - } - }, - { - "description": "Specifies which incidents should be returned. The query can contain any number of incident facets\njoined by `ANDs`, along with multiple values for each of those facets joined by `OR`s. For\nexample: `state:active AND severity:(SEV-2 OR SEV-1)`.", - "explode": false, - "in": "query", - "name": "query", + "description": "The UUID of the incident.", + "in": "path", + "name": "incident_id", "required": true, "schema": { "type": "string" } }, { - "description": "Specifies the order of returned incidents.", + "description": "Specifies which types of related objects should be included in the response.", "explode": false, "in": "query", - "name": "sort", - "required": false, - "schema": { - "description": "The ways searched incidents can be sorted.", - "enum": [ - "created", - "-created" - ], - "type": "string", - "x-enum-varnames": [ - "CREATED_ASCENDING", - "CREATED_DESCENDING" - ] - } - }, - { - "description": "Size for a given page. The maximum allowed value is 100.", - "in": "query", - "name": "page[size]", - "required": false, - "schema": { - "default": 10, - "example": 10, - "format": "int64", - "type": "integer" - } - }, - { - "description": "Specific offset to use as the beginning of the returned page.", - "in": "query", - "name": "page[offset]", + "name": "include", "required": false, "schema": { - "default": 0, - "example": 0, - "format": "int64", - "type": "integer" + "items": { + "description": "Object related to an incident.", + "enum": [ + "users", + "attachments" + ], + "type": "string", + "x-enum-varnames": [ + "USERS", + "ATTACHMENTS" + ] + }, + "type": "array" } } ], @@ -225572,1056 +231994,631 @@ "content": { "application/json": { "schema": { - "description": "Response with incidents and facets.", + "description": "Response with an incident.", "properties": { "data": { - "description": "Data returned by an incident search.", + "description": "Incident data from a response.", "properties": { "attributes": { - "description": "Attributes returned by an incident search.", + "description": "The incident's attributes from a response.", "properties": { - "facets": { - "description": "Facet data for incidents returned by a search query.", - "properties": { - "commander": { - "description": "Facet data for incident commander users.", - "items": { - "description": "Facet data for user attributes of an incident.", - "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "email": { - "description": "Email of the user.", - "example": "datadog.user@example.com", - "type": "string" - }, - "handle": { - "description": "Handle of the user.", - "example": "@datadog.user@example.com", - "type": "string" - }, - "name": { - "description": "Name of the user.", - "example": "Datadog User", - "type": "string" - }, - "uuid": { - "description": "ID of the user.", - "example": "773b045d-ccf8-4808-bd3b-955ef6a8c940", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "created_by": { - "description": "Facet data for incident creator users.", - "items": { - "description": "Facet data for user attributes of an incident.", + "archived": { + "description": "Timestamp of when the incident was archived.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "case_id": { + "description": "The incident case id.", + "format": "int64", + "nullable": true, + "type": "integer" + }, + "created": { + "description": "Timestamp when the incident was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "customer_impact_duration": { + "description": "Length of the incident's customer impact in seconds.\nEquals the difference between `customer_impact_start` and `customer_impact_end`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "customer_impact_end": { + "description": "Timestamp when customers were no longer impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impact_scope": { + "description": "A summary of the impact customers experienced during the incident.", + "example": "An example customer impact scope", + "nullable": true, + "type": "string" + }, + "customer_impact_start": { + "description": "Timestamp when customers began being impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impacted": { + "description": "A flag indicating whether the incident caused customer impact.", + "example": false, + "type": "boolean" + }, + "detected": { + "description": "Timestamp when the incident was detected.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "fields": { + "additionalProperties": { + "description": "Dynamic fields for which selections can be made, with field names as keys.", + "oneOf": [ + { + "description": "A field with a single value selected.", "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "email": { - "description": "Email of the user.", - "example": "datadog.user@example.com", - "type": "string" - }, - "handle": { - "description": "Handle of the user.", - "example": "@datadog.user@example.com", - "type": "string" - }, - "name": { - "description": "Name of the user.", - "example": "Datadog User", - "type": "string" + "type": { + "default": "dropdown", + "description": "Type of the single value field definitions.", + "enum": [ + "dropdown", + "textbox" + ], + "example": "dropdown", + "type": "string", + "x-enum-varnames": [ + "DROPDOWN", + "TEXTBOX" + ] }, - "uuid": { - "description": "ID of the user.", - "example": "773b045d-ccf8-4808-bd3b-955ef6a8c940", + "value": { + "description": "The single value selected for this field.", + "example": "SEV-1", + "nullable": true, "type": "string" } }, "type": "object" }, - "type": "array" - }, - "fields": { - "description": "Facet data for incident property fields.", - "items": { - "description": "Facet data for the incident property fields.", + { + "description": "A field with potentially multiple values selected.", "properties": { - "aggregates": { - "description": "Aggregate information for numeric incident data.", - "properties": { - "max": { - "description": "Maximum value of the numeric aggregates.", - "example": 1234, - "format": "double", - "nullable": true, - "type": "number" - }, - "min": { - "description": "Minimum value of the numeric aggregates.", - "example": 20, - "format": "double", - "nullable": true, - "type": "number" - } - }, - "type": "object" + "type": { + "default": "multiselect", + "description": "Type of the multiple value field definitions.", + "enum": [ + "multiselect", + "textarray", + "metrictag", + "autocomplete" + ], + "example": "multiselect", + "type": "string", + "x-enum-varnames": [ + "MULTISELECT", + "TEXTARRAY", + "METRICTAG", + "AUTOCOMPLETE" + ] }, - "facets": { - "description": "Facet data for the property field of an incident.", + "value": { + "description": "The multiple values selected for this field.", + "example": [ + "1.0", + "1.1" + ], "items": { - "description": "Facet value and number of occurrences for a property field of an incident.", - "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "name": { - "description": "The facet value appearing in search results.", - "example": "SEV-2", - "type": "string" - } - }, - "type": "object" + "description": "A value which has been selected for the parent field.", + "example": "1.1", + "type": "string" }, + "nullable": true, "type": "array" - }, - "name": { - "description": "Name of the incident property field.", - "example": "Severity", - "type": "string" } }, - "required": [ - "facets", - "name" - ], "type": "object" - }, - "type": "array" + } + ] + }, + "description": "A condensed view of the user-defined fields attached to incidents.", + "example": { + "severity": { + "type": "dropdown", + "value": "SEV-5" + } + }, + "type": "object" + }, + "incident_type_uuid": { + "description": "A unique identifier that represents an incident type.", + "example": "00000000-0000-0000-0000-000000000000", + "type": "string" + }, + "modified": { + "description": "Timestamp when the incident was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "non_datadog_creator": { + "description": "Incident's non Datadog creator.", + "nullable": true, + "properties": { + "image_48_px": { + "description": "Non Datadog creator `48px` image.", + "type": "string" }, - "impact": { - "description": "Facet data for incident impact attributes.", - "items": { - "description": "Facet value and number of occurrences for a property field of an incident.", - "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "name": { - "description": "The facet value appearing in search results.", - "example": "SEV-2", - "type": "string" - } - }, - "type": "object" + "name": { + "description": "Non Datadog creator name.", + "type": "string" + } + }, + "type": "object" + }, + "notification_handles": { + "description": "Notification handles that will be notified of the incident during update.", + "example": [ + { + "display_name": "Jane Doe", + "handle": "@user@email.com" + }, + { + "display_name": "Slack Channel", + "handle": "@slack-channel" + }, + { + "display_name": "Incident Workflow", + "handle": "@workflow-from-incident" + } + ], + "items": { + "description": "A notification handle that will be notified at incident creation.", + "properties": { + "display_name": { + "description": "The name of the notified handle.", + "example": "Jane Doe", + "type": "string" }, - "type": "array" + "handle": { + "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", + "example": "@test.user@test.com", + "type": "string" + } }, - "last_modified_by": { - "description": "Facet data for incident last modified by users.", + "type": "object" + }, + "nullable": true, + "type": "array" + }, + "public_id": { + "description": "The monotonically increasing integer ID for the incident.", + "example": 1, + "format": "int64", + "type": "integer" + }, + "resolved": { + "description": "Timestamp when the incident's state was last changed from active or stable to resolved or completed.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "severity": { + "description": "The incident severity.", + "enum": [ + "UNKNOWN", + "SEV-1", + "SEV-2", + "SEV-3", + "SEV-4", + "SEV-5" + ], + "example": "UNKNOWN", + "type": "string", + "x-enum-varnames": [ + "UNKNOWN", + "SEV_1", + "SEV_2", + "SEV_3", + "SEV_4", + "SEV_5" + ] + }, + "state": { + "description": "The state incident.", + "nullable": true, + "type": "string" + }, + "time_to_detect": { + "description": "The amount of time in seconds to detect the incident.\nEquals the difference between `customer_impact_start` and `detected`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_internal_response": { + "description": "The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_repair": { + "description": "The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "time_to_resolve": { + "description": "The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`.", + "format": "int64", + "readOnly": true, + "type": "integer" + }, + "title": { + "description": "The title of the incident, which summarizes what happened.", + "example": "A test incident title", + "type": "string" + }, + "visibility": { + "description": "The incident visibility status.", + "nullable": true, + "type": "string" + } + }, + "required": [ + "title" + ], + "type": "object" + }, + "id": { + "description": "The incident's ID.", + "example": "00000000-0000-0000-1234-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident's relationships from a response.", + "properties": { + "attachments": { + "description": "A relationship reference for attachments.", + "properties": { + "data": { + "description": "An array of incident attachments.", "items": { - "description": "Facet data for user attributes of an incident.", + "description": "The attachment relationship data.", "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "email": { - "description": "Email of the user.", - "example": "datadog.user@example.com", - "type": "string" - }, - "handle": { - "description": "Handle of the user.", - "example": "@datadog.user@example.com", - "type": "string" - }, - "name": { - "description": "Name of the user.", - "example": "Datadog User", + "id": { + "description": "A unique identifier that represents the attachment.", + "example": "00000000-0000-abcd-1000-000000000000", "type": "string" }, - "uuid": { - "description": "ID of the user.", - "example": "773b045d-ccf8-4808-bd3b-955ef6a8c940", - "type": "string" + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] } }, - "type": "object" + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } }, "type": "array" - }, - "postmortem": { - "description": "Facet data for incident postmortem existence.", - "items": { - "description": "Facet value and number of occurrences for a property field of an incident.", - "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "name": { - "description": "The facet value appearing in search results.", - "example": "SEV-2", - "type": "string" - } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "commander_user": { + "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": "object" + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } }, - "type": "array" - }, - "responder": { - "description": "Facet data for incident responder users.", - "items": { - "description": "Facet data for user attributes of an incident.", - "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "email": { - "description": "Email of the user.", - "example": "datadog.user@example.com", - "type": "string" - }, - "handle": { - "description": "Handle of the user.", - "example": "@datadog.user@example.com", - "type": "string" - }, - "name": { - "description": "Name of the user.", - "example": "Datadog User", - "type": "string" - }, - "uuid": { - "description": "ID of the user.", - "example": "773b045d-ccf8-4808-bd3b-955ef6a8c940", - "type": "string" - } + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" }, - "type": "object" + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } }, - "type": "array" - }, - "severity": { - "description": "Facet data for incident severity attributes.", + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "impacts": { + "description": "Relationship to impacts.", + "properties": { + "data": { + "description": "An array of incident impacts.", "items": { - "description": "Facet value and number of occurrences for a property field of an incident.", + "description": "Relationship to impact object.", "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" - }, - "name": { - "description": "The facet value appearing in search results.", - "example": "SEV-2", + "id": { + "description": "A unique identifier that represents the impact.", + "example": "00000000-0000-0000-2345-000000000000", "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "state": { - "description": "Facet data for incident state attributes.", - "items": { - "description": "Facet value and number of occurrences for a property field of an incident.", - "properties": { - "count": { - "description": "Count of the facet value appearing in search results.", - "example": 5, - "format": "int32", - "maximum": 2147483647, - "type": "integer" }, - "name": { - "description": "The facet value appearing in search results.", - "example": "SEV-2", - "type": "string" + "type": { + "description": "The incident impacts type.", + "enum": [ + "incident_impacts" + ], + "example": "incident_impacts", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_IMPACTS" + ] } }, - "type": "object" + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } }, "type": "array" - }, - "time_to_repair": { - "description": "Facet data for incident time to repair metrics.", + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "integrations": { + "description": "A relationship reference for multiple integration metadata objects.", + "example": { + "data": [ + { + "id": "00000000-abcd-0005-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0006-0000-000000000000", + "type": "incident_integrations" + } + ] + }, + "properties": { + "data": { + "description": "Integration metadata relationship array", + "example": [ + { + "id": "00000000-abcd-0003-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0004-0000-000000000000", + "type": "incident_integrations" + } + ], "items": { - "description": "Facet data numeric attributes of an incident.", + "description": "A relationship reference for an integration metadata object.", + "example": { + "id": "00000000-abcd-0002-0000-000000000000", + "type": "incident_integrations" + }, "properties": { - "aggregates": { - "description": "Aggregate information for numeric incident data.", - "properties": { - "max": { - "description": "Maximum value of the numeric aggregates.", - "example": 1234, - "format": "double", - "nullable": true, - "type": "number" - }, - "min": { - "description": "Minimum value of the numeric aggregates.", - "example": 20, - "format": "double", - "nullable": true, - "type": "number" - } - }, - "type": "object" - }, - "name": { - "description": "Name of the incident property field.", - "example": "time_to_repair", + "id": { + "description": "A unique identifier that represents the integration metadata.", + "example": "00000000-abcd-0001-0000-000000000000", "type": "string" + }, + "type": { + "default": "incident_integrations", + "description": "Integration metadata resource type.", + "enum": [ + "incident_integrations" + ], + "example": "incident_integrations", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_INTEGRATIONS" + ] } }, "required": [ - "name", - "aggregates" + "id", + "type" ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } }, "type": "array" - }, - "time_to_resolve": { - "description": "Facet data for incident time to resolve metrics.", + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "responders": { + "description": "Relationship to incident responders.", + "properties": { + "data": { + "description": "An array of incident responders.", "items": { - "description": "Facet data numeric attributes of an incident.", + "description": "Relationship to impact object.", "properties": { - "aggregates": { - "description": "Aggregate information for numeric incident data.", - "properties": { - "max": { - "description": "Maximum value of the numeric aggregates.", - "example": 1234, - "format": "double", - "nullable": true, - "type": "number" - }, - "min": { - "description": "Minimum value of the numeric aggregates.", - "example": 20, - "format": "double", - "nullable": true, - "type": "number" - } - }, - "type": "object" - }, - "name": { - "description": "Name of the incident property field.", - "example": "time_to_repair", + "id": { + "description": "A unique identifier that represents the responder.", + "example": "00000000-0000-0000-2345-000000000000", "type": "string" + }, + "type": { + "description": "The incident responders type.", + "enum": [ + "incident_responders" + ], + "example": "incident_responders", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_RESPONDERS" + ] } }, "required": [ - "name", - "aggregates" + "id", + "type" ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } }, "type": "array" } }, + "required": [ + "data" + ], "type": "object" }, - "incidents": { - "description": "Incidents returned by the search.", - "items": { - "description": "Incident returned by the search.", - "properties": { - "data": { - "description": "Incident data from a response.", + "user_defined_fields": { + "description": "Relationship to incident user defined fields.", + "properties": { + "data": { + "description": "An array of user defined fields.", + "items": { + "description": "Relationship to impact object.", "properties": { - "attributes": { - "description": "The incident's attributes from a response.", - "properties": { - "archived": { - "description": "Timestamp of when the incident was archived.", - "format": "date-time", - "nullable": true, - "readOnly": true, - "type": "string" - }, - "case_id": { - "description": "The incident case id.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "created": { - "description": "Timestamp when the incident was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "customer_impact_duration": { - "description": "Length of the incident's customer impact in seconds.\nEquals the difference between `customer_impact_start` and `customer_impact_end`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "customer_impact_end": { - "description": "Timestamp when customers were no longer impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impact_scope": { - "description": "A summary of the impact customers experienced during the incident.", - "example": "An example customer impact scope", - "nullable": true, - "type": "string" - }, - "customer_impact_start": { - "description": "Timestamp when customers began being impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impacted": { - "description": "A flag indicating whether the incident caused customer impact.", - "example": false, - "type": "boolean" - }, - "detected": { - "description": "Timestamp when the incident was detected.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "fields": { - "additionalProperties": { - "description": "Dynamic fields for which selections can be made, with field names as keys.", - "oneOf": [ - { - "description": "A field with a single value selected.", - "properties": { - "type": { - "default": "dropdown", - "description": "Type of the single value field definitions.", - "enum": [ - "dropdown", - "textbox" - ], - "example": "dropdown", - "type": "string", - "x-enum-varnames": [ - "DROPDOWN", - "TEXTBOX" - ] - }, - "value": { - "description": "The single value selected for this field.", - "example": "SEV-1", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - { - "description": "A field with potentially multiple values selected.", - "properties": { - "type": { - "default": "multiselect", - "description": "Type of the multiple value field definitions.", - "enum": [ - "multiselect", - "textarray", - "metrictag", - "autocomplete" - ], - "example": "multiselect", - "type": "string", - "x-enum-varnames": [ - "MULTISELECT", - "TEXTARRAY", - "METRICTAG", - "AUTOCOMPLETE" - ] - }, - "value": { - "description": "The multiple values selected for this field.", - "example": [ - "1.0", - "1.1" - ], - "items": { - "description": "A value which has been selected for the parent field.", - "example": "1.1", - "type": "string" - }, - "nullable": true, - "type": "array" - } - }, - "type": "object" - } - ] - }, - "description": "A condensed view of the user-defined fields attached to incidents.", - "example": { - "severity": { - "type": "dropdown", - "value": "SEV-5" - } - }, - "type": "object" - }, - "incident_type_uuid": { - "description": "A unique identifier that represents an incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "type": "string" - }, - "modified": { - "description": "Timestamp when the incident was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "non_datadog_creator": { - "description": "Incident's non Datadog creator.", - "nullable": true, - "properties": { - "image_48_px": { - "description": "Non Datadog creator `48px` image.", - "type": "string" - }, - "name": { - "description": "Non Datadog creator name.", - "type": "string" - } - }, - "type": "object" - }, - "notification_handles": { - "description": "Notification handles that will be notified of the incident during update.", - "example": [ - { - "display_name": "Jane Doe", - "handle": "@user@email.com" - }, - { - "display_name": "Slack Channel", - "handle": "@slack-channel" - }, - { - "display_name": "Incident Workflow", - "handle": "@workflow-from-incident" - } - ], - "items": { - "description": "A notification handle that will be notified at incident creation.", - "properties": { - "display_name": { - "description": "The name of the notified handle.", - "example": "Jane Doe", - "type": "string" - }, - "handle": { - "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", - "example": "@test.user@test.com", - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "public_id": { - "description": "The monotonically increasing integer ID for the incident.", - "example": 1, - "format": "int64", - "type": "integer" - }, - "resolved": { - "description": "Timestamp when the incident's state was last changed from active or stable to resolved or completed.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "severity": { - "description": "The incident severity.", - "enum": [ - "UNKNOWN", - "SEV-1", - "SEV-2", - "SEV-3", - "SEV-4", - "SEV-5" - ], - "example": "UNKNOWN", - "type": "string", - "x-enum-varnames": [ - "UNKNOWN", - "SEV_1", - "SEV_2", - "SEV_3", - "SEV_4", - "SEV_5" - ] - }, - "state": { - "description": "The state incident.", - "nullable": true, - "type": "string" - }, - "time_to_detect": { - "description": "The amount of time in seconds to detect the incident.\nEquals the difference between `customer_impact_start` and `detected`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_internal_response": { - "description": "The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_repair": { - "description": "The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_resolve": { - "description": "The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "title": { - "description": "The title of the incident, which summarizes what happened.", - "example": "A test incident title", - "type": "string" - }, - "visibility": { - "description": "The incident visibility status.", - "nullable": true, - "type": "string" - } - }, - "required": [ - "title" - ], - "type": "object" - }, "id": { - "description": "The incident's ID.", - "example": "00000000-0000-0000-1234-000000000000", + "description": "A unique identifier that represents the responder.", + "example": "00000000-0000-0000-2345-000000000000", "type": "string" }, - "relationships": { - "description": "The incident's relationships from a response.", - "properties": { - "attachments": { - "description": "A relationship reference for attachments.", - "properties": { - "data": { - "description": "An array of incident attachments.", - "items": { - "description": "The attachment relationship data.", - "properties": { - "id": { - "description": "A unique identifier that represents the attachment.", - "example": "00000000-0000-abcd-1000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", - "enum": [ - "incident_attachments" - ], - "example": "incident_attachments", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "commander_user": { - "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": "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "created_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "impacts": { - "description": "Relationship to impacts.", - "properties": { - "data": { - "description": "An array of incident impacts.", - "items": { - "description": "Relationship to impact object.", - "properties": { - "id": { - "description": "A unique identifier that represents the impact.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "description": "The incident impacts type.", - "enum": [ - "incident_impacts" - ], - "example": "incident_impacts", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_IMPACTS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "integrations": { - "description": "A relationship reference for multiple integration metadata objects.", - "example": { - "data": [ - { - "id": "00000000-abcd-0005-0000-000000000000", - "type": "incident_integrations" - }, - { - "id": "00000000-abcd-0006-0000-000000000000", - "type": "incident_integrations" - } - ] - }, - "properties": { - "data": { - "description": "Integration metadata relationship array", - "example": [ - { - "id": "00000000-abcd-0003-0000-000000000000", - "type": "incident_integrations" - }, - { - "id": "00000000-abcd-0004-0000-000000000000", - "type": "incident_integrations" - } - ], - "items": { - "description": "A relationship reference for an integration metadata object.", - "example": { - "id": "00000000-abcd-0002-0000-000000000000", - "type": "incident_integrations" - }, - "properties": { - "id": { - "description": "A unique identifier that represents the integration metadata.", - "example": "00000000-abcd-0001-0000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", - "enum": [ - "incident_integrations" - ], - "example": "incident_integrations", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "responders": { - "description": "Relationship to incident responders.", - "properties": { - "data": { - "description": "An array of incident responders.", - "items": { - "description": "Relationship to impact object.", - "properties": { - "id": { - "description": "A unique identifier that represents the responder.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "description": "The incident responders type.", - "enum": [ - "incident_responders" - ], - "example": "incident_responders", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_RESPONDERS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "user_defined_fields": { - "description": "Relationship to incident user defined fields.", - "properties": { - "data": { - "description": "An array of user defined fields.", - "items": { - "description": "Relationship to impact object.", - "properties": { - "id": { - "description": "A unique identifier that represents the responder.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "description": "The incident user defined fields type.", - "enum": [ - "user_defined_field" - ], - "example": "user_defined_field", - "type": "string", - "x-enum-varnames": [ - "USER_DEFINED_FIELD" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, "type": { - "default": "incidents", - "description": "Incident resource type.", + "description": "The incident user defined fields type.", "enum": [ - "incidents" + "user_defined_field" ], - "example": "incidents", + "example": "user_defined_field", "type": "string", "x-enum-varnames": [ - "INCIDENTS" + "USER_DEFINED_FIELD" ] } }, @@ -226633,44 +232630,39 @@ "x-merge-override": { "required": false } - } - }, - "required": [ - "data" - ], - "type": "object" + }, + "type": "array" + } }, - "type": "array" - }, - "total": { - "description": "Number of incidents returned by the search.", - "example": 10, - "format": "int32", - "maximum": 2147483647, - "type": "integer" + "required": [ + "data" + ], + "type": "object" } }, - "required": [ - "facets", - "incidents", - "total" - ], "type": "object" }, "type": { - "default": "incidents_search_results", - "description": "Incident search result type.", + "default": "incidents", + "description": "Incident resource type.", "enum": [ - "incidents_search_results" + "incidents" ], - "example": "incidents_search_results", + "example": "incidents", "type": "string", "x-enum-varnames": [ - "INCIDENTS_SEARCH_RESULTS" + "INCIDENTS" ] } }, - "type": "object" + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } }, "included": { "description": "Included related resources that the user requested.", @@ -226918,37 +232910,6 @@ }, "readOnly": true, "type": "array" - }, - "meta": { - "description": "The metadata object containing pagination metadata.", - "properties": { - "pagination": { - "description": "Pagination properties.", - "properties": { - "next_offset": { - "description": "The index of the first element in the next page of results. Equal to page size added to the current offset.", - "example": 1000, - "format": "int64", - "type": "integer" - }, - "offset": { - "description": "The index of the first element in the results.", - "example": 10, - "format": "int64", - "type": "integer" - }, - "size": { - "description": "Maximum size of pages to return.", - "example": 1000, - "format": "int64", - "type": "integer" - } - }, - "type": "object" - } - }, - "readOnly": true, - "type": "object" } }, "required": [ @@ -227112,16 +233073,11 @@ ] } ], - "summary": "Search for incidents", + "summary": "Get the details of an incident", "tags": [ "Incidents" ], - "x-menu-order": 6, - "x-pagination": { - "limitParam": "page[size]", - "pageOffsetParam": "page[offset]", - "resultsPath": "data.attributes.incidents" - }, + "x-menu-order": 2, "x-permission": { "operator": "OR", "permissions": [ @@ -227132,12 +233088,10 @@ "type": "safe" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - } - }, - "/api/v2/incidents/{incident_id}": { - "delete": { - "description": "Deletes an existing incident from the users organization.", - "operationId": "DeleteIncident", + }, + "patch": { + "description": "Updates an incident. Provide only the attributes that should be updated as this request is a partial update.", + "operationId": "UpdateIncident", "parameters": [ { "description": "The UUID of the incident.", @@ -227147,216 +233101,388 @@ "schema": { "type": "string" } + }, + { + "description": "Specifies which types of related objects should be included in the response.", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "description": "Object related to an incident.", + "enum": [ + "users", + "attachments" + ], + "type": "string", + "x-enum-varnames": [ + "USERS", + "ATTACHMENTS" + ] + }, + "type": "array" + } } ], - "responses": { - "204": { - "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" + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Update request for an incident.", + "properties": { + "data": { + "description": "Incident data for an update request.", + "properties": { + "attributes": { + "description": "The incident's attributes for an update request.", + "properties": { + "customer_impact_end": { + "description": "Timestamp when customers were no longer impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impact_scope": { + "description": "A summary of the impact customers experienced during the incident.", + "example": "Example customer impact scope", + "type": "string" + }, + "customer_impact_start": { + "description": "Timestamp when customers began being impacted by the incident.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "customer_impacted": { + "description": "A flag indicating whether the incident caused customer impact.", + "example": false, + "type": "boolean" + }, + "detected": { + "description": "Timestamp when the incident was detected.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "fields": { + "additionalProperties": { + "description": "Dynamic fields for which selections can be made, with field names as keys.", + "oneOf": [ + { + "description": "A field with a single value selected.", + "properties": { + "type": { + "default": "dropdown", + "description": "Type of the single value field definitions.", + "enum": [ + "dropdown", + "textbox" + ], + "example": "dropdown", + "type": "string", + "x-enum-varnames": [ + "DROPDOWN", + "TEXTBOX" + ] + }, + "value": { + "description": "The single value selected for this field.", + "example": "SEV-1", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + { + "description": "A field with potentially multiple values selected.", + "properties": { + "type": { + "default": "multiselect", + "description": "Type of the multiple value field definitions.", + "enum": [ + "multiselect", + "textarray", + "metrictag", + "autocomplete" + ], + "example": "multiselect", + "type": "string", + "x-enum-varnames": [ + "MULTISELECT", + "TEXTARRAY", + "METRICTAG", + "AUTOCOMPLETE" + ] + }, + "value": { + "description": "The multiple values selected for this field.", + "example": [ + "1.0", + "1.1" + ], + "items": { + "description": "A value which has been selected for the parent field.", + "example": "1.1", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "description": "A condensed view of the user-defined fields for which to update selections.", + "example": { + "severity": { + "type": "dropdown", + "value": "SEV-5" + } + }, + "type": "object" + }, + "notification_handles": { + "description": "Notification handles that will be notified of the incident during update.", + "example": [ + { + "display_name": "Jane Doe", + "handle": "@user@email.com" + }, + { + "display_name": "Slack Channel", + "handle": "@slack-channel" + }, + { + "display_name": "Incident Workflow", + "handle": "@workflow-from-incident" + } + ], + "items": { + "description": "A notification handle that will be notified at incident creation.", + "properties": { + "display_name": { + "description": "The name of the notified handle.", + "example": "Jane Doe", + "type": "string" + }, + "handle": { + "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", + "example": "@test.user@test.com", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "title": { + "description": "The title of the incident, which summarizes what happened.", + "example": "A test incident title", + "type": "string" + } + }, + "type": "object" }, - "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", + "id": { + "description": "The incident's ID.", + "example": "00000000-0000-0000-4567-000000000000", "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" + "relationships": { + "description": "The incident's relationships for an update request.", + "properties": { + "commander_user": { + "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": "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "integrations": { + "description": "A relationship reference for multiple integration metadata objects.", + "example": { + "data": [ + { + "id": "00000000-abcd-0005-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0006-0000-000000000000", + "type": "incident_integrations" + } + ] + }, + "properties": { + "data": { + "description": "Integration metadata relationship array", + "example": [ + { + "id": "00000000-abcd-0003-0000-000000000000", + "type": "incident_integrations" + }, + { + "id": "00000000-abcd-0004-0000-000000000000", + "type": "incident_integrations" + } + ], + "items": { + "description": "A relationship reference for an integration metadata object.", + "example": { + "id": "00000000-abcd-0002-0000-000000000000", + "type": "incident_integrations" + }, + "properties": { + "id": { + "description": "A unique identifier that represents the integration metadata.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_integrations", + "description": "Integration metadata resource type.", + "enum": [ + "incident_integrations" + ], + "example": "incident_integrations", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_INTEGRATIONS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "postmortem": { + "description": "A relationship reference for postmortems.", + "example": { + "data": { + "id": "00000000-0000-abcd-3000-000000000000", + "type": "incident_postmortems" + } + }, + "properties": { + "data": { + "description": "The postmortem relationship data.", + "example": { + "id": "00000000-0000-abcd-2000-000000000000", + "type": "incident_postmortems" + }, + "properties": { + "id": { + "description": "A unique identifier that represents the postmortem.", + "example": "00000000-0000-abcd-1000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_postmortems", + "description": "Incident postmortem resource type.", + "enum": [ + "incident_postmortems" + ], + "example": "incident_postmortems", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_POSTMORTEMS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" }, - "type": "array" - } - }, - "required": [ - "errors" - ], - "type": "object" - } + "type": { + "default": "incidents", + "description": "Incident resource type.", + "enum": [ + "incidents" + ], + "example": "incidents", + "type": "string", + "x-enum-varnames": [ + "INCIDENTS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" } - }, - "description": "Too many requests" - } - }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "incident_write" - ] - } - ], - "summary": "Delete an existing incident", - "tags": [ - "Incidents" - ], - "x-menu-order": 4, - "x-permission": { - "operator": "OR", - "permissions": [ - "incident_write" - ] - }, - "x-undo": { - "type": "idempotent" - }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - }, - "get": { - "description": "Get the details of an incident by `incident_id`.", - "operationId": "GetIncident", - "parameters": [ - { - "description": "The UUID of the incident.", - "in": "path", - "name": "incident_id", - "required": true, - "schema": { - "type": "string" } }, - { - "description": "Specifies which types of related objects should be included in the response.", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "description": "Object related to an incident.", - "enum": [ - "users", - "attachments" - ], - "type": "string", - "x-enum-varnames": [ - "USERS", - "ATTACHMENTS" - ] - }, - "type": "array" - } - } - ], + "description": "Incident Payload.", + "required": true + }, "responses": { "200": { "content": { @@ -228094,189 +234220,912 @@ "documentUrl": "", "title": "Postmortem IR-123" }, - "attachment_type": "postmortem" + "attachment_type": "postmortem" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + }, + "properties": { + "attributes": { + "description": "The attributes object for an attachment.", + "oneOf": [ + { + "description": "The attributes object for a postmortem attachment.", + "properties": { + "attachment": { + "description": "The postmortem attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this notebook attachment.", + "example": "https://app.datadoghq.com/notebook/123", + "type": "string" + }, + "title": { + "description": "The title of this postmortem attachment.", + "example": "Postmortem IR-123", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" + }, + "attachment_type": { + "default": "postmortem", + "description": "The type of postmortem attachment attributes.", + "enum": [ + "postmortem" + ], + "example": "postmortem", + "type": "string", + "x-enum-varnames": [ + "POSTMORTEM" + ] + } + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + }, + { + "description": "The attributes object for a link attachment.", + "properties": { + "attachment": { + "description": "The link attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this link attachment.", + "example": "https://www.example.com/webstore-failure-runbook", + "type": "string" + }, + "title": { + "description": "The title of this link attachment.", + "example": "Runbook for webstore service failures", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" + }, + "attachment_type": { + "default": "link", + "description": "The type of link attachment attributes.", + "enum": [ + "link" + ], + "example": "link", + "type": "string", + "x-enum-varnames": [ + "LINK" + ] + }, + "modified": { + "description": "Timestamp when the incident attachment link was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + } + ] + }, + "id": { + "description": "A unique identifier that represents the incident attachment.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident attachment's relationships.", + "properties": { + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] + } + }, + "required": [ + "type", + "attributes", + "id", + "relationships" + ], + "type": "object" + } + ] + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "data" + ], + "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": [ + "incident_write" + ] + } + ], + "summary": "Update an existing incident", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 3, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_write" + ] + }, + "x-undo": { + "type": "idempotent" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "x-merge-override": { + "delete": true + } + }, + "/api/v2/incidents/{incident_id}/attachments": { + "get": { + "description": "Get all attachments for a given incident.", + "operationId": "ListIncidentAttachments", + "parameters": [ + { + "description": "The UUID of the incident.", + "in": "path", + "name": "incident_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Specifies which types of related objects are included in the response.", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "description": "The object related to an incident attachment.", + "enum": [ + "users" + ], + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + }, + "type": "array" + } + }, + { + "description": "Specifies which types of attachments are included in the response.", + "explode": false, + "in": "query", + "name": "filter[attachment_type]", + "required": false, + "schema": { + "items": { + "description": "The type of the incident attachment attributes.", + "enum": [ + "link", + "postmortem" + ], + "example": "link", + "type": "string", + "x-enum-varnames": [ + "LINK", + "POSTMORTEM" + ] + }, + "type": "array" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The response object containing an incident's attachments.", + "properties": { + "data": { + "description": "An array of incident attachments.", + "example": [ + { + "attributes": { + "attachment": { + "documentUrl": "", + "title": "Postmortem IR-123" + }, + "attachment_type": "postmortem" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + } + ], + "items": { + "description": "A single incident attachment.", + "example": { + "attributes": { + "attachment": { + "documentUrl": "", + "title": "Postmortem IR-123" + }, + "attachment_type": "postmortem" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + }, + "properties": { + "attributes": { + "description": "The attributes object for an attachment.", + "oneOf": [ + { + "description": "The attributes object for a postmortem attachment.", + "properties": { + "attachment": { + "description": "The postmortem attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this notebook attachment.", + "example": "https://app.datadoghq.com/notebook/123", + "type": "string" + }, + "title": { + "description": "The title of this postmortem attachment.", + "example": "Postmortem IR-123", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" + }, + "attachment_type": { + "default": "postmortem", + "description": "The type of postmortem attachment attributes.", + "enum": [ + "postmortem" + ], + "example": "postmortem", + "type": "string", + "x-enum-varnames": [ + "POSTMORTEM" + ] + } + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + }, + { + "description": "The attributes object for a link attachment.", + "properties": { + "attachment": { + "description": "The link attachment.", + "properties": { + "documentUrl": { + "description": "The URL of this link attachment.", + "example": "https://www.example.com/webstore-failure-runbook", + "type": "string" + }, + "title": { + "description": "The title of this link attachment.", + "example": "Runbook for webstore service failures", + "type": "string" + } + }, + "required": [ + "documentUrl", + "title" + ], + "type": "object" + }, + "attachment_type": { + "default": "link", + "description": "The type of link attachment attributes.", + "enum": [ + "link" + ], + "example": "link", + "type": "string", + "x-enum-varnames": [ + "LINK" + ] + }, + "modified": { + "description": "Timestamp when the incident attachment link was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + } + ] + }, + "id": { + "description": "A unique identifier that represents the incident attachment.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident attachment's relationships.", + "properties": { + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] + } + }, + "required": [ + "type", + "attributes", + "id", + "relationships" + ], + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Included related resources that the user requested.", + "items": { + "description": "An object related to an attachment that is included in the response.", + "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": "00000000-abcd-0002-0000-000000000000", - "relationships": { - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - } + "id": { + "description": "ID of the user.", + "type": "string" }, - "type": "incident_attachments" - }, - "properties": { - "attributes": { - "description": "The attributes object for an attachment.", - "oneOf": [ - { - "description": "The attributes object for a postmortem attachment.", + "relationships": { + "description": "Relationships of the user object returned by the API.", + "properties": { + "org": { + "description": "Relationship to an organization.", "properties": { - "attachment": { - "description": "The postmortem attachment.", + "data": { + "description": "Relationship to organization object.", "properties": { - "documentUrl": { - "description": "The URL of this notebook attachment.", - "example": "https://app.datadoghq.com/notebook/123", + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", "type": "string" }, - "title": { - "description": "The title of this postmortem attachment.", - "example": "Postmortem IR-123", - "type": "string" + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] } }, "required": [ - "documentUrl", - "title" + "id", + "type" ], "type": "object" - }, - "attachment_type": { - "default": "postmortem", - "description": "The type of postmortem attachment attributes.", - "enum": [ - "postmortem" - ], - "example": "postmortem", - "type": "string", - "x-enum-varnames": [ - "POSTMORTEM" - ] } }, "required": [ - "attachment_type", - "attachment" + "data" ], "type": "object" }, - { - "description": "The attributes object for a link attachment.", + "other_orgs": { + "description": "Relationship to organizations.", "properties": { - "attachment": { - "description": "The link attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this link attachment.", - "example": "https://www.example.com/webstore-failure-runbook", - "type": "string" + "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" + ] + } }, - "title": { - "description": "The title of this link attachment.", - "example": "Runbook for webstore service failures", - "type": "string" - } + "required": [ + "id", + "type" + ], + "type": "object" }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" - }, - "attachment_type": { - "default": "link", - "description": "The type of link attachment attributes.", - "enum": [ - "link" - ], - "example": "link", - "type": "string", - "x-enum-varnames": [ - "LINK" - ] - }, - "modified": { - "description": "Timestamp when the incident attachment link was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" + "type": "array" } }, "required": [ - "attachment_type", - "attachment" + "data" ], "type": "object" - } - ] - }, - "id": { - "description": "A unique identifier that represents the incident attachment.", - "example": "00000000-abcd-0001-0000-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident attachment's relationships.", - "properties": { - "last_modified_by_user": { - "description": "Relationship to user.", + }, + "other_users": { + "description": "Relationship to users.", "properties": { "data": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + "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" + ] + } }, - "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 } }, - "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" + "type": "object", + "x-merge-override": { + "properties": false + } }, "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", + "default": "users", + "description": "Users resource type.", "enum": [ - "incident_attachments" + "users" ], - "example": "incident_attachments", + "example": "users", "type": "string", "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" + "USERS" ] } }, - "required": [ - "type", - "attributes", - "id", - "relationships" - ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } } ] }, - "readOnly": true, "type": "array" } }, @@ -228430,22 +235279,11 @@ "description": "Too many requests" } }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "incident_read" - ] - } - ], - "summary": "Get the details of an incident", + "summary": "Get a list of attachments", "tags": [ "Incidents" ], - "x-menu-order": 2, + "x-menu-order": 7, "x-permission": { "operator": "OR", "permissions": [ @@ -228458,8 +235296,8 @@ "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." }, "patch": { - "description": "Updates an incident. Provide only the attributes that should be updated as this request is a partial update.", - "operationId": "UpdateIncident", + "description": "The bulk update endpoint for creating, updating, and deleting attachments for a given incident.", + "operationId": "UpdateIncidentAttachments", "parameters": [ { "description": "The UUID of the incident.", @@ -228471,22 +235309,20 @@ } }, { - "description": "Specifies which types of related objects should be included in the response.", + "description": "Specifies which types of related objects are included in the response.", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { - "description": "Object related to an incident.", + "description": "The object related to an incident attachment.", "enum": [ - "users", - "attachments" + "users" ], "type": "string", "x-enum-varnames": [ - "USERS", - "ATTACHMENTS" + "USERS" ] }, "type": "array" @@ -228497,948 +235333,347 @@ "content": { "application/json": { "schema": { - "description": "Update request for an incident.", + "description": "The update request for an incident's attachments.", "properties": { "data": { - "description": "Incident data for an update request.", - "properties": { - "attributes": { - "description": "The incident's attributes for an update request.", - "properties": { - "customer_impact_end": { - "description": "Timestamp when customers were no longer impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impact_scope": { - "description": "A summary of the impact customers experienced during the incident.", - "example": "Example customer impact scope", - "type": "string" - }, - "customer_impact_start": { - "description": "Timestamp when customers began being impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impacted": { - "description": "A flag indicating whether the incident caused customer impact.", - "example": false, - "type": "boolean" - }, - "detected": { - "description": "Timestamp when the incident was detected.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "fields": { - "additionalProperties": { - "description": "Dynamic fields for which selections can be made, with field names as keys.", - "oneOf": [ - { - "description": "A field with a single value selected.", - "properties": { - "type": { - "default": "dropdown", - "description": "Type of the single value field definitions.", - "enum": [ - "dropdown", - "textbox" - ], - "example": "dropdown", - "type": "string", - "x-enum-varnames": [ - "DROPDOWN", - "TEXTBOX" - ] - }, - "value": { - "description": "The single value selected for this field.", - "example": "SEV-1", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - { - "description": "A field with potentially multiple values selected.", - "properties": { - "type": { - "default": "multiselect", - "description": "Type of the multiple value field definitions.", - "enum": [ - "multiselect", - "textarray", - "metrictag", - "autocomplete" - ], - "example": "multiselect", - "type": "string", - "x-enum-varnames": [ - "MULTISELECT", - "TEXTARRAY", - "METRICTAG", - "AUTOCOMPLETE" - ] - }, - "value": { - "description": "The multiple values selected for this field.", - "example": [ - "1.0", - "1.1" - ], - "items": { - "description": "A value which has been selected for the parent field.", - "example": "1.1", - "type": "string" - }, - "nullable": true, - "type": "array" - } - }, - "type": "object" - } - ] - }, - "description": "A condensed view of the user-defined fields for which to update selections.", - "example": { - "severity": { - "type": "dropdown", - "value": "SEV-5" - } - }, - "type": "object" - }, - "notification_handles": { - "description": "Notification handles that will be notified of the incident during update.", - "example": [ - { - "display_name": "Jane Doe", - "handle": "@user@email.com" - }, - { - "display_name": "Slack Channel", - "handle": "@slack-channel" - }, - { - "display_name": "Incident Workflow", - "handle": "@workflow-from-incident" - } - ], - "items": { - "description": "A notification handle that will be notified at incident creation.", - "properties": { - "display_name": { - "description": "The name of the notified handle.", - "example": "Jane Doe", - "type": "string" - }, - "handle": { - "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", - "example": "@test.user@test.com", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "title": { - "description": "The title of the incident, which summarizes what happened.", - "example": "A test incident title", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "The incident's ID.", - "example": "00000000-0000-0000-4567-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident's relationships for an update request.", - "properties": { - "commander_user": { - "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": "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 - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "integrations": { - "description": "A relationship reference for multiple integration metadata objects.", - "example": { - "data": [ - { - "id": "00000000-abcd-0005-0000-000000000000", - "type": "incident_integrations" - }, - { - "id": "00000000-abcd-0006-0000-000000000000", - "type": "incident_integrations" - } - ] - }, - "properties": { - "data": { - "description": "Integration metadata relationship array", - "example": [ - { - "id": "00000000-abcd-0003-0000-000000000000", - "type": "incident_integrations" - }, - { - "id": "00000000-abcd-0004-0000-000000000000", - "type": "incident_integrations" - } - ], - "items": { - "description": "A relationship reference for an integration metadata object.", - "example": { - "id": "00000000-abcd-0002-0000-000000000000", - "type": "incident_integrations" - }, - "properties": { - "id": { - "description": "A unique identifier that represents the integration metadata.", - "example": "00000000-abcd-0001-0000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", - "enum": [ - "incident_integrations" - ], - "example": "incident_integrations", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" + "description": "An array of incident attachments. An attachment object without an \"id\" key indicates that you want to\ncreate that attachment. An attachment object without an \"attributes\" key indicates that you want to\ndelete that attachment. An attachment object with both the \"id\" key and a populated \"attributes\" object\nindicates that you want to update that attachment.", + "example": [ + { + "attributes": { + "attachment": { + "documentUrl": "https://app.datadoghq.com/notebook/123", + "title": "Postmortem IR-123" }, - "postmortem": { - "description": "A relationship reference for postmortems.", - "example": { - "data": { - "id": "00000000-0000-abcd-3000-000000000000", - "type": "incident_postmortems" - } - }, - "properties": { - "data": { - "description": "The postmortem relationship data.", - "example": { - "id": "00000000-0000-abcd-2000-000000000000", - "type": "incident_postmortems" - }, - "properties": { - "id": { - "description": "A unique identifier that represents the postmortem.", - "example": "00000000-0000-abcd-1000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_postmortems", - "description": "Incident postmortem resource type.", - "enum": [ - "incident_postmortems" - ], - "example": "incident_postmortems", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_POSTMORTEMS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } + "attachment_type": "postmortem" }, - "type": "object" + "id": "00000000-abcd-0002-0000-000000000000", + "type": "incident_attachments" }, - "type": { - "default": "incidents", - "description": "Incident resource type.", - "enum": [ - "incidents" - ], - "example": "incidents", - "type": "string", - "x-enum-varnames": [ - "INCIDENTS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "description": "Incident Payload.", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "Response with an incident.", - "properties": { - "data": { - "description": "Incident data from a response.", - "properties": { + { "attributes": { - "description": "The incident's attributes from a response.", - "properties": { - "archived": { - "description": "Timestamp of when the incident was archived.", - "format": "date-time", - "nullable": true, - "readOnly": true, - "type": "string" - }, - "case_id": { - "description": "The incident case id.", - "format": "int64", - "nullable": true, - "type": "integer" - }, - "created": { - "description": "Timestamp when the incident was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "customer_impact_duration": { - "description": "Length of the incident's customer impact in seconds.\nEquals the difference between `customer_impact_start` and `customer_impact_end`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "customer_impact_end": { - "description": "Timestamp when customers were no longer impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impact_scope": { - "description": "A summary of the impact customers experienced during the incident.", - "example": "An example customer impact scope", - "nullable": true, - "type": "string" - }, - "customer_impact_start": { - "description": "Timestamp when customers began being impacted by the incident.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "customer_impacted": { - "description": "A flag indicating whether the incident caused customer impact.", - "example": false, - "type": "boolean" - }, - "detected": { - "description": "Timestamp when the incident was detected.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "fields": { - "additionalProperties": { - "description": "Dynamic fields for which selections can be made, with field names as keys.", - "oneOf": [ - { - "description": "A field with a single value selected.", - "properties": { - "type": { - "default": "dropdown", - "description": "Type of the single value field definitions.", - "enum": [ - "dropdown", - "textbox" - ], - "example": "dropdown", - "type": "string", - "x-enum-varnames": [ - "DROPDOWN", - "TEXTBOX" - ] - }, - "value": { - "description": "The single value selected for this field.", - "example": "SEV-1", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - { - "description": "A field with potentially multiple values selected.", - "properties": { - "type": { - "default": "multiselect", - "description": "Type of the multiple value field definitions.", - "enum": [ - "multiselect", - "textarray", - "metrictag", - "autocomplete" - ], - "example": "multiselect", - "type": "string", - "x-enum-varnames": [ - "MULTISELECT", - "TEXTARRAY", - "METRICTAG", - "AUTOCOMPLETE" - ] - }, - "value": { - "description": "The multiple values selected for this field.", - "example": [ - "1.0", - "1.1" - ], - "items": { - "description": "A value which has been selected for the parent field.", - "example": "1.1", - "type": "string" - }, - "nullable": true, - "type": "array" - } - }, - "type": "object" - } - ] - }, - "description": "A condensed view of the user-defined fields attached to incidents.", - "example": { - "severity": { - "type": "dropdown", - "value": "SEV-5" - } - }, - "type": "object" - }, - "incident_type_uuid": { - "description": "A unique identifier that represents an incident type.", - "example": "00000000-0000-0000-0000-000000000000", - "type": "string" - }, - "modified": { - "description": "Timestamp when the incident was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "non_datadog_creator": { - "description": "Incident's non Datadog creator.", - "nullable": true, - "properties": { - "image_48_px": { - "description": "Non Datadog creator `48px` image.", - "type": "string" - }, - "name": { - "description": "Non Datadog creator name.", - "type": "string" - } - }, - "type": "object" - }, - "notification_handles": { - "description": "Notification handles that will be notified of the incident during update.", - "example": [ - { - "display_name": "Jane Doe", - "handle": "@user@email.com" - }, - { - "display_name": "Slack Channel", - "handle": "@slack-channel" - }, - { - "display_name": "Incident Workflow", - "handle": "@workflow-from-incident" - } - ], - "items": { - "description": "A notification handle that will be notified at incident creation.", - "properties": { - "display_name": { - "description": "The name of the notified handle.", - "example": "Jane Doe", - "type": "string" - }, - "handle": { - "description": "The handle used for the notification. This includes an email address, Slack channel, or workflow.", - "example": "@test.user@test.com", - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "public_id": { - "description": "The monotonically increasing integer ID for the incident.", - "example": 1, - "format": "int64", - "type": "integer" - }, - "resolved": { - "description": "Timestamp when the incident's state was last changed from active or stable to resolved or completed.", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "severity": { - "description": "The incident severity.", - "enum": [ - "UNKNOWN", - "SEV-1", - "SEV-2", - "SEV-3", - "SEV-4", - "SEV-5" - ], - "example": "UNKNOWN", - "type": "string", - "x-enum-varnames": [ - "UNKNOWN", - "SEV_1", - "SEV_2", - "SEV_3", - "SEV_4", - "SEV_5" - ] - }, - "state": { - "description": "The state incident.", - "nullable": true, - "type": "string" - }, - "time_to_detect": { - "description": "The amount of time in seconds to detect the incident.\nEquals the difference between `customer_impact_start` and `detected`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_internal_response": { - "description": "The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_repair": { - "description": "The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "time_to_resolve": { - "description": "The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`.", - "format": "int64", - "readOnly": true, - "type": "integer" - }, - "title": { - "description": "The title of the incident, which summarizes what happened.", - "example": "A test incident title", - "type": "string" - }, - "visibility": { - "description": "The incident visibility status.", - "nullable": true, - "type": "string" - } - }, - "required": [ - "title" - ], - "type": "object" - }, - "id": { - "description": "The incident's ID.", - "example": "00000000-0000-0000-1234-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident's relationships from a response.", - "properties": { - "attachments": { - "description": "A relationship reference for attachments.", - "properties": { - "data": { - "description": "An array of incident attachments.", - "items": { - "description": "The attachment relationship data.", - "properties": { - "id": { - "description": "A unique identifier that represents the attachment.", - "example": "00000000-0000-abcd-1000-000000000000", - "type": "string" - }, - "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", - "enum": [ - "incident_attachments" - ], - "example": "incident_attachments", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "commander_user": { - "description": "Relationship to user.", - "nullable": true, + "attachment": { + "documentUrl": "https://www.example.com/webstore-failure-runbook", + "title": "Runbook for webstore service failures" + }, + "attachment_type": "link" + }, + "type": "incident_attachments" + }, + { + "id": "00000000-abcd-0003-0000-000000000000", + "type": "incident_attachments" + } + ], + "items": { + "description": "A single incident attachment.", + "properties": { + "attributes": { + "description": "Incident attachment attributes.", + "oneOf": [ + { + "description": "The attributes object for a postmortem attachment.", "properties": { - "data": { - "description": "Relationship to user object.", - "nullable": true, + "attachment": { + "description": "The postmortem attachment.", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-0000-000000000000", + "documentUrl": { + "description": "The URL of this notebook attachment.", + "example": "https://app.datadoghq.com/notebook/123", "type": "string" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "title": { + "description": "The title of this postmortem attachment.", + "example": "Postmortem IR-123", + "type": "string" } }, "required": [ - "id", - "type" + "documentUrl", + "title" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" + }, + "attachment_type": { + "default": "postmortem", + "description": "The type of postmortem attachment attributes.", + "enum": [ + "postmortem" + ], + "example": "postmortem", + "type": "string", + "x-enum-varnames": [ + "POSTMORTEM" + ] } }, "required": [ - "data" + "attachment_type", + "attachment" ], "type": "object" }, - "created_by_user": { - "description": "Relationship to user.", + { + "description": "The attributes object for a link attachment.", "properties": { - "data": { - "description": "Relationship to user object.", + "attachment": { + "description": "The link attachment.", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", + "documentUrl": { + "description": "The URL of this link attachment.", + "example": "https://www.example.com/webstore-failure-runbook", "type": "string" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "title": { + "description": "The title of this link attachment.", + "example": "Runbook for webstore service failures", + "type": "string" } }, "required": [ - "id", - "type" + "documentUrl", + "title" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" + }, + "attachment_type": { + "default": "link", + "description": "The type of link attachment attributes.", + "enum": [ + "link" + ], + "example": "link", + "type": "string", + "x-enum-varnames": [ + "LINK" + ] + }, + "modified": { + "description": "Timestamp when the incident attachment link was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" } }, "required": [ - "data" + "attachment_type", + "attachment" ], "type": "object" + } + ] + }, + "id": { + "description": "A unique identifier that represents the incident attachment.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Incident Attachment Payload.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The response object containing the created or updated incident attachments.", + "properties": { + "data": { + "description": "An array of incident attachments. Only the attachments that were created or updated by the request are\nreturned.", + "example": [ + { + "attributes": { + "attachment": { + "documentUrl": "", + "title": "Postmortem IR-123" }, - "impacts": { - "description": "Relationship to impacts.", - "properties": { - "data": { - "description": "An array of incident impacts.", - "items": { - "description": "Relationship to impact object.", + "attachment_type": "postmortem" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + } + ], + "items": { + "description": "A single incident attachment.", + "example": { + "attributes": { + "attachment": { + "documentUrl": "", + "title": "Postmortem IR-123" + }, + "attachment_type": "postmortem" + }, + "id": "00000000-abcd-0002-0000-000000000000", + "relationships": { + "last_modified_by_user": { + "data": { + "id": "00000000-0000-0000-cccc-000000000000", + "type": "users" + } + } + }, + "type": "incident_attachments" + }, + "properties": { + "attributes": { + "description": "The attributes object for an attachment.", + "oneOf": [ + { + "description": "The attributes object for a postmortem attachment.", + "properties": { + "attachment": { + "description": "The postmortem attachment.", "properties": { - "id": { - "description": "A unique identifier that represents the impact.", - "example": "00000000-0000-0000-2345-000000000000", + "documentUrl": { + "description": "The URL of this notebook attachment.", + "example": "https://app.datadoghq.com/notebook/123", "type": "string" }, - "type": { - "description": "The incident impacts type.", - "enum": [ - "incident_impacts" - ], - "example": "incident_impacts", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_IMPACTS" - ] + "title": { + "description": "The title of this postmortem attachment.", + "example": "Postmortem IR-123", + "type": "string" } }, "required": [ - "id", - "type" + "documentUrl", + "title" ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "integrations": { - "description": "A relationship reference for multiple integration metadata objects.", - "example": { - "data": [ - { - "id": "00000000-abcd-0005-0000-000000000000", - "type": "incident_integrations" + "type": "object" }, - { - "id": "00000000-abcd-0006-0000-000000000000", - "type": "incident_integrations" + "attachment_type": { + "default": "postmortem", + "description": "The type of postmortem attachment attributes.", + "enum": [ + "postmortem" + ], + "example": "postmortem", + "type": "string", + "x-enum-varnames": [ + "POSTMORTEM" + ] } - ] + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" }, - "properties": { - "data": { - "description": "Integration metadata relationship array", - "example": [ - { - "id": "00000000-abcd-0003-0000-000000000000", - "type": "incident_integrations" - }, - { - "id": "00000000-abcd-0004-0000-000000000000", - "type": "incident_integrations" - } - ], - "items": { - "description": "A relationship reference for an integration metadata object.", - "example": { - "id": "00000000-abcd-0002-0000-000000000000", - "type": "incident_integrations" - }, + { + "description": "The attributes object for a link attachment.", + "properties": { + "attachment": { + "description": "The link attachment.", "properties": { - "id": { - "description": "A unique identifier that represents the integration metadata.", - "example": "00000000-abcd-0001-0000-000000000000", + "documentUrl": { + "description": "The URL of this link attachment.", + "example": "https://www.example.com/webstore-failure-runbook", "type": "string" }, - "type": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", - "enum": [ - "incident_integrations" - ], - "example": "incident_integrations", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" - ] + "title": { + "description": "The title of this link attachment.", + "example": "Runbook for webstore service failures", + "type": "string" } }, "required": [ - "id", - "type" + "documentUrl", + "title" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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" - ] - } + "attachment_type": { + "default": "link", + "description": "The type of link attachment attributes.", + "enum": [ + "link" + ], + "example": "link", + "type": "string", + "x-enum-varnames": [ + "LINK" + ] }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "modified": { + "description": "Timestamp when the incident attachment link was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "responders": { - "description": "Relationship to incident responders.", - "properties": { - "data": { - "description": "An array of incident responders.", - "items": { - "description": "Relationship to impact object.", + }, + "required": [ + "attachment_type", + "attachment" + ], + "type": "object" + } + ] + }, + "id": { + "description": "A unique identifier that represents the incident attachment.", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident attachment's relationships.", + "properties": { + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", "properties": { "id": { - "description": "A unique identifier that represents the responder.", + "description": "A unique identifier that represents the user.", "example": "00000000-0000-0000-2345-000000000000", "type": "string" }, "type": { - "description": "The incident responders type.", + "default": "users", + "description": "Users resource type.", "enum": [ - "incident_responders" + "users" ], - "example": "incident_responders", + "example": "users", "type": "string", "x-enum-varnames": [ - "INCIDENT_RESPONDERS" + "USERS" ] } }, @@ -229450,86 +235685,43 @@ "x-merge-override": { "required": false } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } }, - "user_defined_fields": { - "description": "Relationship to incident user defined fields.", - "properties": { - "data": { - "description": "An array of user defined fields.", - "items": { - "description": "Relationship to impact object.", - "properties": { - "id": { - "description": "A unique identifier that represents the responder.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" - }, - "type": { - "description": "The incident user defined fields type.", - "enum": [ - "user_defined_field" - ], - "example": "user_defined_field", - "type": "string", - "x-enum-varnames": [ - "USER_DEFINED_FIELD" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - } + "type": "object" }, - "type": "object" + "type": { + "default": "incident_attachments", + "description": "The incident attachment resource type.", + "enum": [ + "incident_attachments" + ], + "example": "incident_attachments", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_ATTACHMENTS" + ] + } }, - "type": { - "default": "incidents", - "description": "Incident resource type.", - "enum": [ - "incidents" - ], - "example": "incidents", - "type": "string", - "x-enum-varnames": [ - "INCIDENTS" - ] - } + "required": [ + "type", + "attributes", + "id", + "relationships" + ], + "type": "object" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" }, "included": { "description": "Included related resources that the user requested.", "items": { - "description": "An object related to an incident that is included in the response.", + "description": "An object related to an attachment that is included in the response.", "oneOf": [ { "description": "User object returned by the API.", @@ -229537,6 +235729,15 @@ "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" @@ -229549,14 +235750,37 @@ "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" }, - "uuid": { - "description": "UUID of the user.", + "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" @@ -229565,212 +235789,195 @@ "description": "ID of the user.", "type": "string" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object" - }, - { - "description": "A single incident attachment.", - "example": { - "attributes": { - "attachment": { - "documentUrl": "", - "title": "Postmortem IR-123" - }, - "attachment_type": "postmortem" - }, - "id": "00000000-abcd-0002-0000-000000000000", "relationships": { - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - } - }, - "type": "incident_attachments" - }, - "properties": { - "attributes": { - "description": "The attributes object for an attachment.", - "oneOf": [ - { - "description": "The attributes object for a postmortem attachment.", + "description": "Relationships of the user object returned by the API.", + "properties": { + "org": { + "description": "Relationship to an organization.", "properties": { - "attachment": { - "description": "The postmortem attachment.", + "data": { + "description": "Relationship to organization object.", "properties": { - "documentUrl": { - "description": "The URL of this notebook attachment.", - "example": "https://app.datadoghq.com/notebook/123", + "id": { + "description": "ID of the organization.", + "example": "00000000-0000-beef-0000-000000000000", "type": "string" }, - "title": { - "description": "The title of this postmortem attachment.", - "example": "Postmortem IR-123", - "type": "string" + "type": { + "default": "orgs", + "description": "Organizations resource type.", + "enum": [ + "orgs" + ], + "example": "orgs", + "type": "string", + "x-enum-varnames": [ + "ORGS" + ] } }, "required": [ - "documentUrl", - "title" + "id", + "type" ], "type": "object" - }, - "attachment_type": { - "default": "postmortem", - "description": "The type of postmortem attachment attributes.", - "enum": [ - "postmortem" - ], - "example": "postmortem", - "type": "string", - "x-enum-varnames": [ - "POSTMORTEM" - ] } }, "required": [ - "attachment_type", - "attachment" + "data" ], "type": "object" }, - { - "description": "The attributes object for a link attachment.", + "other_orgs": { + "description": "Relationship to organizations.", "properties": { - "attachment": { - "description": "The link attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this link attachment.", - "example": "https://www.example.com/webstore-failure-runbook", - "type": "string" + "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" + ] + } }, - "title": { - "description": "The title of this link attachment.", - "example": "Runbook for webstore service failures", - "type": "string" - } + "required": [ + "id", + "type" + ], + "type": "object" }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" - }, - "attachment_type": { - "default": "link", - "description": "The type of link attachment attributes.", - "enum": [ - "link" - ], - "example": "link", - "type": "string", - "x-enum-varnames": [ - "LINK" - ] - }, - "modified": { - "description": "Timestamp when the incident attachment link was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" + "type": "array" } }, "required": [ - "attachment_type", - "attachment" + "data" ], "type": "object" - } - ] - }, - "id": { - "description": "A unique identifier that represents the incident attachment.", - "example": "00000000-abcd-0001-0000-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident attachment's relationships.", - "properties": { - "last_modified_by_user": { - "description": "Relationship to user.", + }, + "other_users": { + "description": "Relationship to users.", "properties": { "data": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + "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" + ] + } }, - "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 } }, - "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" + "type": "object", + "x-merge-override": { + "properties": false + } }, "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", + "default": "users", + "description": "Users resource type.", "enum": [ - "incident_attachments" + "users" ], - "example": "incident_attachments", + "example": "users", "type": "string", "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" + "USERS" ] } }, - "required": [ - "type", - "attributes", - "id", - "relationships" - ], - "type": "object" + "type": "object", + "x-merge-override": { + "required": false + } } ] }, - "readOnly": true, "type": "array" } }, @@ -229924,23 +236131,27 @@ "description": "Too many requests" } }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "incident_write" - ] - } - ], - "summary": "Update an existing incident", + "summary": "Create, update, and delete incident attachments", "tags": [ "Incidents" ], "x-codegen-request-body-name": "body", - "x-menu-order": 3, + "x-given": { + "incident_attachment": { + "parameters": [ + { + "name": "incident_id", + "source": "incident.data.id" + }, + { + "name": "body", + "value": "{\n \"data\": [\n {\n \"attributes\": {\n \"attachment_type\": \"link\",\n \"attachment\": {\n \"documentUrl\": \"https://www.example.com/doc\",\n \"title\": \"Important Doc\"\n }\n },\n \"type\": \"incident_attachments\"\n }\n ]\n}" + } + ], + "step": "the \"incident\" has an \"incident_attachment\"" + } + }, + "x-menu-order": 8, "x-permission": { "operator": "OR", "permissions": [ @@ -229951,15 +236162,12 @@ "type": "idempotent" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - }, - "x-merge-override": { - "delete": true } }, - "/api/v2/incidents/{incident_id}/attachments": { + "/api/v2/incidents/{incident_id}/relationships/integrations": { "get": { - "description": "Get all attachments for a given incident.", - "operationId": "ListIncidentAttachments", + "description": "Get all integration metadata for an incident.", + "operationId": "ListIncidentIntegrations", "parameters": [ { "description": "The UUID of the incident.", @@ -229969,206 +236177,252 @@ "schema": { "type": "string" } - }, - { - "description": "Specifies which types of related objects are included in the response.", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "description": "The object related to an incident attachment.", - "enum": [ - "users" - ], - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - }, - "type": "array" - } - }, - { - "description": "Specifies which types of attachments are included in the response.", - "explode": false, - "in": "query", - "name": "filter[attachment_type]", - "required": false, - "schema": { - "items": { - "description": "The type of the incident attachment attributes.", - "enum": [ - "link", - "postmortem" - ], - "example": "link", - "type": "string", - "x-enum-varnames": [ - "LINK", - "POSTMORTEM" - ] - }, - "type": "array" - } } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "The response object containing an incident's attachments.", - "properties": { - "data": { - "description": "An array of incident attachments.", - "example": [ - { - "attributes": { - "attachment": { - "documentUrl": "", - "title": "Postmortem IR-123" - }, - "attachment_type": "postmortem" - }, - "id": "00000000-abcd-0002-0000-000000000000", - "relationships": { - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - } - }, - "type": "incident_attachments" - } - ], - "items": { - "description": "A single incident attachment.", - "example": { - "attributes": { - "attachment": { - "documentUrl": "", - "title": "Postmortem IR-123" - }, - "attachment_type": "postmortem" - }, - "id": "00000000-abcd-0002-0000-000000000000", - "relationships": { - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - } - }, - "type": "incident_attachments" - }, + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response with a list of incident integration metadata.", + "properties": { + "data": { + "description": "An array of incident integration metadata.", + "items": { + "description": "Incident integration metadata from a response.", "properties": { "attributes": { - "description": "The attributes object for an attachment.", - "oneOf": [ - { - "description": "The attributes object for a postmortem attachment.", - "properties": { - "attachment": { - "description": "The postmortem attachment.", + "description": "Incident integration metadata's attributes for a create request.", + "properties": { + "created": { + "description": "Timestamp when the incident todo was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "incident_id": { + "description": "UUID of the incident this integration metadata is connected to.", + "example": "00000000-aaaa-0000-0000-000000000000", + "type": "string" + }, + "integration_type": { + "description": "A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.", + "example": 1, + "format": "int32", + "maximum": 9, + "type": "integer" + }, + "metadata": { + "description": "Incident integration metadata's metadata attribute.", + "oneOf": [ + { + "description": "Incident integration metadata for the Slack integration.", "properties": { - "documentUrl": { - "description": "The URL of this notebook attachment.", - "example": "https://app.datadoghq.com/notebook/123", - "type": "string" - }, - "title": { - "description": "The title of this postmortem attachment.", - "example": "Postmortem IR-123", - "type": "string" + "channels": { + "description": "Array of Slack channels in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Slack integration metadata channel array.", + "properties": { + "channel_id": { + "description": "Slack channel ID.", + "example": "C0123456789", + "type": "string" + }, + "channel_name": { + "description": "Name of the Slack channel.", + "example": "#example-channel-name", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Slack channel.", + "example": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", + "type": "string" + }, + "team_id": { + "description": "Slack team ID.", + "example": "T01234567", + "type": "string" + } + }, + "required": [ + "channel_id", + "channel_name", + "redirect_url" + ], + "type": "object" + }, + "type": "array" } }, "required": [ - "documentUrl", - "title" + "channels" ], "type": "object" }, - "attachment_type": { - "default": "postmortem", - "description": "The type of postmortem attachment attributes.", - "enum": [ - "postmortem" - ], - "example": "postmortem", - "type": "string", - "x-enum-varnames": [ - "POSTMORTEM" - ] - } - }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - }, - { - "description": "The attributes object for a link attachment.", - "properties": { - "attachment": { - "description": "The link attachment.", + { + "description": "Incident integration metadata for the Jira integration.", "properties": { - "documentUrl": { - "description": "The URL of this link attachment.", - "example": "https://www.example.com/webstore-failure-runbook", - "type": "string" - }, - "title": { - "description": "The title of this link attachment.", - "example": "Runbook for webstore service failures", - "type": "string" + "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": [ - "documentUrl", - "title" + "issues" ], "type": "object" }, - "attachment_type": { - "default": "link", - "description": "The type of link attachment attributes.", - "enum": [ - "link" + { + "description": "Incident integration metadata for the Microsoft Teams integration.", + "properties": { + "teams": { + "description": "Array of Microsoft Teams in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Microsoft Teams integration metadata teams array.", + "properties": { + "ms_channel_id": { + "description": "Microsoft Teams channel ID.", + "example": "19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2", + "type": "string" + }, + "ms_channel_name": { + "description": "Microsoft Teams channel name.", + "example": "incident-0001-example", + "type": "string" + }, + "ms_tenant_id": { + "description": "Microsoft Teams tenant ID.", + "example": "00000000-abcd-0005-0000-000000000000", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Microsoft Teams channel.", + "example": "https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000", + "type": "string" + } + }, + "required": [ + "ms_tenant_id", + "ms_channel_id", + "ms_channel_name", + "redirect_url" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "teams" ], - "example": "link", - "type": "string", - "x-enum-varnames": [ - "LINK" - ] - }, - "modified": { - "description": "Timestamp when the incident attachment link was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" + "type": "object" } - }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" + ] + }, + "modified": { + "description": "Timestamp when the incident todo was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.", + "format": "int32", + "maximum": 5, + "type": "integer" } - ] + }, + "required": [ + "integration_type", + "metadata" + ], + "type": "object" }, "id": { - "description": "A unique identifier that represents the incident attachment.", - "example": "00000000-abcd-0001-0000-000000000000", + "description": "The incident integration metadata's ID.", + "example": "00000000-0000-0000-1234-000000000000", "type": "string" }, "relationships": { - "description": "The incident attachment's relationships.", + "description": "The incident's integration relationships from a response.", "properties": { + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, "last_modified_by_user": { "description": "Relationship to user.", "properties": { @@ -230212,23 +236466,21 @@ "type": "object" }, "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", + "default": "incident_integrations", + "description": "Integration metadata resource type.", "enum": [ - "incident_attachments" + "incident_integrations" ], - "example": "incident_attachments", + "example": "incident_integrations", "type": "string", "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" + "INCIDENT_INTEGRATIONS" ] } }, "required": [ - "type", - "attributes", "id", - "relationships" + "type" ], "type": "object" }, @@ -230237,7 +236489,7 @@ "included": { "description": "Included related resources that the user requested.", "items": { - "description": "An object related to an attachment that is included in the response.", + "description": "An object related to an incident integration metadata that is included in the response.", "oneOf": [ { "description": "User object returned by the API.", @@ -230494,7 +236746,39 @@ } ] }, + "readOnly": true, "type": "array" + }, + "meta": { + "description": "The metadata object containing pagination metadata.", + "properties": { + "pagination": { + "description": "Pagination properties.", + "properties": { + "next_offset": { + "description": "The index of the first element in the next page of results. Equal to page size added to the current offset.", + "example": 1000, + "format": "int64", + "type": "integer" + }, + "offset": { + "description": "The index of the first element in the results.", + "example": 10, + "format": "int64", + "type": "integer" + }, + "size": { + "description": "Maximum size of pages to return.", + "example": 1000, + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "readOnly": true, + "type": "object" } }, "required": [ @@ -230647,11 +236931,22 @@ "description": "Too many requests" } }, - "summary": "Get a list of attachments", + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_read" + ] + } + ], + "summary": "Get a list of an incident's integration metadata", "tags": [ "Incidents" ], - "x-menu-order": 7, + "x-menu-order": 9, "x-permission": { "operator": "OR", "permissions": [ @@ -230663,9 +236958,9 @@ }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." }, - "patch": { - "description": "The bulk update endpoint for creating, updating, and deleting attachments for a given incident.", - "operationId": "UpdateIncidentAttachments", + "post": { + "description": "Create an incident integration metadata.", + "operationId": "CreateIncidentIntegration", "parameters": [ { "description": "The UUID of the incident.", @@ -230675,185 +236970,220 @@ "schema": { "type": "string" } - }, - { - "description": "Specifies which types of related objects are included in the response.", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "description": "The object related to an incident attachment.", - "enum": [ - "users" - ], - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - }, - "type": "array" - } } ], "requestBody": { "content": { "application/json": { "schema": { - "description": "The update request for an incident's attachments.", + "description": "Create request for an incident integration metadata.", "properties": { "data": { - "description": "An array of incident attachments. An attachment object without an \"id\" key indicates that you want to\ncreate that attachment. An attachment object without an \"attributes\" key indicates that you want to\ndelete that attachment. An attachment object with both the \"id\" key and a populated \"attributes\" object\nindicates that you want to update that attachment.", - "example": [ - { - "attributes": { - "attachment": { - "documentUrl": "https://app.datadoghq.com/notebook/123", - "title": "Postmortem IR-123" + "description": "Incident integration metadata data for a create request.", + "properties": { + "attributes": { + "description": "Incident integration metadata's attributes for a create request.", + "properties": { + "created": { + "description": "Timestamp when the incident todo was created.", + "format": "date-time", + "readOnly": true, + "type": "string" }, - "attachment_type": "postmortem" - }, - "id": "00000000-abcd-0002-0000-000000000000", - "type": "incident_attachments" - }, - { - "attributes": { - "attachment": { - "documentUrl": "https://www.example.com/webstore-failure-runbook", - "title": "Runbook for webstore service failures" + "incident_id": { + "description": "UUID of the incident this integration metadata is connected to.", + "example": "00000000-aaaa-0000-0000-000000000000", + "type": "string" }, - "attachment_type": "link" - }, - "type": "incident_attachments" - }, - { - "id": "00000000-abcd-0003-0000-000000000000", - "type": "incident_attachments" - } - ], - "items": { - "description": "A single incident attachment.", - "properties": { - "attributes": { - "description": "Incident attachment attributes.", - "oneOf": [ - { - "description": "The attributes object for a postmortem attachment.", - "properties": { - "attachment": { - "description": "The postmortem attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this notebook attachment.", - "example": "https://app.datadoghq.com/notebook/123", - "type": "string" + "integration_type": { + "description": "A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.", + "example": 1, + "format": "int32", + "maximum": 9, + "type": "integer" + }, + "metadata": { + "description": "Incident integration metadata's metadata attribute.", + "oneOf": [ + { + "description": "Incident integration metadata for the Slack integration.", + "properties": { + "channels": { + "description": "Array of Slack channels in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Slack integration metadata channel array.", + "properties": { + "channel_id": { + "description": "Slack channel ID.", + "example": "C0123456789", + "type": "string" + }, + "channel_name": { + "description": "Name of the Slack channel.", + "example": "#example-channel-name", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Slack channel.", + "example": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", + "type": "string" + }, + "team_id": { + "description": "Slack team ID.", + "example": "T01234567", + "type": "string" + } + }, + "required": [ + "channel_id", + "channel_name", + "redirect_url" + ], + "type": "object" }, - "title": { - "description": "The title of this postmortem attachment.", - "example": "Postmortem IR-123", - "type": "string" - } - }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" + "type": "array" + } }, - "attachment_type": { - "default": "postmortem", - "description": "The type of postmortem attachment attributes.", - "enum": [ - "postmortem" - ], - "example": "postmortem", - "type": "string", - "x-enum-varnames": [ - "POSTMORTEM" - ] - } + "required": [ + "channels" + ], + "type": "object" }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - }, - { - "description": "The attributes object for a link attachment.", - "properties": { - "attachment": { - "description": "The link attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this link attachment.", - "example": "https://www.example.com/webstore-failure-runbook", - "type": "string" + { + "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" }, - "title": { - "description": "The title of this link attachment.", - "example": "Runbook for webstore service failures", - "type": "string" - } - }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" - }, - "attachment_type": { - "default": "link", - "description": "The type of link attachment attributes.", - "enum": [ - "link" - ], - "example": "link", - "type": "string", - "x-enum-varnames": [ - "LINK" - ] + "type": "array" + } }, - "modified": { - "description": "Timestamp when the incident attachment link was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - } + "required": [ + "issues" + ], + "type": "object" }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - } - ] - }, - "id": { - "description": "A unique identifier that represents the incident attachment.", - "example": "00000000-abcd-0001-0000-000000000000", - "type": "string" + { + "description": "Incident integration metadata for the Microsoft Teams integration.", + "properties": { + "teams": { + "description": "Array of Microsoft Teams in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Microsoft Teams integration metadata teams array.", + "properties": { + "ms_channel_id": { + "description": "Microsoft Teams channel ID.", + "example": "19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2", + "type": "string" + }, + "ms_channel_name": { + "description": "Microsoft Teams channel name.", + "example": "incident-0001-example", + "type": "string" + }, + "ms_tenant_id": { + "description": "Microsoft Teams tenant ID.", + "example": "00000000-abcd-0005-0000-000000000000", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Microsoft Teams channel.", + "example": "https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000", + "type": "string" + } + }, + "required": [ + "ms_tenant_id", + "ms_channel_id", + "ms_channel_name", + "redirect_url" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "teams" + ], + "type": "object" + } + ] + }, + "modified": { + "description": "Timestamp when the incident todo was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.", + "format": "int32", + "maximum": 5, + "type": "integer" + } }, - "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", - "enum": [ - "incident_attachments" - ], - "example": "incident_attachments", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" - ] - } + "required": [ + "integration_type", + "metadata" + ], + "type": "object" }, - "required": [ - "type" - ], - "type": "object" + "type": { + "default": "incident_integrations", + "description": "Integration metadata resource type.", + "enum": [ + "incident_integrations" + ], + "example": "incident_integrations", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_INTEGRATIONS" + ] + } }, - "type": "array" + "required": [ + "type", + "attributes" + ], + "type": "object" } }, "required": [ @@ -230863,233 +237193,316 @@ } } }, - "description": "Incident Attachment Payload.", + "description": "Incident integration metadata payload.", "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "description": "The response object containing the created or updated incident attachments.", + "description": "Response with an incident integration metadata.", "properties": { "data": { - "description": "An array of incident attachments. Only the attachments that were created or updated by the request are\nreturned.", - "example": [ - { - "attributes": { - "attachment": { - "documentUrl": "", - "title": "Postmortem IR-123" + "description": "Incident integration metadata from a response.", + "properties": { + "attributes": { + "description": "Incident integration metadata's attributes for a create request.", + "properties": { + "created": { + "description": "Timestamp when the incident todo was created.", + "format": "date-time", + "readOnly": true, + "type": "string" }, - "attachment_type": "postmortem" - }, - "id": "00000000-abcd-0002-0000-000000000000", - "relationships": { - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - } - }, - "type": "incident_attachments" - } - ], - "items": { - "description": "A single incident attachment.", - "example": { - "attributes": { - "attachment": { - "documentUrl": "", - "title": "Postmortem IR-123" + "incident_id": { + "description": "UUID of the incident this integration metadata is connected to.", + "example": "00000000-aaaa-0000-0000-000000000000", + "type": "string" }, - "attachment_type": "postmortem" - }, - "id": "00000000-abcd-0002-0000-000000000000", - "relationships": { - "last_modified_by_user": { - "data": { - "id": "00000000-0000-0000-cccc-000000000000", - "type": "users" - } - } - }, - "type": "incident_attachments" - }, - "properties": { - "attributes": { - "description": "The attributes object for an attachment.", - "oneOf": [ - { - "description": "The attributes object for a postmortem attachment.", - "properties": { - "attachment": { - "description": "The postmortem attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this notebook attachment.", - "example": "https://app.datadoghq.com/notebook/123", - "type": "string" + "integration_type": { + "description": "A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.", + "example": 1, + "format": "int32", + "maximum": 9, + "type": "integer" + }, + "metadata": { + "description": "Incident integration metadata's metadata attribute.", + "oneOf": [ + { + "description": "Incident integration metadata for the Slack integration.", + "properties": { + "channels": { + "description": "Array of Slack channels in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Slack integration metadata channel array.", + "properties": { + "channel_id": { + "description": "Slack channel ID.", + "example": "C0123456789", + "type": "string" + }, + "channel_name": { + "description": "Name of the Slack channel.", + "example": "#example-channel-name", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Slack channel.", + "example": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", + "type": "string" + }, + "team_id": { + "description": "Slack team ID.", + "example": "T01234567", + "type": "string" + } + }, + "required": [ + "channel_id", + "channel_name", + "redirect_url" + ], + "type": "object" }, - "title": { - "description": "The title of this postmortem attachment.", - "example": "Postmortem IR-123", - "type": "string" - } - }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" + "type": "array" + } }, - "attachment_type": { - "default": "postmortem", - "description": "The type of postmortem attachment attributes.", - "enum": [ - "postmortem" - ], - "example": "postmortem", - "type": "string", - "x-enum-varnames": [ - "POSTMORTEM" - ] - } + "required": [ + "channels" + ], + "type": "object" }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - }, - { - "description": "The attributes object for a link attachment.", - "properties": { - "attachment": { - "description": "The link attachment.", - "properties": { - "documentUrl": { - "description": "The URL of this link attachment.", - "example": "https://www.example.com/webstore-failure-runbook", - "type": "string" + { + "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" }, - "title": { - "description": "The title of this link attachment.", - "example": "Runbook for webstore service failures", - "type": "string" - } + "type": "array" + } + }, + "required": [ + "issues" + ], + "type": "object" + }, + { + "description": "Incident integration metadata for the Microsoft Teams integration.", + "properties": { + "teams": { + "description": "Array of Microsoft Teams in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Microsoft Teams integration metadata teams array.", + "properties": { + "ms_channel_id": { + "description": "Microsoft Teams channel ID.", + "example": "19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2", + "type": "string" + }, + "ms_channel_name": { + "description": "Microsoft Teams channel name.", + "example": "incident-0001-example", + "type": "string" + }, + "ms_tenant_id": { + "description": "Microsoft Teams tenant ID.", + "example": "00000000-abcd-0005-0000-000000000000", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Microsoft Teams channel.", + "example": "https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000", + "type": "string" + } + }, + "required": [ + "ms_tenant_id", + "ms_channel_id", + "ms_channel_name", + "redirect_url" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "teams" + ], + "type": "object" + } + ] + }, + "modified": { + "description": "Timestamp when the incident todo was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.", + "format": "int32", + "maximum": 5, + "type": "integer" + } + }, + "required": [ + "integration_type", + "metadata" + ], + "type": "object" + }, + "id": { + "description": "The incident integration metadata's ID.", + "example": "00000000-0000-0000-1234-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident's integration relationships from a response.", + "properties": { + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" }, - "required": [ - "documentUrl", - "title" - ], - "type": "object" - }, - "attachment_type": { - "default": "link", - "description": "The type of link attachment attributes.", - "enum": [ - "link" - ], - "example": "link", - "type": "string", - "x-enum-varnames": [ - "LINK" - ] + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } }, - "modified": { - "description": "Timestamp when the incident attachment link was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" + "required": [ + "id", + "type" + ], + "type": "object", + "x-merge-override": { + "required": false } - }, - "required": [ - "attachment_type", - "attachment" - ], - "type": "object" - } - ] - }, - "id": { - "description": "A unique identifier that represents the incident attachment.", - "example": "00000000-abcd-0001-0000-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident attachment's relationships.", - "properties": { - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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": [ + "data" + ], + "type": "object" + }, + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "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 } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } }, - "type": { - "default": "incident_attachments", - "description": "The incident attachment resource type.", - "enum": [ - "incident_attachments" - ], - "example": "incident_attachments", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_ATTACHMENTS" - ] - } + "type": "object" }, - "required": [ - "type", - "attributes", - "id", - "relationships" - ], - "type": "object" + "type": { + "default": "incident_integrations", + "description": "Integration metadata resource type.", + "enum": [ + "incident_integrations" + ], + "example": "incident_integrations", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_INTEGRATIONS" + ] + } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" }, "included": { "description": "Included related resources that the user requested.", "items": { - "description": "An object related to an attachment that is included in the response.", + "description": "An object related to an incident integration metadata that is included in the response.", "oneOf": [ { "description": "User object returned by the API.", @@ -231346,6 +237759,7 @@ } ] }, + "readOnly": true, "type": "array" } }, @@ -231356,7 +237770,7 @@ } } }, - "description": "OK" + "description": "CREATED" }, "400": { "content": { @@ -231499,13 +237913,24 @@ "description": "Too many requests" } }, - "summary": "Create, update, and delete incident attachments", + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "incident_write" + ] + } + ], + "summary": "Create an incident integration metadata", "tags": [ "Incidents" ], "x-codegen-request-body-name": "body", "x-given": { - "incident_attachment": { + "incident_integration_metadata": { "parameters": [ { "name": "incident_id", @@ -231513,13 +237938,13 @@ }, { "name": "body", - "value": "{\n \"data\": [\n {\n \"attributes\": {\n \"attachment_type\": \"link\",\n \"attachment\": {\n \"documentUrl\": \"https://www.example.com/doc\",\n \"title\": \"Important Doc\"\n }\n },\n \"type\": \"incident_attachments\"\n }\n ]\n}" + "value": "{\n \"data\": {\n \"attributes\": {\n \"integration_type\": 1,\n \"incident_id\": \"{{ incident.data.id }}\",\n \"status\": 2,\n \"metadata\": {\n \"channels\": [\n {\n \"channel_id\": \"C0123456789\",\n \"team_id\": \"T01234567\",\n \"channel_name\": \"#example-channel-name\",\n \"redirect_url\": \"https://slack.com/app_redirect?channel=C0123456789&team=T01234567\"\n }\n ]\n }\n },\n \"type\": \"incident_integrations\"\n }\n}" } ], - "step": "the \"incident\" has an \"incident_attachment\"" + "step": "the \"incident\" has an \"incident_integration_metadata\"" } }, - "x-menu-order": 8, + "x-menu-order": 10, "x-permission": { "operator": "OR", "permissions": [ @@ -231527,15 +237952,216 @@ ] }, "x-undo": { - "type": "idempotent" + "operationId": "DeleteIncidentIntegration", + "parameters": [ + { + "name": "incident_id", + "source": "data.attributes.incident_id" + }, + { + "name": "integration_metadata_id", + "source": "data.id" + } + ], + "type": "unsafe" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." } }, - "/api/v2/incidents/{incident_id}/relationships/integrations": { + "/api/v2/incidents/{incident_id}/relationships/integrations/{integration_metadata_id}": { + "delete": { + "description": "Delete an incident integration metadata.", + "operationId": "DeleteIncidentIntegration", + "parameters": [ + { + "description": "The UUID of the incident.", + "in": "path", + "name": "incident_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The UUID of the incident integration metadata.", + "in": "path", + "name": "integration_metadata_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "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": [ + "incident_write" + ] + } + ], + "summary": "Delete an incident integration metadata", + "tags": [ + "Incidents" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 13, + "x-undo": { + "type": "idempotent" + }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, "get": { - "description": "Get all integration metadata for an incident.", - "operationId": "ListIncidentIntegrations", + "description": "Get incident integration metadata details.", + "operationId": "GetIncidentIntegration", "parameters": [ { "description": "The UUID of the incident.", @@ -231545,6 +238171,15 @@ "schema": { "type": "string" } + }, + { + "description": "The UUID of the incident integration metadata.", + "in": "path", + "name": "integration_metadata_id", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { @@ -231552,307 +238187,303 @@ "content": { "application/json": { "schema": { - "description": "Response with a list of incident integration metadata.", + "description": "Response with an incident integration metadata.", "properties": { "data": { - "description": "An array of incident integration metadata.", - "items": { - "description": "Incident integration metadata from a response.", - "properties": { - "attributes": { - "description": "Incident integration metadata's attributes for a create request.", - "properties": { - "created": { - "description": "Timestamp when the incident todo was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "incident_id": { - "description": "UUID of the incident this integration metadata is connected to.", - "example": "00000000-aaaa-0000-0000-000000000000", - "type": "string" - }, - "integration_type": { - "description": "A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.", - "example": 1, - "format": "int32", - "maximum": 9, - "type": "integer" - }, - "metadata": { - "description": "Incident integration metadata's metadata attribute.", - "oneOf": [ - { - "description": "Incident integration metadata for the Slack integration.", - "properties": { - "channels": { - "description": "Array of Slack channels in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Slack integration metadata channel array.", - "properties": { - "channel_id": { - "description": "Slack channel ID.", - "example": "C0123456789", - "type": "string" - }, - "channel_name": { - "description": "Name of the Slack channel.", - "example": "#example-channel-name", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Slack channel.", - "example": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", - "type": "string" - }, - "team_id": { - "description": "Slack team ID.", - "example": "T01234567", - "type": "string" - } + "description": "Incident integration metadata from a response.", + "properties": { + "attributes": { + "description": "Incident integration metadata's attributes for a create request.", + "properties": { + "created": { + "description": "Timestamp when the incident todo was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "incident_id": { + "description": "UUID of the incident this integration metadata is connected to.", + "example": "00000000-aaaa-0000-0000-000000000000", + "type": "string" + }, + "integration_type": { + "description": "A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.", + "example": 1, + "format": "int32", + "maximum": 9, + "type": "integer" + }, + "metadata": { + "description": "Incident integration metadata's metadata attribute.", + "oneOf": [ + { + "description": "Incident integration metadata for the Slack integration.", + "properties": { + "channels": { + "description": "Array of Slack channels in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Slack integration metadata channel array.", + "properties": { + "channel_id": { + "description": "Slack channel ID.", + "example": "C0123456789", + "type": "string" }, - "required": [ - "channel_id", - "channel_name", - "redirect_url" - ], - "type": "object" + "channel_name": { + "description": "Name of the Slack channel.", + "example": "#example-channel-name", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Slack channel.", + "example": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", + "type": "string" + }, + "team_id": { + "description": "Slack team ID.", + "example": "T01234567", + "type": "string" + } }, - "type": "array" - } - }, - "required": [ - "channels" - ], - "type": "object" + "required": [ + "channel_id", + "channel_name", + "redirect_url" + ], + "type": "object" + }, + "type": "array" + } }, - { - "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": [ + "channels" + ], + "type": "object" + }, + { + "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" }, - "required": [ - "project_key", - "account" - ], - "type": "object" + "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" + } }, - "type": "array" - } - }, - "required": [ - "issues" - ], - "type": "object" + "required": [ + "project_key", + "account" + ], + "type": "object" + }, + "type": "array" + } }, - { - "description": "Incident integration metadata for the Microsoft Teams integration.", - "properties": { - "teams": { - "description": "Array of Microsoft Teams in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Microsoft Teams integration metadata teams array.", - "properties": { - "ms_channel_id": { - "description": "Microsoft Teams channel ID.", - "example": "19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2", - "type": "string" - }, - "ms_channel_name": { - "description": "Microsoft Teams channel name.", - "example": "incident-0001-example", - "type": "string" - }, - "ms_tenant_id": { - "description": "Microsoft Teams tenant ID.", - "example": "00000000-abcd-0005-0000-000000000000", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Microsoft Teams channel.", - "example": "https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000", - "type": "string" - } + "required": [ + "issues" + ], + "type": "object" + }, + { + "description": "Incident integration metadata for the Microsoft Teams integration.", + "properties": { + "teams": { + "description": "Array of Microsoft Teams in this integration metadata.", + "example": [], + "items": { + "description": "Item in the Microsoft Teams integration metadata teams array.", + "properties": { + "ms_channel_id": { + "description": "Microsoft Teams channel ID.", + "example": "19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2", + "type": "string" }, - "required": [ - "ms_tenant_id", - "ms_channel_id", - "ms_channel_name", - "redirect_url" - ], - "type": "object" + "ms_channel_name": { + "description": "Microsoft Teams channel name.", + "example": "incident-0001-example", + "type": "string" + }, + "ms_tenant_id": { + "description": "Microsoft Teams tenant ID.", + "example": "00000000-abcd-0005-0000-000000000000", + "type": "string" + }, + "redirect_url": { + "description": "URL redirecting to the Microsoft Teams channel.", + "example": "https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000", + "type": "string" + } }, - "type": "array" - } - }, - "required": [ - "teams" - ], - "type": "object" - } - ] - }, - "modified": { - "description": "Timestamp when the incident todo was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "status": { - "description": "A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.", - "format": "int32", - "maximum": 5, - "type": "integer" - } + "required": [ + "ms_tenant_id", + "ms_channel_id", + "ms_channel_name", + "redirect_url" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "teams" + ], + "type": "object" + } + ] }, - "required": [ - "integration_type", - "metadata" - ], - "type": "object" - }, - "id": { - "description": "The incident integration metadata's ID.", - "example": "00000000-0000-0000-1234-000000000000", - "type": "string" + "modified": { + "description": "Timestamp when the incident todo was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.", + "format": "int32", + "maximum": 5, + "type": "integer" + } }, - "relationships": { - "description": "The incident's integration relationships from a response.", - "properties": { - "created_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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": [ + "integration_type", + "metadata" + ], + "type": "object" + }, + "id": { + "description": "The incident integration metadata's ID.", + "example": "00000000-0000-0000-1234-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident's integration relationships from a response.", + "properties": { + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "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 } - }, - "required": [ - "data" - ], - "type": "object" + } }, - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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": [ + "data" + ], + "type": "object" + }, + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "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 } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } }, - "type": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", - "enum": [ - "incident_integrations" - ], - "example": "incident_integrations", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" - ] - } + "type": "object" }, - "required": [ - "id", - "type" - ], - "type": "object" + "type": { + "default": "incident_integrations", + "description": "Integration metadata resource type.", + "enum": [ + "incident_integrations" + ], + "example": "incident_integrations", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_INTEGRATIONS" + ] + } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" }, "included": { "description": "Included related resources that the user requested.", @@ -232116,37 +238747,6 @@ }, "readOnly": true, "type": "array" - }, - "meta": { - "description": "The metadata object containing pagination metadata.", - "properties": { - "pagination": { - "description": "Pagination properties.", - "properties": { - "next_offset": { - "description": "The index of the first element in the next page of results. Equal to page size added to the current offset.", - "example": 1000, - "format": "int64", - "type": "integer" - }, - "offset": { - "description": "The index of the first element in the results.", - "example": 10, - "format": "int64", - "type": "integer" - }, - "size": { - "description": "Maximum size of pages to return.", - "example": 1000, - "format": "int64", - "type": "integer" - } - }, - "type": "object" - } - }, - "readOnly": true, - "type": "object" } }, "required": [ @@ -232310,25 +238910,19 @@ ] } ], - "summary": "Get a list of an incident's integration metadata", + "summary": "Get incident integration metadata details", "tags": [ "Incidents" ], - "x-menu-order": 9, - "x-permission": { - "operator": "OR", - "permissions": [ - "incident_read" - ] - }, + "x-menu-order": 11, "x-undo": { "type": "safe" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." }, - "post": { - "description": "Create an incident integration metadata.", - "operationId": "CreateIncidentIntegration", + "patch": { + "description": "Update an existing incident integration metadata.", + "operationId": "UpdateIncidentIntegration", "parameters": [ { "description": "The UUID of the incident.", @@ -232338,16 +238932,25 @@ "schema": { "type": "string" } + }, + { + "description": "The UUID of the incident integration metadata.", + "in": "path", + "name": "integration_metadata_id", + "required": true, + "schema": { + "type": "string" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "description": "Create request for an incident integration metadata.", + "description": "Patch request for an incident integration metadata.", "properties": { "data": { - "description": "Incident integration metadata data for a create request.", + "description": "Incident integration metadata data for a patch request.", "properties": { "attributes": { "description": "Incident integration metadata's attributes for a create request.", @@ -232565,7 +239168,7 @@ "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { @@ -233138,7 +239741,7 @@ } } }, - "description": "CREATED" + "description": "OK" }, "400": { "content": { @@ -233292,54 +239895,22 @@ ] } ], - "summary": "Create an incident integration metadata", + "summary": "Update an existing incident integration metadata", "tags": [ "Incidents" ], "x-codegen-request-body-name": "body", - "x-given": { - "incident_integration_metadata": { - "parameters": [ - { - "name": "incident_id", - "source": "incident.data.id" - }, - { - "name": "body", - "value": "{\n \"data\": {\n \"attributes\": {\n \"integration_type\": 1,\n \"incident_id\": \"{{ incident.data.id }}\",\n \"status\": 2,\n \"metadata\": {\n \"channels\": [\n {\n \"channel_id\": \"C0123456789\",\n \"team_id\": \"T01234567\",\n \"channel_name\": \"#example-channel-name\",\n \"redirect_url\": \"https://slack.com/app_redirect?channel=C0123456789&team=T01234567\"\n }\n ]\n }\n },\n \"type\": \"incident_integrations\"\n }\n}" - } - ], - "step": "the \"incident\" has an \"incident_integration_metadata\"" - } - }, - "x-menu-order": 10, - "x-permission": { - "operator": "OR", - "permissions": [ - "incident_write" - ] - }, + "x-menu-order": 12, "x-undo": { - "operationId": "DeleteIncidentIntegration", - "parameters": [ - { - "name": "incident_id", - "source": "data.attributes.incident_id" - }, - { - "name": "integration_metadata_id", - "source": "data.id" - } - ], - "type": "unsafe" + "type": "idempotent" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." } }, - "/api/v2/incidents/{incident_id}/relationships/integrations/{integration_metadata_id}": { - "delete": { - "description": "Delete an incident integration metadata.", - "operationId": "DeleteIncidentIntegration", + "/api/v2/incidents/{incident_id}/relationships/todos": { + "get": { + "description": "Get all todos for an incident.", + "operationId": "ListIncidentTodos", "parameters": [ { "description": "The UUID of the incident.", @@ -233349,19 +239920,535 @@ "schema": { "type": "string" } - }, - { - "description": "The UUID of the incident integration metadata.", - "in": "path", - "name": "integration_metadata_id", - "required": true, - "schema": { - "type": "string" - } } ], "responses": { - "204": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response with a list of incident todos.", + "properties": { + "data": { + "description": "An array of incident todos.", + "items": { + "description": "Incident todo response data.", + "properties": { + "attributes": { + "description": "Incident todo's attributes.", + "properties": { + "assignees": { + "description": "Array of todo assignees.", + "example": [ + "@test.user@test.com" + ], + "items": { + "description": "A todo assignee.", + "example": "@test.user@test.com", + "oneOf": [ + { + "description": "Assignee's @-handle.", + "example": "@test.user@test.com", + "type": "string" + }, + { + "description": "Anonymous assignee entity.", + "properties": { + "icon": { + "description": "URL for assignee's icon.", + "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", + "type": "string" + }, + "id": { + "description": "Anonymous assignee's ID.", + "example": "USLACKBOT", + "type": "string" + }, + "name": { + "description": "Assignee's name.", + "example": "Slackbot", + "type": "string" + }, + "source": { + "default": "slack", + "description": "The source of the anonymous assignee.", + "enum": [ + "slack", + "microsoft_teams" + ], + "example": "slack", + "type": "string", + "x-enum-varnames": [ + "SLACK", + "MICROSOFT_TEAMS" + ] + } + }, + "required": [ + "id", + "icon", + "name", + "source" + ], + "type": "object" + } + ] + }, + "type": "array" + }, + "completed": { + "description": "Timestamp when the todo was completed.", + "example": "2023-03-06T22:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "content": { + "description": "The follow-up task's content.", + "example": "Restore lost data.", + "type": "string" + }, + "created": { + "description": "Timestamp when the incident todo was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "due_date": { + "description": "Timestamp when the todo should be completed by.", + "example": "2023-07-10T05:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "incident_id": { + "description": "UUID of the incident this todo is connected to.", + "example": "00000000-aaaa-0000-0000-000000000000", + "type": "string" + }, + "modified": { + "description": "Timestamp when the incident todo was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "content", + "assignees" + ], + "type": "object" + }, + "id": { + "description": "The incident todo's ID.", + "example": "00000000-0000-0000-1234-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident's relationships from a response.", + "properties": { + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "default": "incident_todos", + "description": "Todo resource type.", + "enum": [ + "incident_todos" + ], + "example": "incident_todos", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TODOS" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Included related resources that the user requested.", + "items": { + "description": "An object related to an incident todo that is included in the response.", + "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 + } + } + ] + }, + "readOnly": true, + "type": "array" + }, + "meta": { + "description": "The metadata object containing pagination metadata.", + "properties": { + "pagination": { + "description": "Pagination properties.", + "properties": { + "next_offset": { + "description": "The index of the first element in the next page of results. Equal to page size added to the current offset.", + "example": 1000, + "format": "int64", + "type": "integer" + }, + "offset": { + "description": "The index of the first element in the results.", + "example": 10, + "format": "int64", + "type": "integer" + }, + "size": { + "description": "Maximum size of pages to return.", + "example": 1000, + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "readOnly": true, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, "description": "OK" }, "400": { @@ -233512,24 +240599,29 @@ }, { "AuthZ": [ - "incident_write" + "incident_read" ] } ], - "summary": "Delete an incident integration metadata", + "summary": "Get a list of an incident's todos", "tags": [ "Incidents" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 13, + "x-menu-order": 14, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_read" + ] + }, "x-undo": { - "type": "idempotent" + "type": "safe" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." }, - "get": { - "description": "Get incident integration metadata details.", - "operationId": "GetIncidentIntegration", + "post": { + "description": "Create an incident todo.", + "operationId": "CreateIncidentTodo", "parameters": [ { "description": "The UUID of the incident.", @@ -233539,219 +240631,270 @@ "schema": { "type": "string" } - }, - { - "description": "The UUID of the incident integration metadata.", - "in": "path", - "name": "integration_metadata_id", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Create request for an incident todo.", + "properties": { + "data": { + "description": "Incident todo data for a create request.", + "properties": { + "attributes": { + "description": "Incident todo's attributes.", + "properties": { + "assignees": { + "description": "Array of todo assignees.", + "example": [ + "@test.user@test.com" + ], + "items": { + "description": "A todo assignee.", + "example": "@test.user@test.com", + "oneOf": [ + { + "description": "Assignee's @-handle.", + "example": "@test.user@test.com", + "type": "string" + }, + { + "description": "Anonymous assignee entity.", + "properties": { + "icon": { + "description": "URL for assignee's icon.", + "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", + "type": "string" + }, + "id": { + "description": "Anonymous assignee's ID.", + "example": "USLACKBOT", + "type": "string" + }, + "name": { + "description": "Assignee's name.", + "example": "Slackbot", + "type": "string" + }, + "source": { + "default": "slack", + "description": "The source of the anonymous assignee.", + "enum": [ + "slack", + "microsoft_teams" + ], + "example": "slack", + "type": "string", + "x-enum-varnames": [ + "SLACK", + "MICROSOFT_TEAMS" + ] + } + }, + "required": [ + "id", + "icon", + "name", + "source" + ], + "type": "object" + } + ] + }, + "type": "array" + }, + "completed": { + "description": "Timestamp when the todo was completed.", + "example": "2023-03-06T22:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "content": { + "description": "The follow-up task's content.", + "example": "Restore lost data.", + "type": "string" + }, + "created": { + "description": "Timestamp when the incident todo was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "due_date": { + "description": "Timestamp when the todo should be completed by.", + "example": "2023-07-10T05:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "incident_id": { + "description": "UUID of the incident this todo is connected to.", + "example": "00000000-aaaa-0000-0000-000000000000", + "type": "string" + }, + "modified": { + "description": "Timestamp when the incident todo was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "content", + "assignees" + ], + "type": "object" + }, + "type": { + "default": "incident_todos", + "description": "Todo resource type.", + "enum": [ + "incident_todos" + ], + "example": "incident_todos", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TODOS" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Incident todo payload.", + "required": true + }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "description": "Response with an incident integration metadata.", + "description": "Response with an incident todo.", "properties": { "data": { - "description": "Incident integration metadata from a response.", + "description": "Incident todo response data.", "properties": { "attributes": { - "description": "Incident integration metadata's attributes for a create request.", + "description": "Incident todo's attributes.", "properties": { + "assignees": { + "description": "Array of todo assignees.", + "example": [ + "@test.user@test.com" + ], + "items": { + "description": "A todo assignee.", + "example": "@test.user@test.com", + "oneOf": [ + { + "description": "Assignee's @-handle.", + "example": "@test.user@test.com", + "type": "string" + }, + { + "description": "Anonymous assignee entity.", + "properties": { + "icon": { + "description": "URL for assignee's icon.", + "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", + "type": "string" + }, + "id": { + "description": "Anonymous assignee's ID.", + "example": "USLACKBOT", + "type": "string" + }, + "name": { + "description": "Assignee's name.", + "example": "Slackbot", + "type": "string" + }, + "source": { + "default": "slack", + "description": "The source of the anonymous assignee.", + "enum": [ + "slack", + "microsoft_teams" + ], + "example": "slack", + "type": "string", + "x-enum-varnames": [ + "SLACK", + "MICROSOFT_TEAMS" + ] + } + }, + "required": [ + "id", + "icon", + "name", + "source" + ], + "type": "object" + } + ] + }, + "type": "array" + }, + "completed": { + "description": "Timestamp when the todo was completed.", + "example": "2023-03-06T22:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "content": { + "description": "The follow-up task's content.", + "example": "Restore lost data.", + "type": "string" + }, "created": { "description": "Timestamp when the incident todo was created.", "format": "date-time", "readOnly": true, "type": "string" }, + "due_date": { + "description": "Timestamp when the todo should be completed by.", + "example": "2023-07-10T05:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, "incident_id": { - "description": "UUID of the incident this integration metadata is connected to.", + "description": "UUID of the incident this todo is connected to.", "example": "00000000-aaaa-0000-0000-000000000000", "type": "string" }, - "integration_type": { - "description": "A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.", - "example": 1, - "format": "int32", - "maximum": 9, - "type": "integer" - }, - "metadata": { - "description": "Incident integration metadata's metadata attribute.", - "oneOf": [ - { - "description": "Incident integration metadata for the Slack integration.", - "properties": { - "channels": { - "description": "Array of Slack channels in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Slack integration metadata channel array.", - "properties": { - "channel_id": { - "description": "Slack channel ID.", - "example": "C0123456789", - "type": "string" - }, - "channel_name": { - "description": "Name of the Slack channel.", - "example": "#example-channel-name", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Slack channel.", - "example": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", - "type": "string" - }, - "team_id": { - "description": "Slack team ID.", - "example": "T01234567", - "type": "string" - } - }, - "required": [ - "channel_id", - "channel_name", - "redirect_url" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "channels" - ], - "type": "object" - }, - { - "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" - }, - { - "description": "Incident integration metadata for the Microsoft Teams integration.", - "properties": { - "teams": { - "description": "Array of Microsoft Teams in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Microsoft Teams integration metadata teams array.", - "properties": { - "ms_channel_id": { - "description": "Microsoft Teams channel ID.", - "example": "19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2", - "type": "string" - }, - "ms_channel_name": { - "description": "Microsoft Teams channel name.", - "example": "incident-0001-example", - "type": "string" - }, - "ms_tenant_id": { - "description": "Microsoft Teams tenant ID.", - "example": "00000000-abcd-0005-0000-000000000000", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Microsoft Teams channel.", - "example": "https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000", - "type": "string" - } - }, - "required": [ - "ms_tenant_id", - "ms_channel_id", - "ms_channel_name", - "redirect_url" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "teams" - ], - "type": "object" - } - ] - }, "modified": { "description": "Timestamp when the incident todo was last modified.", "format": "date-time", "readOnly": true, "type": "string" - }, - "status": { - "description": "A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.", - "format": "int32", - "maximum": 5, - "type": "integer" } }, "required": [ - "integration_type", - "metadata" + "content", + "assignees" ], "type": "object" }, "id": { - "description": "The incident integration metadata's ID.", + "description": "The incident todo's ID.", "example": "00000000-0000-0000-1234-000000000000", "type": "string" }, "relationships": { - "description": "The incident's integration relationships from a response.", + "description": "The incident's relationships from a response.", "properties": { "created_by_user": { "description": "Relationship to user.", @@ -233835,15 +240978,15 @@ "type": "object" }, "type": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", + "default": "incident_todos", + "description": "Todo resource type.", "enum": [ - "incident_integrations" + "incident_todos" ], - "example": "incident_integrations", + "example": "incident_todos", "type": "string", "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" + "INCIDENT_TODOS" ] } }, @@ -233856,7 +240999,7 @@ "included": { "description": "Included related resources that the user requested.", "items": { - "description": "An object related to an incident integration metadata that is included in the response.", + "description": "An object related to an incident todo that is included in the response.", "oneOf": [ { "description": "User object returned by the API.", @@ -234124,7 +241267,7 @@ } } }, - "description": "OK" + "description": "CREATED" }, "400": { "content": { @@ -234274,23 +241417,58 @@ }, { "AuthZ": [ - "incident_read" + "incident_write" ] } ], - "summary": "Get incident integration metadata details", + "summary": "Create an incident todo", "tags": [ "Incidents" ], - "x-menu-order": 11, + "x-codegen-request-body-name": "body", + "x-given": { + "incident_todo": { + "parameters": [ + { + "name": "incident_id", + "source": "incident.data.id" + }, + { + "name": "body", + "value": "{\n \"data\": {\n \"attributes\": {\n \"content\": \"Follow up with customer about the impact they saw.\",\n \"assignees\": [\n \"@test.user@test.com\",\n {\n \"icon\": \"https://a.slack-edge.com/80588/img/slackbot_48.png\",\n \"id\": \"USLACKBOT\",\n \"name\": \"Slackbot\",\n \"source\": \"slack\"\n }\n ]\n },\n \"type\": \"incident_todos\"\n }\n}" + } + ], + "step": "the \"incident\" has an \"incident_todo\"" + } + }, + "x-menu-order": 15, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_write" + ] + }, "x-undo": { - "type": "safe" + "operationId": "DeleteIncidentTodo", + "parameters": [ + { + "name": "incident_id", + "source": "data.attributes.incident_id" + }, + { + "name": "todo_id", + "source": "data.id" + } + ], + "type": "unsafe" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - }, - "patch": { - "description": "Update an existing incident integration metadata.", - "operationId": "UpdateIncidentIntegration", + } + }, + "/api/v2/incidents/{incident_id}/relationships/todos/{todo_id}": { + "delete": { + "description": "Delete an incident todo.", + "operationId": "DeleteIncidentTodo", "parameters": [ { "description": "The UUID of the incident.", @@ -234302,441 +241480,330 @@ } }, { - "description": "The UUID of the incident integration metadata.", + "description": "The UUID of the incident todo.", "in": "path", - "name": "integration_metadata_id", + "name": "todo_id", "required": true, "schema": { "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "Patch request for an incident integration metadata.", - "properties": { - "data": { - "description": "Incident integration metadata data for a patch request.", - "properties": { - "attributes": { - "description": "Incident integration metadata's attributes for a create request.", - "properties": { - "created": { - "description": "Timestamp when the incident todo was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "incident_id": { - "description": "UUID of the incident this integration metadata is connected to.", - "example": "00000000-aaaa-0000-0000-000000000000", - "type": "string" - }, - "integration_type": { - "description": "A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.", - "example": 1, - "format": "int32", - "maximum": 9, - "type": "integer" - }, - "metadata": { - "description": "Incident integration metadata's metadata attribute.", - "oneOf": [ - { - "description": "Incident integration metadata for the Slack integration.", - "properties": { - "channels": { - "description": "Array of Slack channels in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Slack integration metadata channel array.", - "properties": { - "channel_id": { - "description": "Slack channel ID.", - "example": "C0123456789", - "type": "string" - }, - "channel_name": { - "description": "Name of the Slack channel.", - "example": "#example-channel-name", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Slack channel.", - "example": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", - "type": "string" - }, - "team_id": { - "description": "Slack team ID.", - "example": "T01234567", - "type": "string" - } - }, - "required": [ - "channel_id", - "channel_name", - "redirect_url" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "channels" - ], - "type": "object" - }, - { - "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" - }, - { - "description": "Incident integration metadata for the Microsoft Teams integration.", - "properties": { - "teams": { - "description": "Array of Microsoft Teams in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Microsoft Teams integration metadata teams array.", - "properties": { - "ms_channel_id": { - "description": "Microsoft Teams channel ID.", - "example": "19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2", - "type": "string" - }, - "ms_channel_name": { - "description": "Microsoft Teams channel name.", - "example": "incident-0001-example", - "type": "string" - }, - "ms_tenant_id": { - "description": "Microsoft Teams tenant ID.", - "example": "00000000-abcd-0005-0000-000000000000", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Microsoft Teams channel.", - "example": "https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000", - "type": "string" - } - }, - "required": [ - "ms_tenant_id", - "ms_channel_id", - "ms_channel_name", - "redirect_url" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "teams" - ], - "type": "object" - } - ] - }, - "modified": { - "description": "Timestamp when the incident todo was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "status": { - "description": "A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.", - "format": "int32", - "maximum": 5, - "type": "integer" - } - }, - "required": [ - "integration_type", - "metadata" - ], - "type": "object" + "responses": { + "204": { + "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": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", - "enum": [ - "incident_integrations" - ], - "example": "incident_integrations", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" - ] - } - }, - "required": [ - "type", - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } } - } + }, + "description": "Unauthorized" }, - "description": "Incident integration metadata payload.", - "required": true + "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": [ + "incident_write" + ] + } + ], + "summary": "Delete an incident todo", + "tags": [ + "Incidents" + ], + "x-menu-order": 18, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_write" + ] + }, + "x-undo": { + "type": "idempotent" }, + "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + }, + "get": { + "description": "Get incident todo details.", + "operationId": "GetIncidentTodo", + "parameters": [ + { + "description": "The UUID of the incident.", + "in": "path", + "name": "incident_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The UUID of the incident todo.", + "in": "path", + "name": "todo_id", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "content": { "application/json": { "schema": { - "description": "Response with an incident integration metadata.", + "description": "Response with an incident todo.", "properties": { "data": { - "description": "Incident integration metadata from a response.", + "description": "Incident todo response data.", "properties": { "attributes": { - "description": "Incident integration metadata's attributes for a create request.", + "description": "Incident todo's attributes.", "properties": { + "assignees": { + "description": "Array of todo assignees.", + "example": [ + "@test.user@test.com" + ], + "items": { + "description": "A todo assignee.", + "example": "@test.user@test.com", + "oneOf": [ + { + "description": "Assignee's @-handle.", + "example": "@test.user@test.com", + "type": "string" + }, + { + "description": "Anonymous assignee entity.", + "properties": { + "icon": { + "description": "URL for assignee's icon.", + "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", + "type": "string" + }, + "id": { + "description": "Anonymous assignee's ID.", + "example": "USLACKBOT", + "type": "string" + }, + "name": { + "description": "Assignee's name.", + "example": "Slackbot", + "type": "string" + }, + "source": { + "default": "slack", + "description": "The source of the anonymous assignee.", + "enum": [ + "slack", + "microsoft_teams" + ], + "example": "slack", + "type": "string", + "x-enum-varnames": [ + "SLACK", + "MICROSOFT_TEAMS" + ] + } + }, + "required": [ + "id", + "icon", + "name", + "source" + ], + "type": "object" + } + ] + }, + "type": "array" + }, + "completed": { + "description": "Timestamp when the todo was completed.", + "example": "2023-03-06T22:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "content": { + "description": "The follow-up task's content.", + "example": "Restore lost data.", + "type": "string" + }, "created": { "description": "Timestamp when the incident todo was created.", "format": "date-time", "readOnly": true, "type": "string" }, + "due_date": { + "description": "Timestamp when the todo should be completed by.", + "example": "2023-07-10T05:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, "incident_id": { - "description": "UUID of the incident this integration metadata is connected to.", + "description": "UUID of the incident this todo is connected to.", "example": "00000000-aaaa-0000-0000-000000000000", "type": "string" }, - "integration_type": { - "description": "A number indicating the type of integration this metadata is for. 1 indicates Slack;\n8 indicates Jira.", - "example": 1, - "format": "int32", - "maximum": 9, - "type": "integer" - }, - "metadata": { - "description": "Incident integration metadata's metadata attribute.", - "oneOf": [ - { - "description": "Incident integration metadata for the Slack integration.", - "properties": { - "channels": { - "description": "Array of Slack channels in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Slack integration metadata channel array.", - "properties": { - "channel_id": { - "description": "Slack channel ID.", - "example": "C0123456789", - "type": "string" - }, - "channel_name": { - "description": "Name of the Slack channel.", - "example": "#example-channel-name", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Slack channel.", - "example": "https://slack.com/app_redirect?channel=C0123456789&team=T01234567", - "type": "string" - }, - "team_id": { - "description": "Slack team ID.", - "example": "T01234567", - "type": "string" - } - }, - "required": [ - "channel_id", - "channel_name", - "redirect_url" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "channels" - ], - "type": "object" - }, - { - "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" - }, - { - "description": "Incident integration metadata for the Microsoft Teams integration.", - "properties": { - "teams": { - "description": "Array of Microsoft Teams in this integration metadata.", - "example": [], - "items": { - "description": "Item in the Microsoft Teams integration metadata teams array.", - "properties": { - "ms_channel_id": { - "description": "Microsoft Teams channel ID.", - "example": "19:abc00abcdef00a0abcdef0abcdef0a@thread.tacv2", - "type": "string" - }, - "ms_channel_name": { - "description": "Microsoft Teams channel name.", - "example": "incident-0001-example", - "type": "string" - }, - "ms_tenant_id": { - "description": "Microsoft Teams tenant ID.", - "example": "00000000-abcd-0005-0000-000000000000", - "type": "string" - }, - "redirect_url": { - "description": "URL redirecting to the Microsoft Teams channel.", - "example": "https://teams.microsoft.com/l/channel/19%3Aabc00abcdef00a0abcdef0abcdef0a%40thread.tacv2/conversations?groupId=12345678-abcd-dcba-abcd-1234567890ab&tenantId=00000000-abcd-0005-0000-000000000000", - "type": "string" - } - }, - "required": [ - "ms_tenant_id", - "ms_channel_id", - "ms_channel_name", - "redirect_url" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "teams" - ], - "type": "object" - } - ] - }, "modified": { "description": "Timestamp when the incident todo was last modified.", "format": "date-time", "readOnly": true, "type": "string" - }, - "status": { - "description": "A number indicating the status of this integration metadata. 0 indicates unknown;\n1 indicates pending; 2 indicates complete; 3 indicates manually created;\n4 indicates manually updated; 5 indicates failed.", - "format": "int32", - "maximum": 5, - "type": "integer" } }, "required": [ - "integration_type", - "metadata" + "content", + "assignees" ], "type": "object" }, "id": { - "description": "The incident integration metadata's ID.", + "description": "The incident todo's ID.", "example": "00000000-0000-0000-1234-000000000000", "type": "string" }, "relationships": { - "description": "The incident's integration relationships from a response.", + "description": "The incident's relationships from a response.", "properties": { "created_by_user": { "description": "Relationship to user.", @@ -234820,15 +241887,15 @@ "type": "object" }, "type": { - "default": "incident_integrations", - "description": "Integration metadata resource type.", + "default": "incident_todos", + "description": "Todo resource type.", "enum": [ - "incident_integrations" + "incident_todos" ], - "example": "incident_integrations", + "example": "incident_todos", "type": "string", "x-enum-varnames": [ - "INCIDENT_INTEGRATIONS" + "INCIDENT_TODOS" ] } }, @@ -234841,7 +241908,7 @@ "included": { "description": "Included related resources that the user requested.", "items": { - "description": "An object related to an incident integration metadata that is included in the response.", + "description": "An object related to an incident todo that is included in the response.", "oneOf": [ { "description": "User object returned by the API.", @@ -235259,26 +242326,29 @@ }, { "AuthZ": [ - "incident_write" + "incident_read" ] } ], - "summary": "Update an existing incident integration metadata", + "summary": "Get incident todo details", "tags": [ "Incidents" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 12, + "x-menu-order": 16, + "x-permission": { + "operator": "OR", + "permissions": [ + "incident_read" + ] + }, "x-undo": { - "type": "idempotent" + "type": "safe" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - } - }, - "/api/v2/incidents/{incident_id}/relationships/todos": { - "get": { - "description": "Get all todos for an incident.", - "operationId": "ListIncidentTodos", + }, + "patch": { + "description": "Update an incident todo.", + "operationId": "UpdateIncidentTodo", "parameters": [ { "description": "The UUID of the incident.", @@ -235288,232 +242358,379 @@ "schema": { "type": "string" } + }, + { + "description": "The UUID of the incident todo.", + "in": "path", + "name": "todo_id", + "required": true, + "schema": { + "type": "string" + } } ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "description": "Response with a list of incident todos.", - "properties": { - "data": { - "description": "An array of incident todos.", - "items": { - "description": "Incident todo response data.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Patch request for an incident todo.", + "properties": { + "data": { + "description": "Incident todo data for a patch request.", + "properties": { + "attributes": { + "description": "Incident todo's attributes.", "properties": { - "attributes": { - "description": "Incident todo's attributes.", - "properties": { - "assignees": { - "description": "Array of todo assignees.", - "example": [ - "@test.user@test.com" - ], - "items": { - "description": "A todo assignee.", + "assignees": { + "description": "Array of todo assignees.", + "example": [ + "@test.user@test.com" + ], + "items": { + "description": "A todo assignee.", + "example": "@test.user@test.com", + "oneOf": [ + { + "description": "Assignee's @-handle.", "example": "@test.user@test.com", - "oneOf": [ - { - "description": "Assignee's @-handle.", - "example": "@test.user@test.com", + "type": "string" + }, + { + "description": "Anonymous assignee entity.", + "properties": { + "icon": { + "description": "URL for assignee's icon.", + "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", "type": "string" }, - { - "description": "Anonymous assignee entity.", - "properties": { - "icon": { - "description": "URL for assignee's icon.", - "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", - "type": "string" - }, - "id": { - "description": "Anonymous assignee's ID.", - "example": "USLACKBOT", - "type": "string" - }, - "name": { - "description": "Assignee's name.", - "example": "Slackbot", - "type": "string" - }, - "source": { - "default": "slack", - "description": "The source of the anonymous assignee.", - "enum": [ - "slack", - "microsoft_teams" - ], - "example": "slack", - "type": "string", - "x-enum-varnames": [ - "SLACK", - "MICROSOFT_TEAMS" - ] - } - }, - "required": [ - "id", - "icon", - "name", - "source" + "id": { + "description": "Anonymous assignee's ID.", + "example": "USLACKBOT", + "type": "string" + }, + "name": { + "description": "Assignee's name.", + "example": "Slackbot", + "type": "string" + }, + "source": { + "default": "slack", + "description": "The source of the anonymous assignee.", + "enum": [ + "slack", + "microsoft_teams" ], - "type": "object" + "example": "slack", + "type": "string", + "x-enum-varnames": [ + "SLACK", + "MICROSOFT_TEAMS" + ] } - ] - }, - "type": "array" - }, - "completed": { - "description": "Timestamp when the todo was completed.", - "example": "2023-03-06T22:00:00.000000+00:00", - "nullable": true, - "type": "string" - }, - "content": { - "description": "The follow-up task's content.", - "example": "Restore lost data.", - "type": "string" - }, - "created": { - "description": "Timestamp when the incident todo was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "due_date": { - "description": "Timestamp when the todo should be completed by.", - "example": "2023-07-10T05:00:00.000000+00:00", - "nullable": true, - "type": "string" - }, - "incident_id": { - "description": "UUID of the incident this todo is connected to.", - "example": "00000000-aaaa-0000-0000-000000000000", - "type": "string" - }, - "modified": { - "description": "Timestamp when the incident todo was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - } + }, + "required": [ + "id", + "icon", + "name", + "source" + ], + "type": "object" + } + ] }, - "required": [ - "content", - "assignees" - ], - "type": "object" + "type": "array" }, - "id": { - "description": "The incident todo's ID.", - "example": "00000000-0000-0000-1234-000000000000", + "completed": { + "description": "Timestamp when the todo was completed.", + "example": "2023-03-06T22:00:00.000000+00:00", + "nullable": true, "type": "string" }, - "relationships": { - "description": "The incident's relationships from a response.", - "properties": { - "created_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "description": "Relationship to user object.", + "content": { + "description": "The follow-up task's content.", + "example": "Restore lost data.", + "type": "string" + }, + "created": { + "description": "Timestamp when the incident todo was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "due_date": { + "description": "Timestamp when the todo should be completed by.", + "example": "2023-07-10T05:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "incident_id": { + "description": "UUID of the incident this todo is connected to.", + "example": "00000000-aaaa-0000-0000-000000000000", + "type": "string" + }, + "modified": { + "description": "Timestamp when the incident todo was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "content", + "assignees" + ], + "type": "object" + }, + "type": { + "default": "incident_todos", + "description": "Todo resource type.", + "enum": [ + "incident_todos" + ], + "example": "incident_todos", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TODOS" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Incident todo payload.", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response with an incident todo.", + "properties": { + "data": { + "description": "Incident todo response data.", + "properties": { + "attributes": { + "description": "Incident todo's attributes.", + "properties": { + "assignees": { + "description": "Array of todo assignees.", + "example": [ + "@test.user@test.com" + ], + "items": { + "description": "A todo assignee.", + "example": "@test.user@test.com", + "oneOf": [ + { + "description": "Assignee's @-handle.", + "example": "@test.user@test.com", + "type": "string" + }, + { + "description": "Anonymous assignee entity.", "properties": { + "icon": { + "description": "URL for assignee's icon.", + "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", + "type": "string" + }, "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", + "description": "Anonymous assignee's ID.", + "example": "USLACKBOT", "type": "string" }, - "type": { - "default": "users", - "description": "Users resource type.", + "name": { + "description": "Assignee's name.", + "example": "Slackbot", + "type": "string" + }, + "source": { + "default": "slack", + "description": "The source of the anonymous assignee.", "enum": [ - "users" + "slack", + "microsoft_teams" ], - "example": "users", + "example": "slack", "type": "string", "x-enum-varnames": [ - "USERS" + "SLACK", + "MICROSOFT_TEAMS" ] } }, "required": [ "id", - "type" + "icon", + "name", + "source" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } - }, - "required": [ - "data" - ], - "type": "object" + ] }, - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "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" - ] - } + "type": "array" + }, + "completed": { + "description": "Timestamp when the todo was completed.", + "example": "2023-03-06T22:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "content": { + "description": "The follow-up task's content.", + "example": "Restore lost data.", + "type": "string" + }, + "created": { + "description": "Timestamp when the incident todo was created.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "due_date": { + "description": "Timestamp when the todo should be completed by.", + "example": "2023-07-10T05:00:00.000000+00:00", + "nullable": true, + "type": "string" + }, + "incident_id": { + "description": "UUID of the incident this todo is connected to.", + "example": "00000000-aaaa-0000-0000-000000000000", + "type": "string" + }, + "modified": { + "description": "Timestamp when the incident todo was last modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "content", + "assignees" + ], + "type": "object" + }, + "id": { + "description": "The incident todo's ID.", + "example": "00000000-0000-0000-1234-000000000000", + "type": "string" + }, + "relationships": { + "description": "The incident's relationships from a response.", + "properties": { + "created_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "description": "Relationship to user object.", + "properties": { + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", + "type": "string" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false + "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 } - }, - "required": [ - "data" - ], - "type": "object" - } + } + }, + "required": [ + "data" + ], + "type": "object" }, - "type": "object" + "last_modified_by_user": { + "description": "Relationship to user.", + "properties": { + "data": { + "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 + } + } + }, + "required": [ + "data" + ], + "type": "object" + } }, - "type": { - "default": "incident_todos", - "description": "Todo resource type.", - "enum": [ - "incident_todos" - ], - "example": "incident_todos", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_TODOS" - ] - } + "type": "object" }, - "required": [ - "id", - "type" - ], - "type": "object" + "type": { + "default": "incident_todos", + "description": "Todo resource type.", + "enum": [ + "incident_todos" + ], + "example": "incident_todos", + "type": "string", + "x-enum-varnames": [ + "INCIDENT_TODOS" + ] + } }, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" }, "included": { "description": "Included related resources that the user requested.", @@ -235762,52 +242979,21 @@ "users" ], "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false - } - } - ] - }, - "readOnly": true, - "type": "array" - }, - "meta": { - "description": "The metadata object containing pagination metadata.", - "properties": { - "pagination": { - "description": "Pagination properties.", - "properties": { - "next_offset": { - "description": "The index of the first element in the next page of results. Equal to page size added to the current offset.", - "example": 1000, - "format": "int64", - "type": "integer" - }, - "offset": { - "description": "The index of the first element in the results.", - "example": 10, - "format": "int64", - "type": "integer" + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } }, - "size": { - "description": "Maximum size of pages to return.", - "example": 1000, - "format": "int64", - "type": "integer" + "type": "object", + "x-merge-override": { + "required": false } - }, - "type": "object" - } + } + ] }, "readOnly": true, - "type": "object" + "type": "array" } }, "required": [ @@ -235967,168 +243153,867 @@ }, { "AuthZ": [ - "incident_read" + "incident_write" ] } ], - "summary": "Get a list of an incident's todos", + "summary": "Update an incident todo", "tags": [ "Incidents" ], - "x-menu-order": 14, + "x-codegen-request-body-name": "body", + "x-menu-order": 17, "x-permission": { "operator": "OR", "permissions": [ - "incident_read" + "incident_write" ] }, "x-undo": { - "type": "safe" + "type": "idempotent" }, "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." - }, - "post": { - "description": "Create an incident todo.", - "operationId": "CreateIncidentTodo", + } + }, + "/api/v2/integration/aws/accounts": { + "get": { + "description": "Get a list of AWS Account Integration Configs.", + "operationId": "ListAWSAccounts", "parameters": [ { - "description": "The UUID of the incident.", - "in": "path", - "name": "incident_id", - "required": true, + "description": "Optional query filter accounts by AWS Account ID", + "example": "123456789012", + "in": "query", + "name": "aws_account_id", + "required": false, "schema": { "type": "string" } } ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "AWS Accounts response body", + "properties": { + "data": { + "description": "List of AWS Account Integration Configs", + "items": { + "description": "AWS Account Response body", + "properties": { + "attributes": { + "description": "The AWS Account Integration Config", + "properties": { + "account_tags": { + "description": "Tags to apply to all metrics in the account", + "items": { + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" + } + ] + }, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "created_at": { + "description": "Timestamp of when the account integration was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "logs_config": { + "description": "AWS Logs config", + "properties": { + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "metrics_config": { + "description": "AWS Metrics config", + "properties": { + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "modified_at": { + "description": "Timestamp of when the account integration was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + } + }, + "type": "object" + } + }, + "required": [ + "aws_account_id" + ], + "type": "object" + }, + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "type": { + "default": "account", + "description": "AWS Account resource type.", + "enum": [ + "account" + ], + "example": "account", + "type": "string", + "x-enum-varnames": [ + "ACCOUNT" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "AWS Accounts List object" + }, + "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": { + "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" + } + }, + "summary": "List all AWS integrations", + "tags": [ + "AWS Integration" + ], + "x-menu-order": 1, + "x-permission": { + "operator": "OR", + "permissions": [ + "aws_configuration_read" + ] + }, + "x-undo": { + "type": "safe" + }, + "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + }, + "post": { + "description": "Create a new AWS Account Integration Config.", + "operationId": "CreateAWSAccount", "requestBody": { "content": { "application/json": { "schema": { - "description": "Create request for an incident todo.", + "description": "AWS Account Create Request body", "properties": { "data": { - "description": "Incident todo data for a create request.", + "description": "AWS Account Create Request data", "properties": { "attributes": { - "description": "Incident todo's attributes.", + "description": "The AWS Account Integration Config to be created", "properties": { - "assignees": { - "description": "Array of todo assignees.", - "example": [ - "@test.user@test.com" - ], + "account_tags": { + "description": "Tags to apply to all metrics in the account", "items": { - "description": "A todo assignee.", - "example": "@test.user@test.com", - "oneOf": [ - { - "description": "Assignee's @-handle.", - "example": "@test.user@test.com", - "type": "string" + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } }, - { - "description": "Anonymous assignee entity.", - "properties": { - "icon": { - "description": "URL for assignee's icon.", - "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" + } + ] + }, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", "type": "string" }, - "id": { - "description": "Anonymous assignee's ID.", - "example": "USLACKBOT", + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "logs_config": { + "description": "AWS Logs config", + "properties": { + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" }, - "name": { - "description": "Assignee's name.", - "example": "Slackbot", + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", "type": "string" }, - "source": { - "default": "slack", - "description": "The source of the anonymous assignee.", - "enum": [ - "slack", - "microsoft_teams" - ], - "example": "slack", - "type": "string", - "x-enum-varnames": [ - "SLACK", - "MICROSOFT_TEAMS" - ] + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "metrics_config": { + "description": "AWS Metrics config", + "properties": { + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" } }, - "required": [ - "id", - "icon", - "name", - "source" - ], "type": "object" - } - ] + }, + "type": "array" + } }, - "type": "array" - }, - "completed": { - "description": "Timestamp when the todo was completed.", - "example": "2023-03-06T22:00:00.000000+00:00", - "nullable": true, - "type": "string" - }, - "content": { - "description": "The follow-up task's content.", - "example": "Restore lost data.", - "type": "string" - }, - "created": { - "description": "Timestamp when the incident todo was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "due_date": { - "description": "Timestamp when the todo should be completed by.", - "example": "2023-07-10T05:00:00.000000+00:00", - "nullable": true, - "type": "string" + "type": "object" }, - "incident_id": { - "description": "UUID of the incident this todo is connected to.", - "example": "00000000-aaaa-0000-0000-000000000000", - "type": "string" + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" }, - "modified": { - "description": "Timestamp when the incident todo was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + } + }, + "type": "object" } }, "required": [ - "content", - "assignees" + "aws_account_id", + "aws_partition", + "auth_config" ], "type": "object" }, "type": { - "default": "incident_todos", - "description": "Todo resource type.", + "default": "account", + "description": "AWS Account resource type.", "enum": [ - "incident_todos" + "account" ], - "example": "incident_todos", + "example": "account", "type": "string", "x-enum-varnames": [ - "INCIDENT_TODOS" + "ACCOUNT" ] } }, "required": [ - "type", - "attributes" + "attributes", + "type" ], "type": "object" } @@ -236140,492 +244025,383 @@ } } }, - "description": "Incident todo payload.", "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "description": "Response with an incident todo.", + "description": "AWS Account response body", "properties": { "data": { - "description": "Incident todo response data.", + "description": "AWS Account Response body", "properties": { "attributes": { - "description": "Incident todo's attributes.", + "description": "The AWS Account Integration Config", "properties": { - "assignees": { - "description": "Array of todo assignees.", - "example": [ - "@test.user@test.com" - ], + "account_tags": { + "description": "Tags to apply to all metrics in the account", "items": { - "description": "A todo assignee.", - "example": "@test.user@test.com", - "oneOf": [ - { - "description": "Assignee's @-handle.", - "example": "@test.user@test.com", - "type": "string" - }, - { - "description": "Anonymous assignee entity.", - "properties": { - "icon": { - "description": "URL for assignee's icon.", - "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", - "type": "string" - }, - "id": { - "description": "Anonymous assignee's ID.", - "example": "USLACKBOT", - "type": "string" - }, - "name": { - "description": "Assignee's name.", - "example": "Slackbot", - "type": "string" - }, - "source": { - "default": "slack", - "description": "The source of the anonymous assignee.", - "enum": [ - "slack", - "microsoft_teams" - ], - "example": "slack", - "type": "string", - "x-enum-varnames": [ - "SLACK", - "MICROSOFT_TEAMS" - ] - } - }, - "required": [ - "id", - "icon", - "name", - "source" - ], - "type": "object" - } - ] + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" }, - "type": "array" - }, - "completed": { - "description": "Timestamp when the todo was completed.", - "example": "2023-03-06T22:00:00.000000+00:00", - "nullable": true, - "type": "string" - }, - "content": { - "description": "The follow-up task's content.", - "example": "Restore lost data.", - "type": "string" - }, - "created": { - "description": "Timestamp when the incident todo was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "due_date": { - "description": "Timestamp when the todo should be completed by.", - "example": "2023-07-10T05:00:00.000000+00:00", "nullable": true, - "type": "string" - }, - "incident_id": { - "description": "UUID of the incident this todo is connected to.", - "example": "00000000-aaaa-0000-0000-000000000000", - "type": "string" + "type": "array" }, - "modified": { - "description": "Timestamp when the incident todo was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - } - }, - "required": [ - "content", - "assignees" - ], - "type": "object" - }, - "id": { - "description": "The incident todo's ID.", - "example": "00000000-0000-0000-1234-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident's relationships from a response.", - "properties": { - "created_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "description": "Relationship to user object.", + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "writeOnly": true } }, "required": [ - "id", - "type" + "access_key_id" ], - "type": "object", - "x-merge-override": { - "required": false - } - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "last_modified_by_user": { - "description": "Relationship to user.", - "properties": { - "data": { - "description": "Relationship to user object.", + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", + "external_id": { + "description": "AWS IAM External ID for associated role", "type": "string" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" } }, "required": [ - "id", - "type" + "role_name" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } - }, - "required": [ - "data" + ] + }, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "default": "incident_todos", - "description": "Todo resource type.", - "enum": [ - "incident_todos" - ], - "example": "incident_todos", - "type": "string", - "x-enum-varnames": [ - "INCIDENT_TODOS" - ] - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "included": { - "description": "Included related resources that the user requested.", - "items": { - "description": "An object related to an incident todo that is included in the response.", - "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" + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } }, - "status": { - "description": "Status of the user.", - "type": "string" + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } }, - "title": { - "description": "Title of the user.", - "nullable": true, - "type": "string" + "required": [ + "include_only" + ] + } + ] + }, + "created_at": { + "description": "Timestamp of when the account integration was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "logs_config": { + "description": "AWS Logs config", + "properties": { + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" + } }, - "verified": { - "description": "Whether the user is verified.", - "type": "boolean" - } - }, - "type": "object" - }, - "id": { - "description": "ID of the user.", - "type": "string" + "type": "object" + } }, - "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": "object" + }, + "metrics_config": { + "description": "AWS Metrics config", + "properties": { + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", "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": [ + "exclude_only" + ] }, - "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" - } + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] }, - "required": [ - "data" - ], - "type": "object" - }, - "other_users": { - "description": "Relationship to users.", + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", "properties": { - "data": { - "description": "Relationships to user objects.", - "example": [], + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", "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 - } + "example": "key:value", + "type": "string" }, + "nullable": true, "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": "array" + } + }, + "type": "object" + }, + "modified_at": { + "description": "Timestamp of when the account integration was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" }, - "type": "object", - "x-merge-override": { - "properties": false + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" } }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } + "type": "object" }, - "type": "object", - "x-merge-override": { - "required": false + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + } + }, + "type": "object" } - } - ] + }, + "required": [ + "aws_account_id" + ], + "type": "object" + }, + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, + "type": { + "default": "account", + "description": "AWS Account resource type.", + "enum": [ + "account" + ], + "example": "account", + "type": "string", + "x-enum-varnames": [ + "ACCOUNT" + ] + } }, - "readOnly": true, - "type": "array" + "required": [ + "id", + "type" + ], + "type": "object" } }, "required": [ @@ -236635,7 +244411,7 @@ } } }, - "description": "CREATED" + "description": "AWS Account object" }, "400": { "content": { @@ -236665,34 +244441,6 @@ }, "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": { @@ -236721,7 +244469,7 @@ }, "description": "Forbidden" }, - "404": { + "409": { "content": { "application/json": { "schema": { @@ -236747,7 +244495,7 @@ } } }, - "description": "Not Found" + "description": "Conflict" }, "429": { "content": { @@ -236778,79 +244526,51 @@ "description": "Too many requests" } }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "incident_write" - ] - } - ], - "summary": "Create an incident todo", + "summary": "Create an AWS integration", "tags": [ - "Incidents" + "AWS Integration" ], "x-codegen-request-body-name": "body", "x-given": { - "incident_todo": { + "aws_account_v2": { "parameters": [ - { - "name": "incident_id", - "source": "incident.data.id" - }, { "name": "body", - "value": "{\n \"data\": {\n \"attributes\": {\n \"content\": \"Follow up with customer about the impact they saw.\",\n \"assignees\": [\n \"@test.user@test.com\",\n {\n \"icon\": \"https://a.slack-edge.com/80588/img/slackbot_48.png\",\n \"id\": \"USLACKBOT\",\n \"name\": \"Slackbot\",\n \"source\": \"slack\"\n }\n ]\n },\n \"type\": \"incident_todos\"\n }\n}" + "value": "{\n \"data\": {\n \"type\": \"account\",\n \"attributes\": {\n \"account_tags\": [\n \"key:value\"\n ],\n \"auth_config\": {\n \"role_name\": \"DatadogIntegrationRole\"\n },\n \"aws_account_id\": \"123456789012\",\n \"aws_partition\": \"aws\",\n \"aws_regions\": {\n \"include_only\": [\n \"us-east-1\"\n ]\n },\n \"logs_config\": {\n \"lambda_forwarder\": {\n \"lambdas\": [\n \"arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder\"\n ],\n \"sources\": [\n \"s3\"\n ]\n }\n },\n \"metrics_config\": {\n \"enabled\": true,\n \"automute_enabled\": true,\n \"collect_custom_metrics\": false,\n \"collect_cloudwatch_alarms\": false,\n \"tag_filters\": [\n {\n \"namespace\": \"AWS/EC2\",\n \"tags\": [\n \"key:value\"\n ]\n }\n ],\n \"namespace_filters\": {\n \"include_only\": [\n \"AWS/EC2\"\n ]\n }\n },\n \"resources_config\": {\n \"cloud_security_posture_management_collection\": false,\n \"extended_collection\": false\n },\n \"traces_config\": {\n \"xray_services\": {\n \"include_only\": [\n \"AWS/AppSync\"\n ]\n }\n }\n }\n }\n}" } ], - "step": "the \"incident\" has an \"incident_todo\"" + "step": "there is a valid \"aws_account_v2\" in the system" } }, - "x-menu-order": 15, + "x-menu-order": 2, "x-permission": { "operator": "OR", "permissions": [ - "incident_write" + "aws_configurations_manage" ] }, "x-undo": { - "operationId": "DeleteIncidentTodo", + "operationId": "DeleteAWSAccount", "parameters": [ { - "name": "incident_id", - "source": "data.attributes.incident_id" - }, - { - "name": "todo_id", + "name": "aws_account_config_id", "source": "data.id" } ], "type": "unsafe" }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" } }, - "/api/v2/incidents/{incident_id}/relationships/todos/{todo_id}": { + "/api/v2/integration/aws/accounts/{aws_account_config_id}": { "delete": { - "description": "Delete an incident todo.", - "operationId": "DeleteIncidentTodo", + "description": "Delete an AWS Account Integration Config", + "operationId": "DeleteAWSAccount", "parameters": [ { - "description": "The UUID of the incident.", - "in": "path", - "name": "incident_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The UUID of the incident todo.", + "description": "Unique Datadog ID of the AWS Account Integration Config", "in": "path", - "name": "todo_id", + "name": "aws_account_config_id", "required": true, "schema": { "type": "string" @@ -236859,7 +244579,7 @@ ], "responses": { "204": { - "description": "OK" + "description": "No Content" }, "400": { "content": { @@ -236889,34 +244609,6 @@ }, "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": { @@ -237002,50 +244694,30 @@ "description": "Too many requests" } }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "incident_write" - ] - } - ], - "summary": "Delete an incident todo", + "summary": "Delete an AWS integration", "tags": [ - "Incidents" + "AWS Integration" ], - "x-menu-order": 18, + "x-menu-order": 4, "x-permission": { "operator": "OR", "permissions": [ - "incident_write" + "aws_configurations_manage" ] }, "x-undo": { "type": "idempotent" }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" }, "get": { - "description": "Get incident todo details.", - "operationId": "GetIncidentTodo", + "description": "Get an AWS Account Integration Config", + "operationId": "GetAWSAccount", "parameters": [ { - "description": "The UUID of the incident.", - "in": "path", - "name": "incident_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The UUID of the incident todo.", + "description": "Unique Datadog ID of the AWS Account Integration Config", "in": "path", - "name": "todo_id", + "name": "aws_account_config_id", "required": true, "schema": { "type": "string" @@ -237057,213 +244729,368 @@ "content": { "application/json": { "schema": { - "description": "Response with an incident todo.", + "description": "AWS Account response body", "properties": { "data": { - "description": "Incident todo response data.", + "description": "AWS Account Response body", "properties": { "attributes": { - "description": "Incident todo's attributes.", + "description": "The AWS Account Integration Config", "properties": { - "assignees": { - "description": "Array of todo assignees.", - "example": [ - "@test.user@test.com" - ], + "account_tags": { + "description": "Tags to apply to all metrics in the account", "items": { - "description": "A todo assignee.", - "example": "@test.user@test.com", - "oneOf": [ - { - "description": "Assignee's @-handle.", - "example": "@test.user@test.com", - "type": "string" - }, - { - "description": "Anonymous assignee entity.", - "properties": { - "icon": { - "description": "URL for assignee's icon.", - "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", - "type": "string" - }, - "id": { - "description": "Anonymous assignee's ID.", - "example": "USLACKBOT", - "type": "string" - }, - "name": { - "description": "Assignee's name.", - "example": "Slackbot", - "type": "string" - }, - "source": { - "default": "slack", - "description": "The source of the anonymous assignee.", - "enum": [ - "slack", - "microsoft_teams" - ], - "example": "slack", - "type": "string", - "x-enum-varnames": [ - "SLACK", - "MICROSOFT_TEAMS" - ] - } - }, - "required": [ - "id", - "icon", - "name", - "source" - ], - "type": "object" - } - ] + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" }, - "type": "array" - }, - "completed": { - "description": "Timestamp when the todo was completed.", - "example": "2023-03-06T22:00:00.000000+00:00", "nullable": true, - "type": "string" + "type": "array" }, - "content": { - "description": "The follow-up task's content.", - "example": "Restore lost data.", - "type": "string" + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" + } + ] }, - "created": { - "description": "Timestamp when the incident todo was created.", - "format": "date-time", - "readOnly": true, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", "type": "string" }, - "due_date": { - "description": "Timestamp when the todo should be completed by.", - "example": "2023-07-10T05:00:00.000000+00:00", - "nullable": true, - "type": "string" + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] }, - "incident_id": { - "description": "UUID of the incident this todo is connected to.", - "example": "00000000-aaaa-0000-0000-000000000000", - "type": "string" + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] }, - "modified": { - "description": "Timestamp when the incident todo was last modified.", + "created_at": { + "description": "Timestamp of when the account integration was created", "format": "date-time", "readOnly": true, "type": "string" - } - }, - "required": [ - "content", - "assignees" - ], - "type": "object" - }, - "id": { - "description": "The incident todo's ID.", - "example": "00000000-0000-0000-1234-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident's relationships from a response.", - "properties": { - "created_by_user": { - "description": "Relationship to user.", + }, + "logs_config": { + "description": "AWS Logs config", "properties": { - "data": { - "description": "Relationship to user object.", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, - "required": [ - "data" - ], "type": "object" }, - "last_modified_by_user": { - "description": "Relationship to user.", + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "data": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" ] } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" + } + }, + "type": "object" + }, + "modified_at": { + "description": "Timestamp of when the account integration was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] } }, - "required": [ - "data" - ], "type": "object" } }, + "required": [ + "aws_account_id" + ], "type": "object" }, + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, "type": { - "default": "incident_todos", - "description": "Todo resource type.", + "default": "account", + "description": "AWS Account resource type.", "enum": [ - "incident_todos" + "account" ], - "example": "incident_todos", + "example": "account", "type": "string", "x-enum-varnames": [ - "INCIDENT_TODOS" + "ACCOUNT" ] } }, @@ -237272,269 +245099,6 @@ "type" ], "type": "object" - }, - "included": { - "description": "Included related resources that the user requested.", - "items": { - "description": "An object related to an incident todo that is included in the response.", - "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 - } - } - ] - }, - "readOnly": true, - "type": "array" } }, "required": [ @@ -237544,7 +245108,7 @@ } } }, - "description": "OK" + "description": "AWS Account object" }, "400": { "content": { @@ -237574,34 +245138,6 @@ }, "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": { @@ -237687,50 +245223,30 @@ "description": "Too many requests" } }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "incident_read" - ] - } - ], - "summary": "Get incident todo details", + "summary": "Get an AWS integration by config ID", "tags": [ - "Incidents" + "AWS Integration" ], - "x-menu-order": 16, + "x-menu-order": 3, "x-permission": { "operator": "OR", "permissions": [ - "incident_read" + "aws_configuration_read" ] }, "x-undo": { "type": "safe" }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" }, "patch": { - "description": "Update an incident todo.", - "operationId": "UpdateIncidentTodo", + "description": "Update an AWS Account Integration Config", + "operationId": "UpdateAWSAccount", "parameters": [ { - "description": "The UUID of the incident.", - "in": "path", - "name": "incident_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The UUID of the incident todo.", + "description": "Unique Datadog ID of the AWS Account Integration Config", "in": "path", - "name": "todo_id", + "name": "aws_account_config_id", "required": true, "schema": { "type": "string" @@ -237741,130 +245257,362 @@ "content": { "application/json": { "schema": { - "description": "Patch request for an incident todo.", + "description": "AWS Account Update Request body", "properties": { "data": { - "description": "Incident todo data for a patch request.", + "description": "AWS Account Update Request data", "properties": { "attributes": { - "description": "Incident todo's attributes.", + "description": "The AWS Account Integration Config to be updated", "properties": { - "assignees": { - "description": "Array of todo assignees.", - "example": [ - "@test.user@test.com" - ], + "account_tags": { + "description": "Tags to apply to all metrics in the account", "items": { - "description": "A todo assignee.", - "example": "@test.user@test.com", - "oneOf": [ - { - "description": "Assignee's @-handle.", - "example": "@test.user@test.com", - "type": "string" + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } }, - { - "description": "Anonymous assignee entity.", - "properties": { - "icon": { - "description": "URL for assignee's icon.", - "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" + } + ] + }, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", + "type": "string" + }, + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] + }, + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", "type": "string" }, - "id": { - "description": "Anonymous assignee's ID.", - "example": "USLACKBOT", + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "logs_config": { + "description": "AWS Logs config", + "properties": { + "lambda_forwarder": { + "description": "AWS Lambda forwarder", + "properties": { + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" }, - "name": { - "description": "Assignee's name.", - "example": "Slackbot", + "type": "array" + }, + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", "type": "string" }, - "source": { - "default": "slack", - "description": "The source of the anonymous assignee.", - "enum": [ - "slack", - "microsoft_teams" - ], - "example": "slack", - "type": "string", - "x-enum-varnames": [ - "SLACK", - "MICROSOFT_TEAMS" - ] + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "metrics_config": { + "description": "AWS Metrics config", + "properties": { + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] + }, + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" } }, - "required": [ - "id", - "icon", - "name", - "source" - ], "type": "object" - } - ] + }, + "type": "array" + } }, - "type": "array" - }, - "completed": { - "description": "Timestamp when the todo was completed.", - "example": "2023-03-06T22:00:00.000000+00:00", - "nullable": true, - "type": "string" - }, - "content": { - "description": "The follow-up task's content.", - "example": "Restore lost data.", - "type": "string" - }, - "created": { - "description": "Timestamp when the incident todo was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "due_date": { - "description": "Timestamp when the todo should be completed by.", - "example": "2023-07-10T05:00:00.000000+00:00", - "nullable": true, - "type": "string" + "type": "object" }, - "incident_id": { - "description": "UUID of the incident this todo is connected to.", - "example": "00000000-aaaa-0000-0000-000000000000", - "type": "string" + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" }, - "modified": { - "description": "Timestamp when the incident todo was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] + } + }, + "type": "object" } }, "required": [ - "content", - "assignees" + "aws_account_id" ], "type": "object" }, + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, "type": { - "default": "incident_todos", - "description": "Todo resource type.", + "default": "account", + "description": "AWS Account resource type.", "enum": [ - "incident_todos" + "account" ], - "example": "incident_todos", + "example": "account", "type": "string", "x-enum-varnames": [ - "INCIDENT_TODOS" + "ACCOUNT" ] } }, "required": [ - "type", - "attributes" + "attributes", + "type" ], "type": "object" } @@ -237876,7 +245624,6 @@ } } }, - "description": "Incident todo payload.", "required": true }, "responses": { @@ -237884,213 +245631,368 @@ "content": { "application/json": { "schema": { - "description": "Response with an incident todo.", + "description": "AWS Account response body", "properties": { "data": { - "description": "Incident todo response data.", + "description": "AWS Account Response body", "properties": { "attributes": { - "description": "Incident todo's attributes.", + "description": "The AWS Account Integration Config", "properties": { - "assignees": { - "description": "Array of todo assignees.", - "example": [ - "@test.user@test.com" - ], + "account_tags": { + "description": "Tags to apply to all metrics in the account", "items": { - "description": "A todo assignee.", - "example": "@test.user@test.com", - "oneOf": [ - { - "description": "Assignee's @-handle.", - "example": "@test.user@test.com", - "type": "string" - }, - { - "description": "Anonymous assignee entity.", - "properties": { - "icon": { - "description": "URL for assignee's icon.", - "example": "https://a.slack-edge.com/80588/img/slackbot_48.png", - "type": "string" - }, - "id": { - "description": "Anonymous assignee's ID.", - "example": "USLACKBOT", - "type": "string" - }, - "name": { - "description": "Assignee's name.", - "example": "Slackbot", - "type": "string" - }, - "source": { - "default": "slack", - "description": "The source of the anonymous assignee.", - "enum": [ - "slack", - "microsoft_teams" - ], - "example": "slack", - "type": "string", - "x-enum-varnames": [ - "SLACK", - "MICROSOFT_TEAMS" - ] - } - }, - "required": [ - "id", - "icon", - "name", - "source" - ], - "type": "object" - } - ] + "description": "Tag to apply to all metrics in the account", + "example": "key:value", + "type": "string" }, - "type": "array" - }, - "completed": { - "description": "Timestamp when the todo was completed.", - "example": "2023-03-06T22:00:00.000000+00:00", "nullable": true, - "type": "string" + "type": "array" }, - "content": { - "description": "The follow-up task's content.", - "example": "Restore lost data.", - "type": "string" + "auth_config": { + "description": "AWS Authentication config", + "oneOf": [ + { + "description": "AWS Authentication config for key-based account", + "properties": { + "access_key_id": { + "description": "AWS Access Key ID", + "example": "AKIAIOSFODNN7EXAMPLE", + "type": "string" + }, + "secret_access_key": { + "description": "AWS Secret Access Key", + "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "minLength": 1, + "type": "string", + "writeOnly": true + } + }, + "required": [ + "access_key_id" + ], + "type": "object" + }, + { + "description": "AWS Authentication config for role-based account", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "type": "string" + }, + "role_name": { + "description": "AWS IAM Role name", + "example": "DatadogIntegrationRole", + "maxLength": 576, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "role_name" + ], + "type": "object" + } + ] }, - "created": { - "description": "Timestamp when the incident todo was created.", - "format": "date-time", - "readOnly": true, + "aws_account_id": { + "description": "AWS Account ID", + "example": "123456789012", "type": "string" }, - "due_date": { - "description": "Timestamp when the todo should be completed by.", - "example": "2023-07-10T05:00:00.000000+00:00", - "nullable": true, - "type": "string" + "aws_partition": { + "default": "aws", + "description": "AWS Account partition", + "enum": [ + "aws", + "aws-cn", + "aws-us-gov" + ], + "example": "aws", + "type": "string", + "x-enum-varnames": [ + "AWS", + "AWS_CN", + "AWS_US_GOV" + ] }, - "incident_id": { - "description": "UUID of the incident this todo is connected to.", - "example": "00000000-aaaa-0000-0000-000000000000", - "type": "string" + "aws_regions": { + "description": "AWS Regions to collect data from", + "oneOf": [ + { + "description": "Include all regions", + "properties": { + "include_all": { + "description": "Include all regions", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these regions", + "properties": { + "include_only": { + "description": "Include only these regions", + "example": [ + "us-east-1" + ], + "items": { + "example": "us-east-1", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] }, - "modified": { - "description": "Timestamp when the incident todo was last modified.", + "created_at": { + "description": "Timestamp of when the account integration was created", "format": "date-time", "readOnly": true, "type": "string" - } - }, - "required": [ - "content", - "assignees" - ], - "type": "object" - }, - "id": { - "description": "The incident todo's ID.", - "example": "00000000-0000-0000-1234-000000000000", - "type": "string" - }, - "relationships": { - "description": "The incident's relationships from a response.", - "properties": { - "created_by_user": { - "description": "Relationship to user.", + }, + "logs_config": { + "description": "AWS Logs config", "properties": { - "data": { - "description": "Relationship to user object.", + "lambda_forwarder": { + "description": "AWS Lambda forwarder", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + "lambdas": { + "description": "List of Datadog Lambda Log Forwarder ARNs", + "items": { + "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", + "type": "string" + }, + "type": "array" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "sources": { + "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" } }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } }, - "required": [ - "data" - ], "type": "object" }, - "last_modified_by_user": { - "description": "Relationship to user.", + "metrics_config": { + "description": "AWS Metrics config", "properties": { - "data": { - "description": "Relationship to user object.", - "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", - "type": "string" + "automute_enabled": { + "description": "Enable EC2 automute for AWS metrics", + "example": true, + "type": "boolean" + }, + "collect_cloudwatch_alarms": { + "description": "Enable CloudWatch alarms collection", + "example": true, + "type": "boolean" + }, + "collect_custom_metrics": { + "description": "Enable custom metrics collection", + "example": true, + "type": "boolean" + }, + "enabled": { + "description": "Enable AWS metrics collection", + "example": true, + "type": "boolean" + }, + "namespace_filters": { + "description": "AWS Metrics namespace filters", + "oneOf": [ + { + "description": "Exclude all namespaces", + "properties": { + "exclude_all": { + "description": "Exclude all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "exclude_all" + ] }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" + { + "description": "Exclude only these namespaces", + "properties": { + "exclude_only": { + "description": "Exclude only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "exclude_only" + ] + }, + { + "description": "Include all namespaces", + "properties": { + "include_all": { + "description": "Include all namespaces", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these namespaces", + "properties": { + "include_only": { + "description": "Include only these namespaces", + "example": [ + "AWS/EC2" + ], + "items": { + "example": "AWS/EC2", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" ] } + ] + }, + "tag_filters": { + "description": "AWS Metrics tag filters list", + "items": { + "description": "AWS Metrics tag filters", + "properties": { + "namespace": { + "description": "The AWS Namespace to apply the tag filters against", + "example": "AWS/EC2", + "type": "string" + }, + "tags": { + "description": "The tags to filter based on", + "items": { + "example": "key:value", + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "type": "object" }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" + } + }, + "type": "object" + }, + "modified_at": { + "description": "Timestamp of when the account integration was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "resources_config": { + "description": "AWS Resources config", + "properties": { + "cloud_security_posture_management_collection": { + "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "example": false, + "type": "boolean" + }, + "extended_collection": { + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "traces_config": { + "description": "AWS Traces config", + "properties": { + "xray_services": { + "description": "AWS X-Ray services to collect traces from", + "oneOf": [ + { + "description": "Include all services", + "properties": { + "include_all": { + "description": "Include all services", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services", + "nullable": true, + "properties": { + "include_only": { + "description": "Include only these services", + "example": [ + "AWS/AppSync" + ], + "items": { + "example": "AWS/AppSync", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "include_only" + ] + } + ] } }, - "required": [ - "data" - ], "type": "object" } }, + "required": [ + "aws_account_id" + ], "type": "object" }, + "id": { + "description": "Unique Datadog ID of the AWS Account Integration Config", + "example": "00000000-abcd-0001-0000-000000000000", + "type": "string" + }, "type": { - "default": "incident_todos", - "description": "Todo resource type.", + "default": "account", + "description": "AWS Account resource type.", "enum": [ - "incident_todos" + "account" ], - "example": "incident_todos", + "example": "account", "type": "string", "x-enum-varnames": [ - "INCIDENT_TODOS" + "ACCOUNT" ] } }, @@ -238099,281 +246001,74 @@ "type" ], "type": "object" - }, - "included": { - "description": "Included related resources that the user requested.", + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "AWS Account object" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], "items": { - "description": "An object related to an incident todo that is included in the response.", - "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": "A list of items.", + "example": "Bad Request", + "type": "string" }, - "readOnly": true, "type": "array" } }, "required": [ - "data" + "errors" ], "type": "object" } } }, - "description": "OK" + "description": "Bad Request" }, - "400": { + "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": { @@ -238399,9 +246094,9 @@ } } }, - "description": "Bad Request" + "description": "Not Found" }, - "401": { + "429": { "content": { "application/json": { "schema": { @@ -238427,7 +246122,95 @@ } } }, - "description": "Unauthorized" + "description": "Too many requests" + } + }, + "summary": "Update an AWS integration", + "tags": [ + "AWS Integration" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 5, + "x-permission": { + "operator": "OR", + "permissions": [ + "aws_configuration_edit" + ] + }, + "x-undo": { + "type": "idempotent" + }, + "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + } + }, + "/api/v2/integration/aws/available_namespaces": { + "get": { + "description": "Get a list of available AWS CloudWatch namespaces that can send metrics to Datadog.", + "operationId": "ListAWSNamespaces", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "AWS Namespaces response body", + "properties": { + "data": { + "description": "AWS Namespaces response body", + "properties": { + "attributes": { + "description": "AWS Namespaces response body", + "properties": { + "namespaces": { + "description": "AWS CloudWatch namespace", + "example": [ + "AWS/ApiGateway" + ], + "items": { + "example": "AWS/ApiGateway", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "namespaces" + ], + "type": "object" + }, + "id": { + "default": "namespaces", + "description": "The `AWSNamespacesResponseData` `id`.", + "example": "namespaces", + "type": "string" + }, + "type": { + "default": "namespaces", + "description": "The `AWSNamespacesResponseData` `type`.", + "enum": [ + "namespaces" + ], + "example": "namespaces", + "type": "string", + "x-enum-varnames": [ + "NAMESPACES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "AWS Namespaces List object" }, "403": { "content": { @@ -238457,7 +246240,7 @@ }, "description": "Forbidden" }, - "404": { + "429": { "content": { "application/json": { "schema": { @@ -238483,7 +246266,116 @@ } } }, - "description": "Not Found" + "description": "Too many requests" + } + }, + "summary": "List available namespaces", + "tags": [ + "AWS Integration" + ], + "x-menu-order": 1, + "x-permission": { + "operator": "OR", + "permissions": [ + "aws_configuration_read" + ] + }, + "x-undo": { + "type": "safe" + }, + "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + } + }, + "/api/v2/integration/aws/generate_new_external_id": { + "post": { + "description": "Generate a new external ID for AWS role-based authentication.", + "operationId": "CreateNewAWSExternalID", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "AWS External ID response body", + "properties": { + "data": { + "description": "AWS External ID response body", + "properties": { + "attributes": { + "description": "AWS External ID response body", + "properties": { + "external_id": { + "description": "AWS IAM External ID for associated role", + "example": "acb8f6b8a844443dbb726d07dcb1a870", + "type": "string" + } + }, + "required": [ + "external_id" + ], + "type": "object" + }, + "id": { + "default": "external_id", + "description": "The `AWSNewExternalIDResponseData` `id`.", + "example": "external_id", + "type": "string" + }, + "type": { + "default": "external_id", + "description": "The `AWSNewExternalIDResponseData` `type`.", + "enum": [ + "external_id" + ], + "example": "external_id", + "type": "string", + "x-enum-varnames": [ + "EXTERNAL_ID" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "AWS External ID object" + }, + "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": { "content": { @@ -238514,33 +246406,164 @@ "description": "Too many requests" } }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] + "summary": "Generate a new external ID", + "tags": [ + "AWS Integration" + ], + "x-menu-order": 2, + "x-permission": { + "operator": "OR", + "permissions": [ + "aws_configuration_edit" + ] + }, + "x-undo": { + "type": "safe" + }, + "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + } + }, + "/api/v2/integration/aws/logs/services": { + "get": { + "description": "Get a list of AWS services that can send logs to Datadog.", + "operationId": "ListAWSLogsServices", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "AWS Logs Services response body", + "properties": { + "data": { + "description": "AWS Logs Services response body", + "properties": { + "attributes": { + "description": "AWS Logs Services response body", + "properties": { + "logs_services": { + "description": "List of AWS services that can send logs to Datadog", + "example": [ + "s3" + ], + "items": { + "example": "s3", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "logs_services" + ], + "type": "object" + }, + "id": { + "default": "logs_services", + "description": "The `AWSLogsServicesResponseData` `id`.", + "example": "logs_services", + "type": "string" + }, + "type": { + "default": "logs_services", + "description": "The `AWSLogsServicesResponseData` `type`.", + "enum": [ + "logs_services" + ], + "example": "logs_services", + "type": "string", + "x-enum-varnames": [ + "LOGS_SERVICES" + ] + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "AWS Logs Services List object" }, - { - "AuthZ": [ - "incident_write" - ] + "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": { + "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" } - ], - "summary": "Update an incident todo", + }, + "summary": "Get list of AWS log ready services", "tags": [ - "Incidents" + "AWS Logs Integration" ], - "x-codegen-request-body-name": "body", - "x-menu-order": 17, + "x-menu-order": 1, "x-permission": { "operator": "OR", "permissions": [ - "incident_write" + "aws_configuration_read" ] }, "x-undo": { - "type": "idempotent" + "type": "safe" }, - "x-unstable": "**Note**: This endpoint is in public beta.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)." + "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" } }, "/api/v2/integration/gcp/accounts": { @@ -346634,6 +354657,17 @@ }, "name": "APM Retention Filters" }, + { + "description": "Configure your Datadog-AWS integration directly through the Datadog API.\nFor more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services).", + "name": "AWS Integration" + }, + { + "description": "Configure your Datadog-AWS-Logs integration directly through Datadog API.\nFor more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection).", + "externalDocs": { + "url": "https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection" + }, + "name": "AWS Logs Integration" + }, { "description": "Search your Audit Logs events over HTTP.", "name": "Audit"