diff --git a/.apigentools-info b/.apigentools-info index 90779306664ec..f6af6cd84ec50 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2025-01-03 18:09:57.558169", - "spec_repo_commit": "08abd462" + "regenerated": "2025-01-03 20:19:59.864429", + "spec_repo_commit": "659ee894" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2025-01-03 18:10:05.557943", - "spec_repo_commit": "08abd462" + "regenerated": "2025-01-03 20:20:07.977785", + "spec_repo_commit": "659ee894" } } } \ No newline at end of file diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 5fc3e3c8b430a..d236260b2b515 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -4540,6 +4540,58 @@ menu: - ListApmRetentionFilters unstable: [] order: 1 + - name: Action Connection + url: /api/latest/action-connection/ + identifier: action-connection + generated: true + - name: Update an existing Action Connection + url: '#update-an-existing-action-connection' + identifier: action-connection-update-an-existing-action-connection + parent: action-connection + generated: true + params: + versions: + - v2 + operationids: + - UpdateActionConnection + unstable: [] + order: 3 + - name: Get an existing Action Connection + url: '#get-an-existing-action-connection' + identifier: action-connection-get-an-existing-action-connection + parent: action-connection + generated: true + params: + versions: + - v2 + operationids: + - GetActionConnection + unstable: [] + order: 1 + - name: Delete an existing Action Connection + url: '#delete-an-existing-action-connection' + identifier: action-connection-delete-an-existing-action-connection + parent: action-connection + generated: true + params: + versions: + - v2 + operationids: + - DeleteActionConnection + unstable: [] + order: 4 + - name: Create a new Action Connection + url: '#create-a-new-action-connection' + identifier: action-connection-create-a-new-action-connection + parent: action-connection + generated: true + params: + versions: + - v2 + operationids: + - CreateActionConnection + unstable: [] + order: 2 - name: Audit url: /api/latest/audit/ identifier: audit diff --git a/content/en/api/latest/action-connection/_index.md b/content/en/api/latest/action-connection/_index.md new file mode 100644 index 0000000000000..5e8129a2fbb0d --- /dev/null +++ b/content/en/api/latest/action-connection/_index.md @@ -0,0 +1,3 @@ +--- +title: Action Connection +--- diff --git a/content/en/api/v2/action-connection/_index.md b/content/en/api/v2/action-connection/_index.md new file mode 100644 index 0000000000000..5ff39fda189dd --- /dev/null +++ b/content/en/api/v2/action-connection/_index.md @@ -0,0 +1,4 @@ +--- +title: Action Connection +headless: true +--- diff --git a/content/en/api/v2/action-connection/examples.json b/content/en/api/v2/action-connection/examples.json new file mode 100644 index 0000000000000..adaa89b4e681d --- /dev/null +++ b/content/en/api/v2/action-connection/examples.json @@ -0,0 +1,260 @@ +{ + "CreateActionConnection": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "integration": { + "credentials": { + "account_id": "111222333444", + "external_id": "33a1011635c44b38a064cf14e82e1d8f", + "principal_id": "123456789012", + "role": "my-role", + "type": "AWSAssumeRole" + }, + "type": "AWS" + }, + "name": "My AWS Connection" + }, + "id": "string", + "type": "action_connection" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data related to the connection.

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

attributes [required]

\n
\n

object

\n

The definition of ActionConnectionAttributes object.

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

integration [required]

\n
\n

 <oneOf>

\n

The definition of ActionConnectionIntegration object.

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

Option 1

\n
\n

object

\n

The definition of AWSIntegration object.

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

credentials [required]

\n
\n

 <oneOf>

\n

The definition of AWSCredentials object.

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

Option 1

\n
\n

object

\n

The definition of AWSAssumeRole object.

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

account_id [required]

\n
\n

string

\n

AWS account the connection is created for

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

external_id

\n
\n

string

\n

External ID used to scope which connection can be used to assume the role

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

principal_id

\n
\n

string

\n

AWS account that will assume the role

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

role [required]

\n
\n

string

\n

Role to assume

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

type [required]

\n
\n

enum

\n

The definition of AWSAssumeRoleType object. \nAllowed enum values: AWSAssumeRole

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

type [required]

\n
\n

enum

\n

The definition of AWSIntegrationType object. \nAllowed enum values: AWS

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

Option 2

\n
\n

object

\n

The definition of HTTPIntegration object.

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

base_url [required]

\n
\n

string

\n

Base HTTP url for the integration

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

credentials [required]

\n
\n

 <oneOf>

\n

The definition of HTTPCredentials object.

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

Option 1

\n
\n

object

\n

The definition of HTTPTokenAuth object.

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

body

\n
\n

object

\n

The definition of HTTPBody object.

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

content

\n
\n

string

\n

Serialized body content

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

content_type

\n
\n

string

\n

Content type of the body

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

headers

\n
\n

[object]

\n

The HTTPTokenAuth headers.

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

name [required]

\n
\n

string

\n

The HTTPHeader name.

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

value [required]

\n
\n

string

\n

The HTTPHeader value.

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

tokens

\n
\n

[object]

\n

The HTTPTokenAuth tokens.

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

name [required]

\n
\n

string

\n

The HTTPToken name.

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

type [required]

\n
\n

enum

\n

The definition of TokenType object. \nAllowed enum values: SECRET

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

value [required]

\n
\n

string

\n

The HTTPToken value.

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

type [required]

\n
\n

enum

\n

The definition of HTTPTokenAuthType object. \nAllowed enum values: HTTPTokenAuth

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

url_parameters

\n
\n

[object]

\n

The HTTPTokenAuth url_parameters.

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

name [required]

\n
\n

string

\n

Name for tokens.

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

value [required]

\n
\n

string

\n

The UrlParam value.

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

type [required]

\n
\n

enum

\n

The definition of HTTPIntegrationType object. \nAllowed enum values: HTTP

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

name [required]

\n
\n

string

\n

Name of the connection

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

id

\n
\n

string

\n

The connection identifier

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

type [required]

\n
\n

enum

\n

The definition of ActionConnectionDataType object. \nAllowed enum values: action_connection

\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
" + }, + "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": { + "integration": {}, + "name": "My AWS Connection" + }, + "type": "action_connection" + } + }, + "json": { + "data": { + "attributes": { + "integration": { + "credentials": { + "account_id": "111222333444", + "role": "my-role", + "type": "AWSAssumeRole" + }, + "type": "AWS" + }, + "name": "My AWS Connection" + }, + "type": "action_connection" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the connection.

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

attributes [required]

\n
\n

object

\n

The definition of ActionConnectionAttributes object.

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

integration [required]

\n
\n

 <oneOf>

\n

The definition of ActionConnectionIntegration object.

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

Option 1

\n
\n

object

\n

The definition of AWSIntegration object.

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

credentials [required]

\n
\n

 <oneOf>

\n

The definition of AWSCredentials object.

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

Option 1

\n
\n

object

\n

The definition of AWSAssumeRole object.

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

account_id [required]

\n
\n

string

\n

AWS account the connection is created for

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

external_id

\n
\n

string

\n

External ID used to scope which connection can be used to assume the role

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

principal_id

\n
\n

string

\n

AWS account that will assume the role

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

role [required]

\n
\n

string

\n

Role to assume

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

type [required]

\n
\n

enum

\n

The definition of AWSAssumeRoleType object. \nAllowed enum values: AWSAssumeRole

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

type [required]

\n
\n

enum

\n

The definition of AWSIntegrationType object. \nAllowed enum values: AWS

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

Option 2

\n
\n

object

\n

The definition of HTTPIntegration object.

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

base_url [required]

\n
\n

string

\n

Base HTTP url for the integration

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

credentials [required]

\n
\n

 <oneOf>

\n

The definition of HTTPCredentials object.

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

Option 1

\n
\n

object

\n

The definition of HTTPTokenAuth object.

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

body

\n
\n

object

\n

The definition of HTTPBody object.

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

content

\n
\n

string

\n

Serialized body content

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

content_type

\n
\n

string

\n

Content type of the body

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

headers

\n
\n

[object]

\n

The HTTPTokenAuth headers.

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

name [required]

\n
\n

string

\n

The HTTPHeader name.

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

value [required]

\n
\n

string

\n

The HTTPHeader value.

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

tokens

\n
\n

[object]

\n

The HTTPTokenAuth tokens.

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

name [required]

\n
\n

string

\n

The HTTPToken name.

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

type [required]

\n
\n

enum

\n

The definition of TokenType object. \nAllowed enum values: SECRET

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

value [required]

\n
\n

string

\n

The HTTPToken value.

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

type [required]

\n
\n

enum

\n

The definition of HTTPTokenAuthType object. \nAllowed enum values: HTTPTokenAuth

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

url_parameters

\n
\n

[object]

\n

The HTTPTokenAuth url_parameters.

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

name [required]

\n
\n

string

\n

Name for tokens.

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

value [required]

\n
\n

string

\n

The UrlParam value.

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

type [required]

\n
\n

enum

\n

The definition of HTTPIntegrationType object. \nAllowed enum values: HTTP

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

name [required]

\n
\n

string

\n

Name of the connection

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

id

\n
\n

string

\n

The connection identifier

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

type [required]

\n
\n

enum

\n

The definition of ActionConnectionDataType object. \nAllowed enum values: action_connection

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteActionConnection": { + "responses": { + "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": "" + } + }, + "GetActionConnection": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "integration": { + "credentials": { + "account_id": "111222333444", + "external_id": "33a1011635c44b38a064cf14e82e1d8f", + "principal_id": "123456789012", + "role": "my-role", + "type": "AWSAssumeRole" + }, + "type": "AWS" + }, + "name": "My AWS Connection" + }, + "id": "string", + "type": "action_connection" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data related to the connection.

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

attributes [required]

\n
\n

object

\n

The definition of ActionConnectionAttributes object.

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

integration [required]

\n
\n

 <oneOf>

\n

The definition of ActionConnectionIntegration object.

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

Option 1

\n
\n

object

\n

The definition of AWSIntegration object.

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

credentials [required]

\n
\n

 <oneOf>

\n

The definition of AWSCredentials object.

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

Option 1

\n
\n

object

\n

The definition of AWSAssumeRole object.

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

account_id [required]

\n
\n

string

\n

AWS account the connection is created for

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

external_id

\n
\n

string

\n

External ID used to scope which connection can be used to assume the role

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

principal_id

\n
\n

string

\n

AWS account that will assume the role

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

role [required]

\n
\n

string

\n

Role to assume

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

type [required]

\n
\n

enum

\n

The definition of AWSAssumeRoleType object. \nAllowed enum values: AWSAssumeRole

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

type [required]

\n
\n

enum

\n

The definition of AWSIntegrationType object. \nAllowed enum values: AWS

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

Option 2

\n
\n

object

\n

The definition of HTTPIntegration object.

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

base_url [required]

\n
\n

string

\n

Base HTTP url for the integration

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

credentials [required]

\n
\n

 <oneOf>

\n

The definition of HTTPCredentials object.

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

Option 1

\n
\n

object

\n

The definition of HTTPTokenAuth object.

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

body

\n
\n

object

\n

The definition of HTTPBody object.

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

content

\n
\n

string

\n

Serialized body content

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

content_type

\n
\n

string

\n

Content type of the body

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

headers

\n
\n

[object]

\n

The HTTPTokenAuth headers.

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

name [required]

\n
\n

string

\n

The HTTPHeader name.

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

value [required]

\n
\n

string

\n

The HTTPHeader value.

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

tokens

\n
\n

[object]

\n

The HTTPTokenAuth tokens.

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

name [required]

\n
\n

string

\n

The HTTPToken name.

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

type [required]

\n
\n

enum

\n

The definition of TokenType object. \nAllowed enum values: SECRET

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

value [required]

\n
\n

string

\n

The HTTPToken value.

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

type [required]

\n
\n

enum

\n

The definition of HTTPTokenAuthType object. \nAllowed enum values: HTTPTokenAuth

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

url_parameters

\n
\n

[object]

\n

The HTTPTokenAuth url_parameters.

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

name [required]

\n
\n

string

\n

Name for tokens.

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

value [required]

\n
\n

string

\n

The UrlParam value.

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

type [required]

\n
\n

enum

\n

The definition of HTTPIntegrationType object. \nAllowed enum values: HTTP

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

name [required]

\n
\n

string

\n

Name of the connection

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

id

\n
\n

string

\n

The connection identifier

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

type [required]

\n
\n

enum

\n

The definition of ActionConnectionDataType object. \nAllowed enum values: action_connection

\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": "" + } + }, + "UpdateActionConnection": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "integration": { + "credentials": { + "account_id": "111222333444", + "external_id": "33a1011635c44b38a064cf14e82e1d8f", + "principal_id": "123456789012", + "role": "my-role", + "type": "AWSAssumeRole" + }, + "type": "AWS" + }, + "name": "My AWS Connection" + }, + "id": "string", + "type": "action_connection" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data related to the connection.

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

attributes [required]

\n
\n

object

\n

The definition of ActionConnectionAttributes object.

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

integration [required]

\n
\n

 <oneOf>

\n

The definition of ActionConnectionIntegration object.

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

Option 1

\n
\n

object

\n

The definition of AWSIntegration object.

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

credentials [required]

\n
\n

 <oneOf>

\n

The definition of AWSCredentials object.

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

Option 1

\n
\n

object

\n

The definition of AWSAssumeRole object.

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

account_id [required]

\n
\n

string

\n

AWS account the connection is created for

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

external_id

\n
\n

string

\n

External ID used to scope which connection can be used to assume the role

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

principal_id

\n
\n

string

\n

AWS account that will assume the role

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

role [required]

\n
\n

string

\n

Role to assume

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

type [required]

\n
\n

enum

\n

The definition of AWSAssumeRoleType object. \nAllowed enum values: AWSAssumeRole

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

type [required]

\n
\n

enum

\n

The definition of AWSIntegrationType object. \nAllowed enum values: AWS

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

Option 2

\n
\n

object

\n

The definition of HTTPIntegration object.

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

base_url [required]

\n
\n

string

\n

Base HTTP url for the integration

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

credentials [required]

\n
\n

 <oneOf>

\n

The definition of HTTPCredentials object.

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

Option 1

\n
\n

object

\n

The definition of HTTPTokenAuth object.

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

body

\n
\n

object

\n

The definition of HTTPBody object.

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

content

\n
\n

string

\n

Serialized body content

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

content_type

\n
\n

string

\n

Content type of the body

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

headers

\n
\n

[object]

\n

The HTTPTokenAuth headers.

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

name [required]

\n
\n

string

\n

The HTTPHeader name.

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

value [required]

\n
\n

string

\n

The HTTPHeader value.

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

tokens

\n
\n

[object]

\n

The HTTPTokenAuth tokens.

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

name [required]

\n
\n

string

\n

The HTTPToken name.

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

type [required]

\n
\n

enum

\n

The definition of TokenType object. \nAllowed enum values: SECRET

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

value [required]

\n
\n

string

\n

The HTTPToken value.

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

type [required]

\n
\n

enum

\n

The definition of HTTPTokenAuthType object. \nAllowed enum values: HTTPTokenAuth

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

url_parameters

\n
\n

[object]

\n

The HTTPTokenAuth url_parameters.

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

name [required]

\n
\n

string

\n

Name for tokens.

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

value [required]

\n
\n

string

\n

The UrlParam value.

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

type [required]

\n
\n

enum

\n

The definition of HTTPIntegrationType object. \nAllowed enum values: HTTP

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

name [required]

\n
\n

string

\n

Name of the connection

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

id

\n
\n

string

\n

The connection identifier

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

type [required]

\n
\n

enum

\n

The definition of ActionConnectionDataType object. \nAllowed enum values: action_connection

\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": {}, + "type": "action_connection" + } + }, + "json": { + "data": { + "attributes": { + "integration": { + "credentials": { + "account_id": "111222333444", + "generate_new_external_id": false, + "role": "my-role", + "type": "AWSAssumeRole" + }, + "type": "AWS" + }, + "name": "My AWS Connection" + }, + "type": "action_connection" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the connection update.

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

attributes [required]

\n
\n

object

\n

The definition of ActionConnectionAttributesUpdate object.

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

integration

\n
\n

 <oneOf>

\n

The definition of ActionConnectionIntegrationUpdate object.

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

Option 1

\n
\n

object

\n

The definition of AWSIntegrationUpdate object.

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

credentials

\n
\n

 <oneOf>

\n

The definition of AWSCredentialsUpdate object.

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

Option 1

\n
\n

object

\n

The definition of AWSAssumeRoleUpdate object.

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

account_id

\n
\n

string

\n

AWS account the connection is created for

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

generate_new_external_id

\n
\n

boolean

\n

The AWSAssumeRoleUpdate generate_new_external_id.

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

role

\n
\n

string

\n

Role to assume

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

type [required]

\n
\n

enum

\n

The definition of AWSAssumeRoleType object. \nAllowed enum values: AWSAssumeRole

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

type [required]

\n
\n

enum

\n

The definition of AWSIntegrationType object. \nAllowed enum values: AWS

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

Option 2

\n
\n

object

\n

The definition of HTTPIntegrationUpdate object.

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

base_url

\n
\n

string

\n

Base HTTP url for the integration

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

credentials

\n
\n

 <oneOf>

\n

The definition of HTTPCredentialsUpdate object.

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

Option 1

\n
\n

object

\n

The definition of HTTPTokenAuthUpdate object.

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

body

\n
\n

object

\n

The definition of HTTPBody object.

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

content

\n
\n

string

\n

Serialized body content

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

content_type

\n
\n

string

\n

Content type of the body

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

headers

\n
\n

[object]

\n

The HTTPTokenAuthUpdate headers.

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

deleted

\n
\n

boolean

\n

Should the header be deleted.

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

name [required]

\n
\n

string

\n

The HTTPHeaderUpdate name.

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

value

\n
\n

string

\n

The HTTPHeaderUpdate value.

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

tokens

\n
\n

[object]

\n

The HTTPTokenAuthUpdate tokens.

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

deleted

\n
\n

boolean

\n

Should the header be deleted.

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

name [required]

\n
\n

string

\n

The HTTPToken name.

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

type [required]

\n
\n

enum

\n

The definition of TokenType object. \nAllowed enum values: SECRET

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

value [required]

\n
\n

string

\n

The HTTPToken value.

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

type [required]

\n
\n

enum

\n

The definition of HTTPTokenAuthType object. \nAllowed enum values: HTTPTokenAuth

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

url_parameters

\n
\n

[object]

\n

The HTTPTokenAuthUpdate url_parameters.

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

deleted

\n
\n

boolean

\n

Should the header be deleted.

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

name [required]

\n
\n

string

\n

Name for tokens.

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

value

\n
\n

string

\n

The UrlParamUpdate value.

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

type [required]

\n
\n

enum

\n

The definition of HTTPIntegrationType object. \nAllowed enum values: HTTP

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

name

\n
\n

string

\n

Name of the connection

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

type [required]

\n
\n

enum

\n

The definition of ActionConnectionDataType object. \nAllowed enum values: action_connection

\n
\n \n
\n
\n
\n
" + } + } +} \ No newline at end of file diff --git a/content/en/api/v2/action-connection/request.CreateActionConnection.json b/content/en/api/v2/action-connection/request.CreateActionConnection.json new file mode 100644 index 0000000000000..0fe2682684700 --- /dev/null +++ b/content/en/api/v2/action-connection/request.CreateActionConnection.json @@ -0,0 +1,16 @@ +{ + "data": { + "type": "action_connection", + "attributes": { + "name": "Cassette Connection DELETE_ME", + "integration": { + "type": "AWS", + "credentials": { + "type": "AWSAssumeRole", + "role": "MyRoleUpdated", + "account_id": "123456789123" + } + } + } + } +} \ No newline at end of file diff --git a/content/en/api/v2/action-connection/request.UpdateActionConnection.json b/content/en/api/v2/action-connection/request.UpdateActionConnection.json new file mode 100644 index 0000000000000..b219f4ae127fa --- /dev/null +++ b/content/en/api/v2/action-connection/request.UpdateActionConnection.json @@ -0,0 +1,16 @@ +{ + "data": { + "type": "action_connection", + "attributes": { + "name": "Cassette Connection", + "integration": { + "type": "AWS", + "credentials": { + "type": "AWSAssumeRole", + "role": "MyRoleUpdated", + "account_id": "123456789123" + } + } + } + } +} \ No newline at end of file diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index cf4ec13084468..83e33b7ca2963 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -39,6 +39,20 @@ "description": "Update an AWS integration returns \"AWS Account object\" response" } ], + "CreateActionConnection": [ + { + "group": "action_connection", + "suffix": "", + "description": "Create a new Action Connection returns \"Successfully created Action Connection\" response" + } + ], + "UpdateActionConnection": [ + { + "group": "action_connection", + "suffix": "", + "description": "Update an existing Action Connection returns \"Successfully updated Action Connection\" response" + } + ], "CreateApp": [ { "group": "apps", diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 6597fb1379d0d..4a4ca9875e081 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -218,6 +218,13 @@ components: required: true schema: type: string + ConnectionId: + description: The ID of the action connection + in: path + name: connection_id + required: true + schema: + type: string CustomDestinationId: description: The ID of the custom destination. in: path @@ -1236,6 +1243,64 @@ components: required: - data type: object + AWSAssumeRole: + description: The definition of `AWSAssumeRole` object. + properties: + account_id: + description: AWS account the connection is created for + example: '111222333444' + pattern: ^\d{12}$ + type: string + external_id: + description: External ID used to scope which connection can be used to assume + the role + example: 33a1011635c44b38a064cf14e82e1d8f + readOnly: true + type: string + principal_id: + description: AWS account that will assume the role + example: '123456789012' + readOnly: true + type: string + role: + description: Role to assume + example: my-role + type: string + type: + $ref: '#/components/schemas/AWSAssumeRoleType' + required: + - type + - account_id + - role + type: object + AWSAssumeRoleType: + description: The definition of `AWSAssumeRoleType` object. + enum: + - AWSAssumeRole + example: AWSAssumeRole + type: string + x-enum-varnames: + - AWSASSUMEROLE + AWSAssumeRoleUpdate: + description: The definition of `AWSAssumeRoleUpdate` object. + properties: + account_id: + description: AWS account the connection is created for + example: '111222333444' + pattern: ^\d{12}$ + type: string + generate_new_external_id: + description: The `AWSAssumeRoleUpdate` `generate_new_external_id`. + type: boolean + role: + description: Role to assume + example: my-role + type: string + type: + $ref: '#/components/schemas/AWSAssumeRoleType' + required: + - type + type: object AWSAuthConfig: description: AWS Authentication config. oneOf: @@ -1274,6 +1339,43 @@ components: required: - role_name type: object + AWSCredentials: + description: The definition of `AWSCredentials` object. + oneOf: + - $ref: '#/components/schemas/AWSAssumeRole' + AWSCredentialsUpdate: + description: The definition of `AWSCredentialsUpdate` object. + oneOf: + - $ref: '#/components/schemas/AWSAssumeRoleUpdate' + AWSIntegration: + description: The definition of `AWSIntegration` object. + properties: + credentials: + $ref: '#/components/schemas/AWSCredentials' + type: + $ref: '#/components/schemas/AWSIntegrationType' + required: + - type + - credentials + type: object + AWSIntegrationType: + description: The definition of `AWSIntegrationType` object. + enum: + - AWS + example: AWS + type: string + x-enum-varnames: + - AWS + AWSIntegrationUpdate: + description: The definition of `AWSIntegrationUpdate` object. + properties: + credentials: + $ref: '#/components/schemas/AWSCredentialsUpdate' + type: + $ref: '#/components/schemas/AWSIntegrationType' + required: + - type + type: object AWSLambdaForwarderConfig: description: 'Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing @@ -1587,6 +1689,73 @@ components: xray_services: $ref: '#/components/schemas/XRayServicesList' type: object + ActionConnectionAttributes: + description: The definition of `ActionConnectionAttributes` object. + properties: + integration: + $ref: '#/components/schemas/ActionConnectionIntegration' + name: + description: Name of the connection + example: My AWS Connection + type: string + required: + - name + - integration + type: object + ActionConnectionAttributesUpdate: + description: The definition of `ActionConnectionAttributesUpdate` object. + properties: + integration: + $ref: '#/components/schemas/ActionConnectionIntegrationUpdate' + name: + description: Name of the connection + example: My AWS Connection + type: string + type: object + ActionConnectionData: + description: Data related to the connection. + properties: + attributes: + $ref: '#/components/schemas/ActionConnectionAttributes' + id: + description: The connection identifier + readOnly: true + type: string + type: + $ref: '#/components/schemas/ActionConnectionDataType' + required: + - type + - attributes + type: object + ActionConnectionDataType: + description: The definition of `ActionConnectionDataType` object. + enum: + - action_connection + example: action_connection + type: string + x-enum-varnames: + - ACTION_CONNECTION + ActionConnectionDataUpdate: + description: Data related to the connection update. + properties: + attributes: + $ref: '#/components/schemas/ActionConnectionAttributesUpdate' + type: + $ref: '#/components/schemas/ActionConnectionDataType' + required: + - type + - attributes + type: object + ActionConnectionIntegration: + description: The definition of `ActionConnectionIntegration` object. + oneOf: + - $ref: '#/components/schemas/AWSIntegration' + - $ref: '#/components/schemas/HTTPIntegration' + ActionConnectionIntegrationUpdate: + description: The definition of `ActionConnectionIntegrationUpdate` object. + oneOf: + - $ref: '#/components/schemas/AWSIntegrationUpdate' + - $ref: '#/components/schemas/HTTPIntegrationUpdate' ActiveBillingDimensionsAttributes: description: List of active billing dimensions. properties: @@ -6781,6 +6950,20 @@ components: type: string x-enum-varnames: - COST_BY_ORG + CreateActionConnectionRequest: + description: Request used to create an action connection. + properties: + data: + $ref: '#/components/schemas/ActionConnectionData' + required: + - data + type: object + CreateActionConnectionResponse: + description: The response for a created connection + properties: + data: + $ref: '#/components/schemas/ActionConnectionData' + type: object CreateOpenAPIResponse: description: Response for `CreateOpenAPI` operation. properties: @@ -11594,6 +11777,12 @@ components: type: string x-enum-varnames: - GCP_SERVICE_ACCOUNT + GetActionConnectionResponse: + description: The response for found connection + properties: + data: + $ref: '#/components/schemas/ActionConnectionData' + type: object GetDeviceAttributes: description: The device attributes properties: @@ -11788,6 +11977,18 @@ components: example: env:production type: string type: array + HTTPBody: + description: The definition of `HTTPBody` object. + properties: + content: + description: Serialized body content + example: '{"some-json": "with-value"}' + type: string + content_type: + description: Content type of the body + example: application/json + type: string + type: object HTTPCIAppError: description: List of errors. properties: @@ -11813,6 +12014,88 @@ components: $ref: '#/components/schemas/HTTPCIAppError' type: array type: object + HTTPCredentials: + description: The definition of `HTTPCredentials` object. + oneOf: + - $ref: '#/components/schemas/HTTPTokenAuth' + HTTPCredentialsUpdate: + description: The definition of `HTTPCredentialsUpdate` object. + oneOf: + - $ref: '#/components/schemas/HTTPTokenAuthUpdate' + HTTPHeader: + description: The definition of `HTTPHeader` object. + properties: + name: + description: The `HTTPHeader` `name`. + example: MyHttpHeader + pattern: ^[A-Za-z][A-Za-z\\d\\-\\_]*$ + type: string + value: + description: The `HTTPHeader` `value`. + example: Some header value + type: string + required: + - name + - value + type: object + HTTPHeaderUpdate: + description: The definition of `HTTPHeaderUpdate` object. + properties: + deleted: + description: Should the header be deleted. + type: boolean + name: + description: The `HTTPHeaderUpdate` `name`. + example: MyHttpHeader + pattern: ^[A-Za-z][A-Za-z\\d\\-\\_]*$ + type: string + value: + description: The `HTTPHeaderUpdate` `value`. + example: Updated Header Value + type: string + required: + - name + type: object + HTTPIntegration: + description: The definition of `HTTPIntegration` object. + properties: + base_url: + description: Base HTTP url for the integration + example: http://datadoghq.com + pattern: url + type: string + credentials: + $ref: '#/components/schemas/HTTPCredentials' + type: + $ref: '#/components/schemas/HTTPIntegrationType' + required: + - type + - base_url + - credentials + type: object + HTTPIntegrationType: + description: The definition of `HTTPIntegrationType` object. + enum: + - HTTP + example: HTTP + type: string + x-enum-varnames: + - HTTP + HTTPIntegrationUpdate: + description: The definition of `HTTPIntegrationUpdate` object. + properties: + base_url: + description: Base HTTP url for the integration + example: http://datadoghq.com + pattern: url + type: string + credentials: + $ref: '#/components/schemas/HTTPCredentialsUpdate' + type: + $ref: '#/components/schemas/HTTPIntegrationType' + required: + - type + type: object HTTPLog: description: Structured log message. items: @@ -11889,6 +12172,105 @@ components: required: - message type: object + HTTPToken: + description: The definition of `HTTPToken` object. + properties: + name: + description: The `HTTPToken` `name`. + example: MyToken + pattern: ^[A-Za-z][A-Za-z\\d]*$ + type: string + type: + $ref: '#/components/schemas/TokenType' + value: + description: The `HTTPToken` `value`. + example: Some Token Value + type: string + required: + - name + - value + - type + type: object + HTTPTokenAuth: + description: The definition of `HTTPTokenAuth` object. + properties: + body: + $ref: '#/components/schemas/HTTPBody' + headers: + description: The `HTTPTokenAuth` `headers`. + items: + $ref: '#/components/schemas/HTTPHeader' + type: array + tokens: + description: The `HTTPTokenAuth` `tokens`. + items: + $ref: '#/components/schemas/HTTPToken' + type: array + type: + $ref: '#/components/schemas/HTTPTokenAuthType' + url_parameters: + description: The `HTTPTokenAuth` `url_parameters`. + items: + $ref: '#/components/schemas/UrlParam' + type: array + required: + - type + type: object + HTTPTokenAuthType: + description: The definition of `HTTPTokenAuthType` object. + enum: + - HTTPTokenAuth + example: HTTPTokenAuth + type: string + x-enum-varnames: + - HTTPTOKENAUTH + HTTPTokenAuthUpdate: + description: The definition of `HTTPTokenAuthUpdate` object. + properties: + body: + $ref: '#/components/schemas/HTTPBody' + headers: + description: The `HTTPTokenAuthUpdate` `headers`. + items: + $ref: '#/components/schemas/HTTPHeaderUpdate' + type: array + tokens: + description: The `HTTPTokenAuthUpdate` `tokens`. + items: + $ref: '#/components/schemas/HTTPTokenUpdate' + type: array + type: + $ref: '#/components/schemas/HTTPTokenAuthType' + url_parameters: + description: The `HTTPTokenAuthUpdate` `url_parameters`. + items: + $ref: '#/components/schemas/UrlParamUpdate' + type: array + required: + - type + type: object + HTTPTokenUpdate: + description: The definition of `HTTPTokenUpdate` object. + properties: + deleted: + description: Should the header be deleted. + type: boolean + name: + description: The `HTTPToken` `name`. + example: MyToken + pattern: ^[A-Za-z][A-Za-z\\d]*$ + type: string + type: + $ref: '#/components/schemas/TokenType' + value: + description: The `HTTPToken` `value`. + example: Some Token Value + type: string + required: + - name + - type + - value + type: object HistoricalJobDataType: description: Type of payload. enum: @@ -28285,6 +28667,19 @@ components: items: $ref: '#/components/schemas/TimeseriesResponseValues' type: array + TokenName: + description: Name for tokens. + example: MyTokenName + pattern: ^[A-Za-z][A-Za-z\\d]*$ + type: string + TokenType: + description: The definition of `TokenType` object. + enum: + - SECRET + example: SECRET + type: string + x-enum-varnames: + - SECRET Unit: description: Object containing the metric unit family, scale factor, name, and short name. @@ -28313,6 +28708,20 @@ components: example: min type: string type: object + UpdateActionConnectionRequest: + description: Request used to update an action connection. + properties: + data: + $ref: '#/components/schemas/ActionConnectionDataUpdate' + required: + - data + type: object + UpdateActionConnectionResponse: + description: The response for an updated connection. + properties: + data: + $ref: '#/components/schemas/ActionConnectionData' + type: object UpdateOpenAPIResponse: description: Response for `UpdateOpenAPI`. properties: @@ -28392,6 +28801,36 @@ components: description: Upsert entity response included item. oneOf: - $ref: '#/components/schemas/EntityResponseIncludedSchema' + UrlParam: + description: The definition of `UrlParam` object. + properties: + name: + $ref: '#/components/schemas/TokenName' + example: MyUrlParameter + value: + description: The `UrlParam` `value`. + example: Some Url Parameter value + type: string + required: + - name + - value + type: object + UrlParamUpdate: + description: The definition of `UrlParamUpdate` object. + properties: + deleted: + description: Should the header be deleted. + type: boolean + name: + $ref: '#/components/schemas/TokenName' + example: MyUrlParameter + value: + description: The `UrlParamUpdate` `value`. + example: Some Url Parameter value + type: string + required: + - name + type: object UsageApplicationSecurityMonitoringResponse: description: Application Security Monitoring usage response. properties: @@ -29649,6 +30088,134 @@ info: version: '1.0' openapi: 3.0.0 paths: + /api/v2/actions/connections: + post: + description: Create a new Action Connection + operationId: CreateActionConnection + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateActionConnectionRequest' + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/CreateActionConnectionResponse' + description: Successfully created Action Connection + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Create a new Action Connection + tags: + - Action Connection + x-given: + action_connection: + parameters: + - name: body + value: "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": + {\n \"name\": \"Cassette Connection DELETE\",\n \"integration\": + {\n \"type\": \"AWS\",\n \"credentials\": {\n + \ \"type\": \"AWSAssumeRole\",\n \"role\": + \"MyRole\",\n \"account_id\": \"123456789123\"\n }\n + \ }\n }\n }\n}" + step: there is a valid "action_connection" in the system + x-menu-order: 2 + x-undo: + operationId: DeleteActionConnection + parameters: + - name: connection_id + source: data.id + type: unsafe + /api/v2/actions/connections/{connection_id}: + delete: + description: Delete an existing Action Connection + operationId: DeleteActionConnection + parameters: + - $ref: '#/components/parameters/ConnectionId' + responses: + '204': + description: The resource was deleted successfully. + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Delete an existing Action Connection + tags: + - Action Connection + x-menu-order: 4 + x-permission: + operator: OR + permissions: + - connection_write + x-undo: + type: idempotent + get: + description: Get an existing Action Connection + operationId: GetActionConnection + parameters: + - $ref: '#/components/parameters/ConnectionId' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GetActionConnectionResponse' + description: Successfully get Action Connection + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Get an existing Action Connection + tags: + - Action Connection + x-menu-order: 1 + x-undo: + type: safe + patch: + description: Update an existing Action Connection + operationId: UpdateActionConnection + parameters: + - $ref: '#/components/parameters/ConnectionId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateActionConnectionRequest' + description: Update an existing Action Connection request body + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateActionConnectionResponse' + description: Successfully updated Action Connection + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Update an existing Action Connection + tags: + - Action Connection + x-menu-order: 3 + x-undo: + type: idempotent /api/v2/api_keys: get: description: List all API keys available for your account. @@ -50217,6 +50784,17 @@ tags: externalDocs: url: https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection name: AWS Logs Integration +- description: "Action connections extend your installed integrations and allow you + to take action in your third-party systems\n(e.g. AWS, Gitlab, and Statuspage) + with Datadog\u2019s Workflow Automation and App Builder products.\n\nDatadog\u2019s + Integrations automatically provide authentication for Slack, Microsoft Teams, + PagerDuty, Opsgenie,\nJIRA, GitHub, and Statuspage. You do not need additional + connections in order to access these tools within\nWorkflow Automation and App + Builder.\n\nWe offer granular access control for editing and resolving connections." + externalDocs: + description: Find out more at + url: https://docs.datadoghq.com/service_management/workflows/connections/ + name: Action Connection - 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 03c871f36c8da..9ce3ae2693a07 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -310,6 +310,15 @@ "type": "string" } }, + "ConnectionId": { + "description": "The ID of the action connection", + "in": "path", + "name": "connection_id", + "required": true, + "schema": { + "type": "string" + } + }, "CustomDestinationId": { "description": "The ID of the custom destination.", "in": "path", @@ -6754,6 +6763,97 @@ ], "type": "object" }, + "AWSAssumeRole": { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + }, + "AWSAssumeRoleType": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + }, + "AWSAssumeRoleUpdate": { + "description": "The definition of `AWSAssumeRoleUpdate` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "generate_new_external_id": { + "description": "The `AWSAssumeRoleUpdate` `generate_new_external_id`.", + "type": "boolean" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, "AWSAuthConfig": { "description": "AWS Authentication config.", "oneOf": [ @@ -6841,6 +6941,238 @@ ], "type": "object" }, + "AWSCredentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "AWSCredentialsUpdate": { + "description": "The definition of `AWSCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRoleUpdate` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "generate_new_external_id": { + "description": "The `AWSAssumeRoleUpdate` `generate_new_external_id`.", + "type": "boolean" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "AWSIntegration": { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + "AWSIntegrationType": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + }, + "AWSIntegrationUpdate": { + "description": "The definition of `AWSIntegrationUpdate` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRoleUpdate` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "generate_new_external_id": { + "description": "The `AWSAssumeRoleUpdate` `generate_new_external_id`.", + "type": "boolean" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, "AWSLambdaForwarderConfig": { "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { @@ -7612,1346 +7944,1663 @@ }, "type": "object" }, - "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" - }, - "ActiveBillingDimensionsResponse": { - "description": "Active billing dimensions response.", - "properties": { - "data": { - "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" - } - }, - "type": "object" - }, - "ActiveBillingDimensionsType": { - "default": "billing_dimensions", - "description": "Type of active billing dimensions data.", - "enum": [ - "billing_dimensions" - ], - "type": "string", - "x-enum-varnames": [ - "BILLING_DIMENSIONS" - ] - }, - "Advisory": { - "description": "Advisory.", - "properties": { - "base_severity": { - "description": "Advisory base severity.", - "example": "Critical", - "type": "string" - }, - "id": { - "description": "Advisory id.", - "example": "GHSA-4wrc-f8pq-fpqp", - "type": "string" - }, - "severity": { - "description": "Advisory Datadog severity.", - "example": "Medium", - "type": "string" - } - }, - "required": [ - "id", - "base_severity" - ], - "type": "object" - }, - "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" - ], - "example": "apm_retention_filter", - "type": "string", - "x-enum-varnames": [ - "apm_retention_filter" - ] - }, - "ApplicationKeyCreateAttributes": { - "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" - ], - "items": { - "description": "Name of scope.", - "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" - ], - "items": { - "description": "Name of scope.", - "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" - ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "ApplicationKeyCreateRequest": { - "description": "Request used to create an application key.", + "ActionConnectionAttributes": { + "description": "The definition of `ActionConnectionAttributes` object.", "properties": { - "data": { - "description": "Object used to create an application key.", - "properties": { - "attributes": { - "description": "Attributes used to create an application Key.", + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", "properties": { - "name": { - "description": "Name of the application key.", - "example": "Application Key for managing dashboards", - "type": "string" + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] }, - "scopes": { - "description": "Array of scopes to grant the application key.", - "example": [ - "dashboards_read", - "dashboards_write", - "dashboards_public_share" + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" ], - "items": { - "description": "Name of scope.", - "type": "string" - }, - "nullable": true, - "type": "array" + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] } }, "required": [ - "name" + "type", + "credentials" ], - "type": "object", - "x-merge-override": { - "properties": false - } + "type": "object" }, - "type": { - "default": "application_keys", - "description": "Application Keys resource type.", - "enum": [ - "application_keys" - ], - "example": "application_keys", - "type": "string", - "x-enum-varnames": [ - "APPLICATION_KEYS" - ] - } - }, - "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.", - "properties": { - "data": { - "description": "Relationship to user object.", + { + "description": "The definition of `HTTPIntegration` object.", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", "type": "string" }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "The definition of `HTTPIntegrationType` object.", "enum": [ - "users" + "HTTP" ], - "example": "users", + "example": "HTTP", "type": "string", "x-enum-varnames": [ - "USERS" + "HTTP" ] } }, "required": [ - "id", - "type" + "type", + "base_url", + "credentials" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } - }, - "required": [ - "data" - ], - "type": "object" + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" } }, - "type": "object", - "x-merge-override": { - "properties": false - } + "required": [ + "name", + "integration" + ], + "type": "object" }, - "ApplicationKeyResponse": { - "description": "Response for retrieving an application key.", + "ActionConnectionAttributesUpdate": { + "description": "The definition of `ActionConnectionAttributesUpdate` object.", "properties": { - "data": { - "description": "Datadog application key.", - "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 - }, - "last4": { - "description": "The last four characters of the application key.", - "example": "abcd", - "maxLength": 4, - "minLength": 4, - "readOnly": true, - "type": "string", - "x-secret": true - }, - "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": "ID of the application key.", - "type": "string" - }, - "relationships": { - "description": "Resources related to the application key.", + "integration": { + "description": "The definition of `ActionConnectionIntegrationUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegrationUpdate` object.", "properties": { - "owned_by": { - "description": "Relationship to user.", - "properties": { - "data": { - "description": "Relationship to user object.", + "credentials": { + "description": "The definition of `AWSCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "generate_new_external_id": { + "description": "The `AWSAssumeRoleUpdate` `generate_new_external_id`.", + "type": "boolean" + }, + "role": { + "description": "Role to assume", + "example": "my-role", "type": "string" }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "The definition of `AWSAssumeRoleType` object.", "enum": [ - "users" + "AWSAssumeRole" ], - "example": "users", + "example": "AWSAssumeRole", "type": "string", "x-enum-varnames": [ - "USERS" + "AWSASSUMEROLE" ] } }, "required": [ - "id", "type" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } - }, - "required": [ - "data" + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" ], - "type": "object" + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] } }, - "type": "object", - "x-merge-override": { - "properties": false - } - }, - "type": { - "default": "application_keys", - "description": "Application Keys resource type.", - "enum": [ - "application_keys" + "required": [ + "type" ], - "example": "application_keys", - "type": "string", - "x-enum-varnames": [ - "APPLICATION_KEYS" - ] - } - }, - "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.", - "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.", + "type": "object" + }, + { + "description": "The definition of `HTTPIntegrationUpdate` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuthUpdate` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuthUpdate` `headers`.", + "items": { + "description": "The definition of `HTTPHeaderUpdate` object.", "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuthUpdate` `tokens`.", + "items": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", "type": "string" }, "type": { - "default": "orgs", - "description": "Organizations resource type.", + "description": "The definition of `TokenType` object.", "enum": [ - "orgs" + "SECRET" ], - "example": "orgs", + "example": "SECRET", "type": "string", "x-enum-varnames": [ - "ORGS" + "SECRET" ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" } }, "required": [ - "id", - "type" + "name", + "type", + "value" ], "type": "object" - } + }, + "type": "array" }, - "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" - ] - } + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuthUpdate` `url_parameters`.", + "items": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" }, - "required": [ - "id", - "type" - ], - "type": "object" + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + } }, - "other_users": { - "description": "Relationship to users.", - "properties": { - "data": { - "description": "Relationships to user objects.", - "example": [], - "items": { - "description": "Relationship to user object.", + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "type": "object" + }, + "ActionConnectionData": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", "type": "string" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" } }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, - "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" + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } + "required": [ + "name", + "value" + ], + "type": "object" }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" }, - "type": "array" - } - }, - "type": "object", - "x-merge-override": { - "required": false + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" } - } + ] }, - "type": "object", - "x-merge-override": { - "properties": false + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] } }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" } - }, - { - "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" - } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + }, + "ActionConnectionDataType": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + }, + "ActionConnectionDataUpdate": { + "description": "Data related to the connection update.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributesUpdate` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegrationUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegrationUpdate` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRoleUpdate` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "generate_new_external_id": { + "description": "The `AWSAssumeRoleUpdate` `generate_new_external_id`.", + "type": "boolean" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] }, - "type": "object" - }, - "id": { - "description": "The unique identifier of the role.", - "type": "string" + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } }, - "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.", + "required": [ + "type" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegrationUpdate` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuthUpdate` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", "properties": { - "id": { - "description": "ID of the permission.", + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", "type": "string" }, - "type": { - "default": "permissions", - "description": "Permissions resource type.", - "enum": [ - "permissions" - ], - "example": "permissions", - "type": "string", - "x-enum-varnames": [ - "PERMISSIONS" - ] + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, - "type": "array" - } - }, - "type": "object", - "x-merge-override": { - "required": false + "headers": { + "description": "The `HTTPTokenAuthUpdate` `headers`.", + "items": { + "description": "The definition of `HTTPHeaderUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuthUpdate` `tokens`.", + "items": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "type", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuthUpdate` `url_parameters`.", + "items": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" } - } + ] }, - "type": "object" + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } }, - "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": [ + "type" + ], + "type": "object" } - }, - { - "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" - } - ] + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } }, - "type": "array" + "type": "object" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] } }, + "required": [ + "type", + "attributes" + ], "type": "object" }, - "ApplicationKeyResponseIncludedItem": { - "description": "An object related to an application key.", + "ActionConnectionIntegration": { + "description": "The definition of `ActionConnectionIntegration` object.", "oneOf": [ { - "description": "User object returned by the API.", + "description": "The definition of `AWSIntegration` object.", "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" + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" } - }, - "type": "object" + ] }, - "id": { - "description": "ID of the user.", + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", "type": "string" }, - "relationships": { - "description": "Relationships of the user object returned by the API.", - "properties": { - "org": { - "description": "Relationship to an organization.", + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", "properties": { - "data": { - "description": "Relationship to organization object.", + "body": { + "description": "The definition of `HTTPBody` object.", "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", "type": "string" }, - "type": { - "default": "orgs", - "description": "Organizations resource type.", - "enum": [ - "orgs" - ], - "example": "orgs", - "type": "string", - "x-enum-varnames": [ - "ORGS" - ] + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" } }, - "required": [ - "id", - "type" - ], "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "other_orgs": { - "description": "Relationship to organizations.", - "properties": { - "data": { - "description": "Relationships to organization objects.", - "example": [], + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", "items": { - "description": "Relationship to organization object.", + "description": "The definition of `HTTPHeader` object.", "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", "type": "string" }, - "type": { - "default": "orgs", - "description": "Organizations resource type.", - "enum": [ - "orgs" - ], - "example": "orgs", - "type": "string", - "x-enum-varnames": [ - "ORGS" - ] + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" } }, "required": [ - "id", - "type" + "name", + "value" ], "type": "object" }, "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "other_users": { - "description": "Relationship to users.", - "properties": { - "data": { - "description": "Relationships to user objects.", - "example": [], + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", "items": { - "description": "Relationship to user object.", + "description": "The definition of `HTTPToken` object.", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", "type": "string" }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "The definition of `TokenType` object.", "enum": [ - "users" + "SECRET" ], - "example": "users", + "example": "SECRET", "type": "string", "x-enum-varnames": [ - "USERS" + "SECRET" ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" } }, "required": [ - "id", + "name", + "value", "type" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, "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.", + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", "items": { - "description": "Relationship to role object.", + "description": "The definition of `UrlParam` object.", "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", "type": "string" }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "name", + "value" + ], + "type": "object" }, "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "type" + ], + "type": "object" } - }, - "type": "object", - "x-merge-override": { - "properties": false - } + ] }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "The definition of `HTTPIntegrationType` object.", "enum": [ - "users" + "HTTP" ], - "example": "users", + "example": "HTTP", "type": "string", "x-enum-varnames": [ - "USERS" + "HTTP" ] } }, - "type": "object", - "x-merge-override": { - "required": false - } - }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "ActionConnectionIntegrationUpdate": { + "description": "The definition of `ActionConnectionIntegrationUpdate` object.", + "oneOf": [ { - "description": "Role object returned by the API.", + "description": "The definition of `AWSIntegrationUpdate` object.", "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.", + "credentials": { + "description": "The definition of `AWSCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRoleUpdate` object.", "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" + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "generate_new_external_id": { + "description": "The `AWSAssumeRoleUpdate` `generate_new_external_id`.", + "type": "boolean" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "type" + ], + "type": "object" } - }, - "type": "object" + ] }, "type": { - "default": "roles", - "description": "Roles type.", + "description": "The definition of `AWSIntegrationType` object.", "enum": [ - "roles" + "AWS" ], - "example": "roles", + "example": "AWS", "type": "string", "x-enum-varnames": [ - "ROLES" + "AWS" ] } }, "required": [ "type" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, { - "description": "The definition of LeakedKey object.", + "description": "The definition of `HTTPIntegrationUpdate` 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", + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", "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" - } + "credentials": { + "description": "The definition of `HTTPCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuthUpdate` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuthUpdate` `headers`.", + "items": { + "description": "The definition of `HTTPHeaderUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuthUpdate` `tokens`.", + "items": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "type", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuthUpdate` `url_parameters`.", + "items": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } ] }, - "ApplicationKeyResponseMeta": { - "description": "Additional information related to the application key response.", + "ActiveBillingDimensionsAttributes": { + "description": "List of active billing dimensions.", "properties": { - "max_allowed_per_user": { - "description": "Max allowed number of application keys per user.", - "format": "int64", - "type": "integer" + "month": { + "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.", + "format": "date-time", + "type": "string" }, - "page": { - "description": "Additional information related to the application key response.", + "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": { - "total_filtered_count": { - "description": "Total filtered application key count.", - "format": "int64", - "type": "integer" + "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" }, - "ApplicationKeyResponseMetaPage": { - "description": "Additional information related to the application key response.", + "ActiveBillingDimensionsResponse": { + "description": "Active billing dimensions response.", "properties": { - "total_filtered_count": { - "description": "Total filtered application key count.", - "format": "int64", - "type": "integer" + "data": { + "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" } }, "type": "object" }, - "ApplicationKeyUpdateAttributes": { - "description": "Attributes used to update an application Key.", + "ActiveBillingDimensionsType": { + "default": "billing_dimensions", + "description": "Type of active billing dimensions data.", + "enum": [ + "billing_dimensions" + ], + "type": "string", + "x-enum-varnames": [ + "BILLING_DIMENSIONS" + ] + }, + "Advisory": { + "description": "Advisory.", + "properties": { + "base_severity": { + "description": "Advisory base severity.", + "example": "Critical", + "type": "string" + }, + "id": { + "description": "Advisory id.", + "example": "GHSA-4wrc-f8pq-fpqp", + "type": "string" + }, + "severity": { + "description": "Advisory Datadog severity.", + "example": "Medium", + "type": "string" + } + }, + "required": [ + "id", + "base_severity" + ], + "type": "object" + }, + "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" + ], + "example": "apm_retention_filter", + "type": "string", + "x-enum-varnames": [ + "apm_retention_filter" + ] + }, + "ApplicationKeyCreateAttributes": { + "description": "Attributes used to create an application Key.", "properties": { "name": { "description": "Name of the application key.", @@ -8973,16 +9622,19 @@ "type": "array" } }, + "required": [ + "name" + ], "type": "object", "x-merge-override": { "properties": false } }, - "ApplicationKeyUpdateData": { - "description": "Object used to update an application key.", + "ApplicationKeyCreateData": { + "description": "Object used to create an application key.", "properties": { "attributes": { - "description": "Attributes used to update an application Key.", + "description": "Attributes used to create an application Key.", "properties": { "name": { "description": "Name of the application key.", @@ -9004,16 +9656,14 @@ "type": "array" } }, + "required": [ + "name" + ], "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.", @@ -9029,7 +9679,6 @@ }, "required": [ "attributes", - "id", "type" ], "type": "object", @@ -9037,14 +9686,14 @@ "required": false } }, - "ApplicationKeyUpdateRequest": { - "description": "Request used to update an application key.", + "ApplicationKeyCreateRequest": { + "description": "Request used to create an application key.", "properties": { "data": { - "description": "Object used to update an application key.", + "description": "Object used to create an application key.", "properties": { "attributes": { - "description": "Attributes used to update an application Key.", + "description": "Attributes used to create an application Key.", "properties": { "name": { "description": "Name of the application key.", @@ -9066,16 +9715,14 @@ "type": "array" } }, + "required": [ + "name" + ], "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.", @@ -9091,7 +9738,6 @@ }, "required": [ "attributes", - "id", "type" ], "type": "object", @@ -9105,856 +9751,2035 @@ ], "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" - ] - }, - "Asset": { - "description": "A single vulnerable asset", + "ApplicationKeyRelationships": { + "description": "Resources related to the application key.", "properties": { - "attributes": { - "description": "The JSON:API attributes of the asset.", + "owned_by": { + "description": "Relationship to user.", "properties": { - "arch": { - "description": "Asset architecture.", - "example": "arm64", - "type": "string" - }, - "environments": { - "description": "List of environments where the asset is deployed.", - "example": [ - "staging" - ], - "items": { - "example": "staging", - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Asset name.", - "example": "github.com/DataDog/datadog-agent.git", - "type": "string" - }, - "operating_system": { - "description": "Asset operating system.", + "data": { + "description": "Relationship to user object.", "properties": { - "description": { - "description": "Operating system version.", - "example": "24.04", - "type": "string" - }, - "name": { - "description": "Operating system name.", - "example": "ubuntu", + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "risks": { - "description": "Asset risks.", - "properties": { - "has_access_to_sensitive_data": { - "description": "Whether the asset has access to sensitive data or not.", - "example": false, - "type": "boolean" }, - "has_privileged_access": { - "description": "Whether the asset has privileged access or not.", - "example": false, - "type": "boolean" - }, - "in_production": { - "description": "Whether the asset is in production or not.", - "example": false, - "type": "boolean" - }, - "is_publicly_accessible": { - "description": "Whether the asset is publicly accessible or not.", - "example": false, - "type": "boolean" - }, - "under_attack": { - "description": "Whether the asset is under attack or not.", - "example": false, - "type": "boolean" + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] } }, "required": [ - "in_production" - ], - "type": "object" - }, - "type": { - "description": "The asset type", - "enum": [ - "Repository", - "Service", - "Host", - "HostImage", - "Image" + "id", + "type" ], - "example": "Repository", - "type": "string", - "x-enum-varnames": [ - "REPOSITORY", - "SERVICE", - "HOST", - "HOSTIMAGE", - "IMAGE" - ] - }, - "version": { - "description": "Asset version.", - "properties": { - "first": { - "description": "Asset first version.", - "example": "_latest", - "type": "string" - }, - "last": { - "description": "Asset last version.", - "example": "_latest", - "type": "string" - } - }, - "type": "object" - } - }, - "required": [ - "name", - "type", - "risks", - "environments" - ], - "type": "object" - }, - "id": { - "description": "The unique ID for this asset.", - "example": "Repository|github.com/DataDog/datadog-agent.git", - "type": "string" - }, - "type": { - "description": "The JSON:API type.", - "enum": [ - "assets" - ], - "example": "assets", - "type": "string", - "x-enum-varnames": [ - "ASSETS" - ] - } - }, - "required": [ - "id", - "type", - "attributes" - ], - "type": "object" - }, - "AssetAttributes": { - "description": "The JSON:API attributes of the asset.", - "properties": { - "arch": { - "description": "Asset architecture.", - "example": "arm64", - "type": "string" - }, - "environments": { - "description": "List of environments where the asset is deployed.", - "example": [ - "staging" - ], - "items": { - "example": "staging", - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Asset name.", - "example": "github.com/DataDog/datadog-agent.git", - "type": "string" - }, - "operating_system": { - "description": "Asset operating system.", - "properties": { - "description": { - "description": "Operating system version.", - "example": "24.04", - "type": "string" - }, - "name": { - "description": "Operating system name.", - "example": "ubuntu", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "risks": { - "description": "Asset risks.", - "properties": { - "has_access_to_sensitive_data": { - "description": "Whether the asset has access to sensitive data or not.", - "example": false, - "type": "boolean" - }, - "has_privileged_access": { - "description": "Whether the asset has privileged access or not.", - "example": false, - "type": "boolean" - }, - "in_production": { - "description": "Whether the asset is in production or not.", - "example": false, - "type": "boolean" - }, - "is_publicly_accessible": { - "description": "Whether the asset is publicly accessible or not.", - "example": false, - "type": "boolean" - }, - "under_attack": { - "description": "Whether the asset is under attack or not.", - "example": false, - "type": "boolean" + "type": "object", + "x-merge-override": { + "required": false + } } }, "required": [ - "in_production" - ], - "type": "object" - }, - "type": { - "description": "The asset type", - "enum": [ - "Repository", - "Service", - "Host", - "HostImage", - "Image" + "data" ], - "example": "Repository", - "type": "string", - "x-enum-varnames": [ - "REPOSITORY", - "SERVICE", - "HOST", - "HOSTIMAGE", - "IMAGE" - ] - }, - "version": { - "description": "Asset version.", - "properties": { - "first": { - "description": "Asset first version.", - "example": "_latest", - "type": "string" - }, - "last": { - "description": "Asset last version.", - "example": "_latest", - "type": "string" - } - }, "type": "object" } }, - "required": [ - "name", - "type", - "risks", - "environments" - ], - "type": "object" - }, - "AssetAttributesOperatingSystem": { - "description": "Asset operating system.", - "properties": { - "description": { - "description": "Operating system version.", - "example": "24.04", - "type": "string" - }, - "name": { - "description": "Operating system name.", - "example": "ubuntu", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "AssetAttributesRisks": { - "description": "Asset risks.", - "properties": { - "has_access_to_sensitive_data": { - "description": "Whether the asset has access to sensitive data or not.", - "example": false, - "type": "boolean" - }, - "has_privileged_access": { - "description": "Whether the asset has privileged access or not.", - "example": false, - "type": "boolean" - }, - "in_production": { - "description": "Whether the asset is in production or not.", - "example": false, - "type": "boolean" - }, - "is_publicly_accessible": { - "description": "Whether the asset is publicly accessible or not.", - "example": false, - "type": "boolean" - }, - "under_attack": { - "description": "Whether the asset is under attack or not.", - "example": false, - "type": "boolean" - } - }, - "required": [ - "in_production" - ], - "type": "object" - }, - "AssetAttributesVersion": { - "description": "Asset version.", - "properties": { - "first": { - "description": "Asset first version.", - "example": "_latest", - "type": "string" - }, - "last": { - "description": "Asset last version.", - "example": "_latest", - "type": "string" - } - }, - "type": "object" - }, - "AssetEntityType": { - "description": "The JSON:API type.", - "enum": [ - "assets" - ], - "example": "assets", - "type": "string", - "x-enum-varnames": [ - "ASSETS" - ] - }, - "AssetType": { - "description": "The asset type", - "enum": [ - "Repository", - "Service", - "Host", - "HostImage", - "Image" - ], - "example": "Repository", - "type": "string", - "x-enum-varnames": [ - "REPOSITORY", - "SERVICE", - "HOST", - "HOSTIMAGE", - "IMAGE" - ] + "type": "object", + "x-merge-override": { + "properties": false + } }, - "AuditLogsEvent": { - "description": "Object description of an Audit Logs event after it is processed and stored by Datadog.", + "ApplicationKeyResponse": { + "description": "Response for retrieving an application key.", "properties": { - "attributes": { - "description": "JSON object containing all event attributes and their associated values.", + "data": { + "description": "Datadog application key.", "properties": { "attributes": { - "additionalProperties": {}, - "description": "JSON object of attributes from Audit Logs events.", - "example": { - "customAttribute": 123, - "duration": 2345 + "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 + }, + "last4": { + "description": "The last four characters of the application key.", + "example": "abcd", + "maxLength": 4, + "minLength": 4, + "readOnly": true, + "type": "string", + "x-secret": true + }, + "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" - }, - "message": { - "description": "Message of the event.", - "type": "string" + "type": "object", + "x-merge-override": { + "properties": false + } }, - "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", + "id": { + "description": "ID of the application key.", "type": "string" }, - "tags": { - "description": "Array of tags associated with your event.", - "example": [ - "team:A" - ], - "items": { - "description": "Tag associated with your event.", - "type": "string" + "relationships": { + "description": "Resources related to the application key.", + "properties": { + "owned_by": { + "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": "array" + "type": "object", + "x-merge-override": { + "properties": false + } }, - "timestamp": { - "description": "Timestamp of your event.", - "example": "2019-01-02T09:42:36.320Z", - "format": "date-time", - "type": "string" + "type": { + "default": "application_keys", + "description": "Application Keys resource type.", + "enum": [ + "application_keys" + ], + "example": "application_keys", + "type": "string", + "x-enum-varnames": [ + "APPLICATION_KEYS" + ] } }, - "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" + "type": "object", + "x-merge-override": { + "required": false + } }, - "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.", + "included": { + "description": "Array of objects related to the application key.", "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.", + "description": "An object related to an application key.", + "oneOf": [ + { + "description": "User object returned by the API.", "properties": { "attributes": { - "additionalProperties": {}, - "description": "JSON object of attributes from Audit Logs events.", - "example": { - "customAttribute": 123, - "duration": 2345 + "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" }, - "message": { - "description": "Message of the event.", + "id": { + "description": "ID of the user.", "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", + "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 unique identifier of the role.", "type": "string" }, - "tags": { - "description": "Array of tags associated with your event.", - "example": [ - "team:A" + "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": { - "description": "Tag associated with your event.", - "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" }, - "timestamp": { - "description": "Timestamp of your event.", - "example": "2019-01-02T09:42:36.320Z", - "format": "date-time", + "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": "array" + } + }, + "type": "object" + }, + "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" + }, + "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" + } }, - "id": { - "description": "Unique ID of the event.", - "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", - "type": "string" + "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": { - "default": "audit", - "description": "Type of the event.", - "enum": [ - "audit" - ], - "example": "audit", - "type": "string", - "x-enum-varnames": [ - "Audit" - ] + "type": "object", + "x-merge-override": { + "properties": false } }, - "type": "object" + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } }, - "type": "array" + "type": "object", + "x-merge-override": { + "required": false + } }, - "links": { - "description": "Links attributes.", + { + "description": "Role object returned by the API.", "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==", + "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" + ] } }, - "type": "object" + "required": [ + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } }, - "meta": { - "description": "The metadata associated with a request.", + { + "description": "The definition of LeakedKey object.", "properties": { - "elapsed": { - "description": "Time elapsed in milliseconds.", - "example": 132, - "format": "int64", - "type": "integer" - }, - "page": { - "description": "Paging attributes.", + "attributes": { + "description": "The definition of LeakedKeyAttributes object.", "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==", + "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" }, - "request_id": { - "description": "The identifier of the request.", - "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", + "id": { + "description": "The LeakedKey id.", + "example": "id", "type": "string" }, - "status": { - "description": "The status of the response.", + "type": { + "default": "leaked_keys", + "description": "The definition of LeakedKeyType object.", "enum": [ - "done", - "timeout" + "leaked_keys" ], - "example": "done", + "example": "leaked_keys", "type": "string", "x-enum-varnames": [ - "DONE", - "TIMEOUT" + "LEAKED_KEYS" ] - }, - "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" } }, + "required": [ + "attributes", + "id", + "type" + ], "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.", + "ApplicationKeyResponseMeta": { + "description": "Additional information related to the application key response.", "properties": { - "time_offset": { - "description": "Time offset (in seconds) to apply to the query.", + "max_allowed_per_user": { + "description": "Max allowed number of application keys per user.", "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" + "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" }, - "AuditLogsQueryPageOptions": { - "description": "Paging attributes for listing events.", + "ApplicationKeyResponseMetaPage": { + "description": "Additional information related to the application key response.", "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, + "total_filtered_count": { + "description": "Total filtered application key count.", + "format": "int64", "type": "integer" } }, "type": "object" }, - "AuditLogsResponseLinks": { - "description": "Links attributes.", + "ApplicationKeyUpdateAttributes": { + "description": "Attributes used to update an application Key.", "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==", + "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 + } }, - "AuditLogsResponseMetadata": { - "description": "The metadata associated with a request.", + "ApplicationKeyUpdateData": { + "description": "Object used to update an application key.", "properties": { - "elapsed": { - "description": "Time elapsed in milliseconds.", - "example": 132, - "format": "int64", - "type": "integer" - }, - "page": { - "description": "Paging attributes.", + "attributes": { + "description": "Attributes used to update an application Key.", "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==", + "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 + } }, - "request_id": { - "description": "The identifier of the request.", - "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", + "id": { + "description": "ID of the application key.", + "example": "00112233-4455-6677-8899-aabbccddeeff", "type": "string" }, - "status": { - "description": "The status of the response.", + "type": { + "default": "application_keys", + "description": "Application Keys resource type.", "enum": [ - "done", - "timeout" + "application_keys" ], - "example": "done", + "example": "application_keys", "type": "string", "x-enum-varnames": [ - "DONE", - "TIMEOUT" + "APPLICATION_KEYS" ] - }, - "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==", - "type": "string" } }, - "type": "object" - }, - "AuditLogsResponseStatus": { - "description": "The status of the response.", - "enum": [ - "done", - "timeout" + "required": [ + "attributes", + "id", + "type" ], - "example": "done", - "type": "string", - "x-enum-varnames": [ - "DONE", - "TIMEOUT" - ] + "type": "object", + "x-merge-override": { + "required": false + } }, - "AuditLogsSearchEventsRequest": { - "description": "The request for a Audit Logs events list.", + "ApplicationKeyUpdateRequest": { + "description": "Request used to update an application key.", "properties": { - "filter": { - "description": "Search and filter query settings.", + "data": { + "description": "Object used to update an application key.", "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", + "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": "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": [ + "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" + ] + }, + "Asset": { + "description": "A single vulnerable asset", + "properties": { + "attributes": { + "description": "The JSON:API attributes of the asset.", + "properties": { + "arch": { + "description": "Asset architecture.", + "example": "arm64", + "type": "string" + }, + "environments": { + "description": "List of environments where the asset is deployed.", + "example": [ + "staging" + ], + "items": { + "example": "staging", + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Asset name.", + "example": "github.com/DataDog/datadog-agent.git", + "type": "string" + }, + "operating_system": { + "description": "Asset operating system.", + "properties": { + "description": { + "description": "Operating system version.", + "example": "24.04", + "type": "string" + }, + "name": { + "description": "Operating system name.", + "example": "ubuntu", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "risks": { + "description": "Asset risks.", + "properties": { + "has_access_to_sensitive_data": { + "description": "Whether the asset has access to sensitive data or not.", + "example": false, + "type": "boolean" + }, + "has_privileged_access": { + "description": "Whether the asset has privileged access or not.", + "example": false, + "type": "boolean" + }, + "in_production": { + "description": "Whether the asset is in production or not.", + "example": false, + "type": "boolean" + }, + "is_publicly_accessible": { + "description": "Whether the asset is publicly accessible or not.", + "example": false, + "type": "boolean" + }, + "under_attack": { + "description": "Whether the asset is under attack or not.", + "example": false, + "type": "boolean" + } + }, + "required": [ + "in_production" + ], + "type": "object" + }, + "type": { + "description": "The asset type", + "enum": [ + "Repository", + "Service", + "Host", + "HostImage", + "Image" + ], + "example": "Repository", + "type": "string", + "x-enum-varnames": [ + "REPOSITORY", + "SERVICE", + "HOST", + "HOSTIMAGE", + "IMAGE" + ] + }, + "version": { + "description": "Asset version.", + "properties": { + "first": { + "description": "Asset first version.", + "example": "_latest", + "type": "string" + }, + "last": { + "description": "Asset last version.", + "example": "_latest", + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "name", + "type", + "risks", + "environments" + ], + "type": "object" + }, + "id": { + "description": "The unique ID for this asset.", + "example": "Repository|github.com/DataDog/datadog-agent.git", + "type": "string" + }, + "type": { + "description": "The JSON:API type.", + "enum": [ + "assets" + ], + "example": "assets", + "type": "string", + "x-enum-varnames": [ + "ASSETS" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "AssetAttributes": { + "description": "The JSON:API attributes of the asset.", + "properties": { + "arch": { + "description": "Asset architecture.", + "example": "arm64", + "type": "string" + }, + "environments": { + "description": "List of environments where the asset is deployed.", + "example": [ + "staging" + ], + "items": { + "example": "staging", + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Asset name.", + "example": "github.com/DataDog/datadog-agent.git", + "type": "string" + }, + "operating_system": { + "description": "Asset operating system.", + "properties": { + "description": { + "description": "Operating system version.", + "example": "24.04", + "type": "string" + }, + "name": { + "description": "Operating system name.", + "example": "ubuntu", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "risks": { + "description": "Asset risks.", + "properties": { + "has_access_to_sensitive_data": { + "description": "Whether the asset has access to sensitive data or not.", + "example": false, + "type": "boolean" + }, + "has_privileged_access": { + "description": "Whether the asset has privileged access or not.", + "example": false, + "type": "boolean" + }, + "in_production": { + "description": "Whether the asset is in production or not.", + "example": false, + "type": "boolean" + }, + "is_publicly_accessible": { + "description": "Whether the asset is publicly accessible or not.", + "example": false, + "type": "boolean" + }, + "under_attack": { + "description": "Whether the asset is under attack or not.", + "example": false, + "type": "boolean" + } + }, + "required": [ + "in_production" + ], + "type": "object" + }, + "type": { + "description": "The asset type", + "enum": [ + "Repository", + "Service", + "Host", + "HostImage", + "Image" + ], + "example": "Repository", + "type": "string", + "x-enum-varnames": [ + "REPOSITORY", + "SERVICE", + "HOST", + "HOSTIMAGE", + "IMAGE" + ] + }, + "version": { + "description": "Asset version.", + "properties": { + "first": { + "description": "Asset first version.", + "example": "_latest", + "type": "string" + }, + "last": { + "description": "Asset last version.", + "example": "_latest", + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "name", + "type", + "risks", + "environments" + ], + "type": "object" + }, + "AssetAttributesOperatingSystem": { + "description": "Asset operating system.", + "properties": { + "description": { + "description": "Operating system version.", + "example": "24.04", + "type": "string" + }, + "name": { + "description": "Operating system name.", + "example": "ubuntu", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "AssetAttributesRisks": { + "description": "Asset risks.", + "properties": { + "has_access_to_sensitive_data": { + "description": "Whether the asset has access to sensitive data or not.", + "example": false, + "type": "boolean" + }, + "has_privileged_access": { + "description": "Whether the asset has privileged access or not.", + "example": false, + "type": "boolean" + }, + "in_production": { + "description": "Whether the asset is in production or not.", + "example": false, + "type": "boolean" + }, + "is_publicly_accessible": { + "description": "Whether the asset is publicly accessible or not.", + "example": false, + "type": "boolean" + }, + "under_attack": { + "description": "Whether the asset is under attack or not.", + "example": false, + "type": "boolean" + } + }, + "required": [ + "in_production" + ], + "type": "object" + }, + "AssetAttributesVersion": { + "description": "Asset version.", + "properties": { + "first": { + "description": "Asset first version.", + "example": "_latest", + "type": "string" + }, + "last": { + "description": "Asset last version.", + "example": "_latest", + "type": "string" + } + }, + "type": "object" + }, + "AssetEntityType": { + "description": "The JSON:API type.", + "enum": [ + "assets" + ], + "example": "assets", + "type": "string", + "x-enum-varnames": [ + "ASSETS" + ] + }, + "AssetType": { + "description": "The asset type", + "enum": [ + "Repository", + "Service", + "Host", + "HostImage", + "Image" + ], + "example": "Repository", + "type": "string", + "x-enum-varnames": [ + "REPOSITORY", + "SERVICE", + "HOST", + "HOSTIMAGE", + "IMAGE" + ] + }, + "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", + "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": { + "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" + }, + "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" + } + }, + "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==", + "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" @@ -36231,6 +38056,567 @@ "COST_BY_ORG" ] }, + "CreateActionConnectionRequest": { + "description": "Request used to create an action connection.", + "properties": { + "data": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "CreateActionConnectionResponse": { + "description": "The response for a created connection", + "properties": { + "data": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "type": "object" + }, "CreateOpenAPIResponse": { "description": "Response for `CreateOpenAPI` operation.", "properties": { @@ -63050,6 +65436,285 @@ "GCP_SERVICE_ACCOUNT" ] }, + "GetActionConnectionResponse": { + "description": "The response for found connection", + "properties": { + "data": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "type": "object" + }, "GetDeviceAttributes": { "description": "The device attributes", "properties": { @@ -63822,100 +66487,23 @@ }, "type": "array" }, - "HTTPCIAppError": { - "description": "List of errors.", + "HTTPBody": { + "description": "The definition of `HTTPBody` object.", "properties": { - "detail": { - "description": "Error message.", - "example": "Malformed payload", - "type": "string" - }, - "status": { - "description": "Error code.", - "example": "400", + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", "type": "string" }, - "title": { - "description": "Error title.", - "example": "Bad Request", + "content_type": { + "description": "Content type of the body", + "example": "application/json", "type": "string" } }, "type": "object" }, - "HTTPCIAppErrors": { - "description": "Errors occurred.", - "properties": { - "errors": { - "description": "Structured errors.", - "items": { - "description": "List of errors.", - "properties": { - "detail": { - "description": "Error message.", - "example": "Malformed payload", - "type": "string" - }, - "status": { - "description": "Error code.", - "example": "400", - "type": "string" - }, - "title": { - "description": "Error title.", - "example": "Bad Request", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - }, - "HTTPLog": { - "description": "Structured log message.", - "items": { - "additionalProperties": { - "description": "Additional log attributes." - }, - "description": "Logs that are sent over HTTP.", - "properties": { - "ddsource": { - "description": "The integration name associated with your log: the technology from which the log originated.\nWhen it matches an integration name, Datadog automatically installs the corresponding parsers and facets.\nSee [reserved attributes](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes).", - "example": "nginx", - "type": "string" - }, - "ddtags": { - "description": "Tags associated with your logs.", - "example": "env:staging,version:5.1", - "type": "string" - }, - "hostname": { - "description": "The name of the originating host of the log.", - "example": "i-012345678", - "type": "string" - }, - "message": { - "description": "The message [reserved attribute](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes)\nof your log. By default, Datadog ingests the value of the message attribute as the body of the log entry.\nThat value is then highlighted and displayed in the Logstream, where it is indexed for full text search.", - "example": "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World", - "type": "string" - }, - "service": { - "description": "The name of the application or service generating the log events.\nIt is used to switch from Logs to APM, so make sure you define the same value when you use both products.\nSee [reserved attributes](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes).", - "example": "payment", - "type": "string" - } - }, - "required": [ - "message" - ], - "type": "object" - }, - "type": "array" - }, - "HTTPLogError": { + "HTTPCIAppError": { "description": "List of errors.", "properties": { "detail": { @@ -63936,8 +66524,743 @@ }, "type": "object" }, - "HTTPLogErrors": { - "description": "Invalid query performed.", + "HTTPCIAppErrors": { + "description": "Errors occurred.", + "properties": { + "errors": { + "description": "Structured errors.", + "items": { + "description": "List of errors.", + "properties": { + "detail": { + "description": "Error message.", + "example": "Malformed payload", + "type": "string" + }, + "status": { + "description": "Error code.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Error title.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "HTTPCredentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "HTTPCredentialsUpdate": { + "description": "The definition of `HTTPCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuthUpdate` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuthUpdate` `headers`.", + "items": { + "description": "The definition of `HTTPHeaderUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuthUpdate` `tokens`.", + "items": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "type", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuthUpdate` `url_parameters`.", + "items": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "HTTPHeader": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "HTTPHeaderUpdate": { + "description": "The definition of `HTTPHeaderUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "HTTPIntegration": { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + }, + "HTTPIntegrationType": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + }, + "HTTPIntegrationUpdate": { + "description": "The definition of `HTTPIntegrationUpdate` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuthUpdate` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuthUpdate` `headers`.", + "items": { + "description": "The definition of `HTTPHeaderUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuthUpdate` `tokens`.", + "items": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "type", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuthUpdate` `url_parameters`.", + "items": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "HTTPLog": { + "description": "Structured log message.", + "items": { + "additionalProperties": { + "description": "Additional log attributes." + }, + "description": "Logs that are sent over HTTP.", + "properties": { + "ddsource": { + "description": "The integration name associated with your log: the technology from which the log originated.\nWhen it matches an integration name, Datadog automatically installs the corresponding parsers and facets.\nSee [reserved attributes](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes).", + "example": "nginx", + "type": "string" + }, + "ddtags": { + "description": "Tags associated with your logs.", + "example": "env:staging,version:5.1", + "type": "string" + }, + "hostname": { + "description": "The name of the originating host of the log.", + "example": "i-012345678", + "type": "string" + }, + "message": { + "description": "The message [reserved attribute](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes)\nof your log. By default, Datadog ingests the value of the message attribute as the body of the log entry.\nThat value is then highlighted and displayed in the Logstream, where it is indexed for full text search.", + "example": "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World", + "type": "string" + }, + "service": { + "description": "The name of the application or service generating the log events.\nIt is used to switch from Logs to APM, so make sure you define the same value when you use both products.\nSee [reserved attributes](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes).", + "example": "payment", + "type": "string" + } + }, + "required": [ + "message" + ], + "type": "object" + }, + "type": "array" + }, + "HTTPLogError": { + "description": "List of errors.", + "properties": { + "detail": { + "description": "Error message.", + "example": "Malformed payload", + "type": "string" + }, + "status": { + "description": "Error code.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Error title.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "HTTPLogErrors": { + "description": "Invalid query performed.", "properties": { "errors": { "description": "Structured errors.", @@ -64004,6 +67327,343 @@ ], "type": "object" }, + "HTTPToken": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "HTTPTokenAuth": { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "HTTPTokenAuthType": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "HTTPTokenAuthUpdate": { + "description": "The definition of `HTTPTokenAuthUpdate` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuthUpdate` `headers`.", + "items": { + "description": "The definition of `HTTPHeaderUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuthUpdate` `tokens`.", + "items": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "type", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuthUpdate` `url_parameters`.", + "items": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "HTTPTokenUpdate": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "type", + "value" + ], + "type": "object" + }, "HistoricalJobDataType": { "description": "Type of payload.", "enum": [ @@ -177642,6 +181302,23 @@ }, "type": "array" }, + "TokenName": { + "description": "Name for tokens.", + "example": "MyTokenName", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "TokenType": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, "Unit": { "description": "Object containing the metric unit family, scale factor, name, and short name.", "nullable": true, @@ -177675,6 +181352,555 @@ }, "type": "object" }, + "UpdateActionConnectionRequest": { + "description": "Request used to update an action connection.", + "properties": { + "data": { + "description": "Data related to the connection update.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributesUpdate` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegrationUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegrationUpdate` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRoleUpdate` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "generate_new_external_id": { + "description": "The `AWSAssumeRoleUpdate` `generate_new_external_id`.", + "type": "boolean" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegrationUpdate` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuthUpdate` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuthUpdate` `headers`.", + "items": { + "description": "The definition of `HTTPHeaderUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuthUpdate` `tokens`.", + "items": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "type", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuthUpdate` `url_parameters`.", + "items": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "UpdateActionConnectionResponse": { + "description": "The response for an updated connection.", + "properties": { + "data": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "type": "object" + }, "UpdateOpenAPIResponse": { "description": "Response for `UpdateOpenAPI`.", "properties": { @@ -183919,6 +188145,51 @@ } ] }, + "UrlParam": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "UrlParamUpdate": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, "UsageApplicationSecurityMonitoringResponse": { "description": "Application Security Monitoring usage response.", "properties": { @@ -191927,365 +196198,2302 @@ "type": "string" } }, - "type": "object" - } - }, - "type": "object" - }, - "WorkflowInstanceCreateResponseData": { - "additionalProperties": {}, - "description": "Data about the created workflow instance.", - "properties": { - "id": { - "description": "The ID of the workflow execution. It can be used to fetch the execution status.", - "type": "string" - } - }, - "type": "object" - }, - "WorkflowInstanceListItem": { - "additionalProperties": {}, - "description": "An item in the workflow instances list.", - "properties": { - "id": { - "description": "The ID of the workflow instance", - "type": "string" - } - }, - "type": "object" - }, - "WorkflowListInstancesResponse": { - "additionalProperties": {}, - "description": "Response returned when listing workflow instances.", - "properties": { - "data": { - "description": "A list of workflow instances.", - "items": { - "additionalProperties": {}, - "description": "An item in the workflow instances list.", - "properties": { - "id": { - "description": "The ID of the workflow instance", - "type": "string" + "type": "object" + } + }, + "type": "object" + }, + "WorkflowInstanceCreateResponseData": { + "additionalProperties": {}, + "description": "Data about the created workflow instance.", + "properties": { + "id": { + "description": "The ID of the workflow execution. It can be used to fetch the execution status.", + "type": "string" + } + }, + "type": "object" + }, + "WorkflowInstanceListItem": { + "additionalProperties": {}, + "description": "An item in the workflow instances list.", + "properties": { + "id": { + "description": "The ID of the workflow instance", + "type": "string" + } + }, + "type": "object" + }, + "WorkflowListInstancesResponse": { + "additionalProperties": {}, + "description": "Response returned when listing workflow instances.", + "properties": { + "data": { + "description": "A list of workflow instances.", + "items": { + "additionalProperties": {}, + "description": "An item in the workflow instances list.", + "properties": { + "id": { + "description": "The ID of the workflow instance", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "additionalProperties": {}, + "description": "Metadata about the instances list", + "properties": { + "page": { + "additionalProperties": {}, + "description": "Page information for the list instances response.", + "properties": { + "totalCount": { + "description": "The total count of items.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "WorkflowListInstancesResponseMeta": { + "additionalProperties": {}, + "description": "Metadata about the instances list", + "properties": { + "page": { + "additionalProperties": {}, + "description": "Page information for the list instances response.", + "properties": { + "totalCount": { + "description": "The total count of items.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "WorkflowListInstancesResponseMetaPage": { + "additionalProperties": {}, + "description": "Page information for the list instances response.", + "properties": { + "totalCount": { + "description": "The total count of items.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "WorklflowCancelInstanceResponse": { + "description": "Information about the canceled instance.", + "properties": { + "data": { + "description": "Data about the canceled instance.", + "properties": { + "id": { + "description": "The id of the canceled instance", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "WorklflowCancelInstanceResponseData": { + "description": "Data about the canceled instance.", + "properties": { + "id": { + "description": "The id of the canceled instance", + "type": "string" + } + }, + "type": "object" + }, + "WorklflowGetInstanceResponse": { + "additionalProperties": {}, + "description": "The state of the given workflow instance.", + "properties": { + "data": { + "additionalProperties": {}, + "description": "The data of the instance response.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "The attributes of the instance response data.", + "properties": { + "id": { + "description": "The id of the instance.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "WorklflowGetInstanceResponseData": { + "additionalProperties": {}, + "description": "The data of the instance response.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "The attributes of the instance response data.", + "properties": { + "id": { + "description": "The id of the instance.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "WorklflowGetInstanceResponseDataAttributes": { + "additionalProperties": {}, + "description": "The attributes of the instance response data.", + "properties": { + "id": { + "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. Defaults to `[]`.", + "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. Defaults to `include_only`.", + "oneOf": [ + { + "description": "Include all services.", + "properties": { + "include_all": { + "description": "Include all services.", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services. Defaults to `[]`.", + "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": { + "AuthZ": { + "description": "This API uses OAuth 2 with the implicit grant flow.", + "flows": { + "authorizationCode": { + "authorizationUrl": "/oauth2/v1/authorize", + "scopes": { + "apm_api_catalog_read": "View API catalog and API definitions.", + "apm_api_catalog_write": "Add, modify, and delete API catalog definitions.", + "apm_read": "Read and query APM and Trace Analytics.", + "apm_service_catalog_read": "View service catalog and service definitions.", + "apm_service_catalog_write": "Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog.", + "cases_read": "View Cases.", + "cases_write": "Create and update cases.", + "ci_visibility_pipelines_write": "Create CI Visibility pipeline spans using the API.", + "ci_visibility_read": "View CI Visibility.", + "cloud_cost_management_read": "View Cloud Cost pages. This does not restrict access to the cloud cost data source in dashboards and notebooks.", + "cloud_cost_management_write": "Configure cloud cost accounts and global customizations.", + "code_analysis_read": "View Code Analysis.", + "continuous_profiler_pgo_read": "Read and query Continuous Profiler data for Profile-Guided Optimization (PGO).", + "create_webhooks": "Create webhooks integrations.", + "dashboards_public_share": "Generate public and authenticated links to share dashboards or embeddable graphs externally.", + "dashboards_read": "View dashboards.", + "dashboards_write": "Create and change dashboards.", + "data_scanner_read": "View Data Scanner configurations.", + "data_scanner_write": "Edit Data Scanner configurations.", + "events_read": "Read Events data.", + "hosts_read": "List hosts and their attributes.", + "incident_notification_settings_write": "Configure Incidents Notification settings.", + "incident_read": "View incidents in Datadog.", + "incident_settings_write": "Configure Incident Settings.", + "incident_write": "Create, view, and manage incidents in Datadog.", + "metrics_read": "View custom metrics.", + "monitors_downtime": "Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes.", + "monitors_read": "View monitors.", + "monitors_write": "Edit and delete individual monitors.", + "org_management": "Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization.", + "security_monitoring_filters_read": "Read Security Filters.", + "security_monitoring_filters_write": "Create, edit, and delete Security Filters.", + "security_monitoring_findings_read": "View a list of findings that include both misconfigurations and identity risks.", + "security_monitoring_rules_read": "Read Detection Rules.", + "security_monitoring_rules_write": "Create and edit Detection Rules.", + "security_monitoring_signals_read": "View Security Signals.", + "security_monitoring_suppressions_read": "Read Rule Suppressions.", + "security_monitoring_suppressions_write": "Write Rule Suppressions.", + "security_pipelines_read": "View Security Pipelines.", + "security_pipelines_write": "Create, edit, and delete CSM Security Pipelines.", + "slos_corrections": "Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs.", + "slos_read": "View SLOs and status corrections.", + "slos_write": "Create, edit, and delete SLOs.", + "synthetics_global_variable_read": "View, search, and use Synthetics global variables.", + "synthetics_global_variable_write": "Create, edit, and delete global variables for Synthetics.", + "synthetics_private_location_read": "View, search, and use Synthetics private locations.", + "synthetics_private_location_write": "Create and delete private locations in addition to having access to the associated installation guidelines.", + "synthetics_read": "List and view configured Synthetic tests and test results.", + "synthetics_write": "Create, edit, and delete Synthetic tests.", + "teams_manage": "Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission.", + "teams_read": "Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team.", + "test_visibility_read": "View Test Visibility.", + "timeseries_query": "Query Timeseries data.", + "usage_read": "View your organization's usage and usage attribution.", + "user_access_invite": "Invite other users to your organization.", + "user_access_manage": "Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries.", + "user_access_read": "View users and their roles and settings.", + "workflows_read": "View workflows.", + "workflows_run": "Run workflows.", + "workflows_write": "Create, edit, and delete workflows." + }, + "tokenUrl": "/oauth2/v1/token" + } + }, + "type": "oauth2" + }, + "apiKeyAuth": { + "description": "Your Datadog API Key.", + "in": "header", + "name": "DD-API-KEY", + "type": "apiKey", + "x-env-name": "DD_API_KEY" + }, + "appKeyAuth": { + "description": "Your Datadog APP Key.", + "in": "header", + "name": "DD-APPLICATION-KEY", + "type": "apiKey", + "x-env-name": "DD_APP_KEY" + }, + "bearerAuth": { + "in": "header", + "name": "Authorization", + "scheme": "bearer", + "type": "http", + "x-env-name": "DD_BEARER_TOKEN" + } + } + }, + "info": { + "contact": { + "email": "support@datadoghq.com", + "name": "Datadog Support", + "url": "https://www.datadoghq.com/support/" + }, + "description": "Collection of all Datadog Public endpoints.", + "title": "Datadog API V2 Collection", + "version": "1.0" + }, + "openapi": "3.0.0", + "paths": { + "/api/v2/actions/connections": { + "post": { + "description": "Create a new Action Connection", + "operationId": "CreateActionConnection", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request used to create an action connection.", + "properties": { + "data": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "The response for a created connection", + "properties": { + "data": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Successfully created Action Connection" + }, + "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" + } + }, + "summary": "Create a new Action Connection", + "tags": [ + "Action Connection" + ], + "x-given": { + "action_connection": { + "parameters": [ + { + "name": "body", + "value": "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": {\n \"name\": \"Cassette Connection DELETE\",\n \"integration\": {\n \"type\": \"AWS\",\n \"credentials\": {\n \"type\": \"AWSAssumeRole\",\n \"role\": \"MyRole\",\n \"account_id\": \"123456789123\"\n }\n }\n }\n }\n}" + } + ], + "step": "there is a valid \"action_connection\" in the system" + } + }, + "x-menu-order": 2, + "x-undo": { + "operationId": "DeleteActionConnection", + "parameters": [ + { + "name": "connection_id", + "source": "data.id" + } + ], + "type": "unsafe" + } + } + }, + "/api/v2/actions/connections/{connection_id}": { + "delete": { + "description": "Delete an existing Action Connection", + "operationId": "DeleteActionConnection", + "parameters": [ + { + "description": "The ID of the action connection", + "in": "path", + "name": "connection_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + }, + "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" + } + }, + "summary": "Delete an existing Action Connection", + "tags": [ + "Action Connection" + ], + "x-menu-order": 4, + "x-permission": { + "operator": "OR", + "permissions": [ + "connection_write" + ] + }, + "x-undo": { + "type": "idempotent" + } + }, + "get": { + "description": "Get an existing Action Connection", + "operationId": "GetActionConnection", + "parameters": [ + { + "description": "The ID of the action connection", + "in": "path", + "name": "connection_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The response for found connection", + "properties": { + "data": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Successfully get Action Connection" + }, + "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" } - }, - "type": "object" + } }, - "type": "array" + "description": "Bad Request" }, - "meta": { - "additionalProperties": {}, - "description": "Metadata about the instances list", - "properties": { - "page": { - "additionalProperties": {}, - "description": "Page information for the list instances response.", - "properties": { - "totalCount": { - "description": "The total count of items.", - "format": "int64", - "type": "integer" - } - }, - "type": "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" + } } }, - "type": "object" - } - }, - "type": "object" - }, - "WorkflowListInstancesResponseMeta": { - "additionalProperties": {}, - "description": "Metadata about the instances list", - "properties": { - "page": { - "additionalProperties": {}, - "description": "Page information for the list instances response.", - "properties": { - "totalCount": { - "description": "The total count of items.", - "format": "int64", - "type": "integer" + "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" + } } }, - "type": "object" - } - }, - "type": "object" - }, - "WorkflowListInstancesResponseMetaPage": { - "additionalProperties": {}, - "description": "Page information for the list instances response.", - "properties": { - "totalCount": { - "description": "The total count of items.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "WorklflowCancelInstanceResponse": { - "description": "Information about the canceled instance.", - "properties": { - "data": { - "description": "Data about the canceled instance.", - "properties": { - "id": { - "description": "The id of the canceled instance", - "type": "string" + "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" + } } }, - "type": "object" + "description": "Too many requests" } }, - "type": "object" + "summary": "Get an existing Action Connection", + "tags": [ + "Action Connection" + ], + "x-menu-order": 1, + "x-undo": { + "type": "safe" + } }, - "WorklflowCancelInstanceResponseData": { - "description": "Data about the canceled instance.", - "properties": { - "id": { - "description": "The id of the canceled instance", - "type": "string" + "patch": { + "description": "Update an existing Action Connection", + "operationId": "UpdateActionConnection", + "parameters": [ + { + "description": "The ID of the action connection", + "in": "path", + "name": "connection_id", + "required": true, + "schema": { + "type": "string" + } } - }, - "type": "object" - }, - "WorklflowGetInstanceResponse": { - "additionalProperties": {}, - "description": "The state of the given workflow instance.", - "properties": { - "data": { - "additionalProperties": {}, - "description": "The data of the instance response.", - "properties": { - "attributes": { - "additionalProperties": {}, - "description": "The attributes of the instance response data.", + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request used to update an action connection.", "properties": { - "id": { - "description": "The id of the instance.", - "type": "string" + "data": { + "description": "Data related to the connection update.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributesUpdate` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegrationUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegrationUpdate` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRoleUpdate` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "generate_new_external_id": { + "description": "The `AWSAssumeRoleUpdate` `generate_new_external_id`.", + "type": "boolean" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegrationUpdate` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuthUpdate` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuthUpdate` `headers`.", + "items": { + "description": "The definition of `HTTPHeaderUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuthUpdate` `tokens`.", + "items": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "type", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuthUpdate` `url_parameters`.", + "items": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" } }, + "required": [ + "data" + ], "type": "object" } - }, - "type": "object" - } + } + }, + "description": "Update an existing Action Connection request body", + "required": true }, - "type": "object" - }, - "WorklflowGetInstanceResponseData": { - "additionalProperties": {}, - "description": "The data of the instance response.", - "properties": { - "attributes": { - "additionalProperties": {}, - "description": "The attributes of the instance response data.", - "properties": { - "id": { - "description": "The id of the instance.", - "type": "string" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The response for an updated connection.", + "properties": { + "data": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "type": "object" + } } }, - "type": "object" - } - }, - "type": "object" - }, - "WorklflowGetInstanceResponseDataAttributes": { - "additionalProperties": {}, - "description": "The attributes of the instance response data.", - "properties": { - "id": { - "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. Defaults to `[]`.", - "nullable": true, - "properties": { - "include_only": { - "description": "Include only these services.", - "example": [ - "AWS/AppSync" - ], - "items": { - "example": "AWS/AppSync", - "type": "string" + "description": "Successfully updated Action Connection" + }, + "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" + } + } }, - "type": "array" - } - }, - "required": [ - "include_only" - ] - }, - "XRayServicesList": { - "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", - "oneOf": [ - { - "description": "Include all services.", - "properties": { - "include_all": { - "description": "Include all services.", - "example": false, - "type": "boolean" + "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" + } } }, - "required": [ - "include_all" - ] + "description": "Forbidden" }, - { - "description": "Include only these services. Defaults to `[]`.", - "nullable": true, - "properties": { - "include_only": { - "description": "Include only these services.", - "example": [ - "AWS/AppSync" - ], - "items": { - "example": "AWS/AppSync", - "type": "string" - }, - "type": "array" + "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" + } } }, - "required": [ - "include_only" - ] - } - ] - } - }, - "securitySchemes": { - "AuthZ": { - "description": "This API uses OAuth 2 with the implicit grant flow.", - "flows": { - "authorizationCode": { - "authorizationUrl": "/oauth2/v1/authorize", - "scopes": { - "apm_api_catalog_read": "View API catalog and API definitions.", - "apm_api_catalog_write": "Add, modify, and delete API catalog definitions.", - "apm_read": "Read and query APM and Trace Analytics.", - "apm_service_catalog_read": "View service catalog and service definitions.", - "apm_service_catalog_write": "Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog.", - "cases_read": "View Cases.", - "cases_write": "Create and update cases.", - "ci_visibility_pipelines_write": "Create CI Visibility pipeline spans using the API.", - "ci_visibility_read": "View CI Visibility.", - "cloud_cost_management_read": "View Cloud Cost pages. This does not restrict access to the cloud cost data source in dashboards and notebooks.", - "cloud_cost_management_write": "Configure cloud cost accounts and global customizations.", - "code_analysis_read": "View Code Analysis.", - "continuous_profiler_pgo_read": "Read and query Continuous Profiler data for Profile-Guided Optimization (PGO).", - "create_webhooks": "Create webhooks integrations.", - "dashboards_public_share": "Generate public and authenticated links to share dashboards or embeddable graphs externally.", - "dashboards_read": "View dashboards.", - "dashboards_write": "Create and change dashboards.", - "data_scanner_read": "View Data Scanner configurations.", - "data_scanner_write": "Edit Data Scanner configurations.", - "events_read": "Read Events data.", - "hosts_read": "List hosts and their attributes.", - "incident_notification_settings_write": "Configure Incidents Notification settings.", - "incident_read": "View incidents in Datadog.", - "incident_settings_write": "Configure Incident Settings.", - "incident_write": "Create, view, and manage incidents in Datadog.", - "metrics_read": "View custom metrics.", - "monitors_downtime": "Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes.", - "monitors_read": "View monitors.", - "monitors_write": "Edit and delete individual monitors.", - "org_management": "Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization.", - "security_monitoring_filters_read": "Read Security Filters.", - "security_monitoring_filters_write": "Create, edit, and delete Security Filters.", - "security_monitoring_findings_read": "View a list of findings that include both misconfigurations and identity risks.", - "security_monitoring_rules_read": "Read Detection Rules.", - "security_monitoring_rules_write": "Create and edit Detection Rules.", - "security_monitoring_signals_read": "View Security Signals.", - "security_monitoring_suppressions_read": "Read Rule Suppressions.", - "security_monitoring_suppressions_write": "Write Rule Suppressions.", - "security_pipelines_read": "View Security Pipelines.", - "security_pipelines_write": "Create, edit, and delete CSM Security Pipelines.", - "slos_corrections": "Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs.", - "slos_read": "View SLOs and status corrections.", - "slos_write": "Create, edit, and delete SLOs.", - "synthetics_global_variable_read": "View, search, and use Synthetics global variables.", - "synthetics_global_variable_write": "Create, edit, and delete global variables for Synthetics.", - "synthetics_private_location_read": "View, search, and use Synthetics private locations.", - "synthetics_private_location_write": "Create and delete private locations in addition to having access to the associated installation guidelines.", - "synthetics_read": "List and view configured Synthetic tests and test results.", - "synthetics_write": "Create, edit, and delete Synthetic tests.", - "teams_manage": "Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission.", - "teams_read": "Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team.", - "test_visibility_read": "View Test Visibility.", - "timeseries_query": "Query Timeseries data.", - "usage_read": "View your organization's usage and usage attribution.", - "user_access_invite": "Invite other users to your organization.", - "user_access_manage": "Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries.", - "user_access_read": "View users and their roles and settings.", - "workflows_read": "View workflows.", - "workflows_run": "Run workflows.", - "workflows_write": "Create, edit, and delete workflows." + "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" + } + } }, - "tokenUrl": "/oauth2/v1/token" + "description": "Too many requests" } }, - "type": "oauth2" - }, - "apiKeyAuth": { - "description": "Your Datadog API Key.", - "in": "header", - "name": "DD-API-KEY", - "type": "apiKey", - "x-env-name": "DD_API_KEY" - }, - "appKeyAuth": { - "description": "Your Datadog APP Key.", - "in": "header", - "name": "DD-APPLICATION-KEY", - "type": "apiKey", - "x-env-name": "DD_APP_KEY" - }, - "bearerAuth": { - "in": "header", - "name": "Authorization", - "scheme": "bearer", - "type": "http", - "x-env-name": "DD_BEARER_TOKEN" + "summary": "Update an existing Action Connection", + "tags": [ + "Action Connection" + ], + "x-menu-order": 3, + "x-undo": { + "type": "idempotent" + } } - } - }, - "info": { - "contact": { - "email": "support@datadoghq.com", - "name": "Datadog Support", - "url": "https://www.datadoghq.com/support/" }, - "description": "Collection of all Datadog Public endpoints.", - "title": "Datadog API V2 Collection", - "version": "1.0" - }, - "openapi": "3.0.0", - "paths": { "/api/v2/api_keys": { "get": { "description": "List all API keys available for your account.", @@ -371594,6 +377802,14 @@ }, "name": "AWS Logs Integration" }, + { + "description": "Action connections extend your installed integrations and allow you to take action in your third-party systems\n(e.g. AWS, Gitlab, and Statuspage) with Datadog’s Workflow Automation and App Builder products.\n\nDatadog’s Integrations automatically provide authentication for Slack, Microsoft Teams, PagerDuty, Opsgenie,\nJIRA, GitHub, and Statuspage. You do not need additional connections in order to access these tools within\nWorkflow Automation and App Builder.\n\nWe offer granular access control for editing and resolving connections.", + "externalDocs": { + "description": "Find out more at", + "url": "https://docs.datadoghq.com/service_management/workflows/connections/" + }, + "name": "Action Connection" + }, { "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 39b42bcdeaf05..15452b4f30566 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1,4 +1,24 @@ { + "CreateActionConnection": { + "description": "Create a new Action Connection", + "summary": "Create a new Action Connection", + "request_description": "", + "request_schema_description": "Request used to create an action connection." + }, + "DeleteActionConnection": { + "description": "Delete an existing Action Connection", + "summary": "Delete an existing Action Connection" + }, + "GetActionConnection": { + "description": "Get an existing Action Connection", + "summary": "Get an existing Action Connection" + }, + "UpdateActionConnection": { + "description": "Update an existing Action Connection", + "summary": "Update an existing Action Connection", + "request_description": "Update an existing Action Connection request body", + "request_schema_description": "Request used to update an action connection." + }, "ListAPIKeys": { "description": "List all API keys available for your account.", "summary": "Get all API keys" diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index b139d32c645e7..9a1e38234ac0a 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -15,6 +15,10 @@ "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)." }, + "action-connection": { + "name": "Action Connection", + "description": "Action connections extend your installed integrations and allow you to take action in your third-party systems\n(e.g. AWS, Gitlab, and Statuspage) with Datadog’s Workflow Automation and App Builder products.\n\nDatadog’s Integrations automatically provide authentication for Slack, Microsoft Teams, PagerDuty, Opsgenie,\nJIRA, GitHub, and Statuspage. You do not need additional connections in order to access these tools within\nWorkflow Automation and App Builder.\n\nWe offer granular access control for editing and resolving connections." + }, "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 03c871f36c8da..9ce3ae2693a07 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -310,6 +310,15 @@ "type": "string" } }, + "ConnectionId": { + "description": "The ID of the action connection", + "in": "path", + "name": "connection_id", + "required": true, + "schema": { + "type": "string" + } + }, "CustomDestinationId": { "description": "The ID of the custom destination.", "in": "path", @@ -6754,6 +6763,97 @@ ], "type": "object" }, + "AWSAssumeRole": { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + }, + "AWSAssumeRoleType": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + }, + "AWSAssumeRoleUpdate": { + "description": "The definition of `AWSAssumeRoleUpdate` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "generate_new_external_id": { + "description": "The `AWSAssumeRoleUpdate` `generate_new_external_id`.", + "type": "boolean" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, "AWSAuthConfig": { "description": "AWS Authentication config.", "oneOf": [ @@ -6841,6 +6941,238 @@ ], "type": "object" }, + "AWSCredentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "AWSCredentialsUpdate": { + "description": "The definition of `AWSCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRoleUpdate` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "generate_new_external_id": { + "description": "The `AWSAssumeRoleUpdate` `generate_new_external_id`.", + "type": "boolean" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "AWSIntegration": { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + "AWSIntegrationType": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + }, + "AWSIntegrationUpdate": { + "description": "The definition of `AWSIntegrationUpdate` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRoleUpdate` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "generate_new_external_id": { + "description": "The `AWSAssumeRoleUpdate` `generate_new_external_id`.", + "type": "boolean" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, "AWSLambdaForwarderConfig": { "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { @@ -7612,1346 +7944,1663 @@ }, "type": "object" }, - "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" - }, - "ActiveBillingDimensionsResponse": { - "description": "Active billing dimensions response.", - "properties": { - "data": { - "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" - } - }, - "type": "object" - }, - "ActiveBillingDimensionsType": { - "default": "billing_dimensions", - "description": "Type of active billing dimensions data.", - "enum": [ - "billing_dimensions" - ], - "type": "string", - "x-enum-varnames": [ - "BILLING_DIMENSIONS" - ] - }, - "Advisory": { - "description": "Advisory.", - "properties": { - "base_severity": { - "description": "Advisory base severity.", - "example": "Critical", - "type": "string" - }, - "id": { - "description": "Advisory id.", - "example": "GHSA-4wrc-f8pq-fpqp", - "type": "string" - }, - "severity": { - "description": "Advisory Datadog severity.", - "example": "Medium", - "type": "string" - } - }, - "required": [ - "id", - "base_severity" - ], - "type": "object" - }, - "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" - ], - "example": "apm_retention_filter", - "type": "string", - "x-enum-varnames": [ - "apm_retention_filter" - ] - }, - "ApplicationKeyCreateAttributes": { - "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" - ], - "items": { - "description": "Name of scope.", - "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" - ], - "items": { - "description": "Name of scope.", - "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" - ] - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } - }, - "ApplicationKeyCreateRequest": { - "description": "Request used to create an application key.", + "ActionConnectionAttributes": { + "description": "The definition of `ActionConnectionAttributes` object.", "properties": { - "data": { - "description": "Object used to create an application key.", - "properties": { - "attributes": { - "description": "Attributes used to create an application Key.", + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", "properties": { - "name": { - "description": "Name of the application key.", - "example": "Application Key for managing dashboards", - "type": "string" + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] }, - "scopes": { - "description": "Array of scopes to grant the application key.", - "example": [ - "dashboards_read", - "dashboards_write", - "dashboards_public_share" + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" ], - "items": { - "description": "Name of scope.", - "type": "string" - }, - "nullable": true, - "type": "array" + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] } }, "required": [ - "name" + "type", + "credentials" ], - "type": "object", - "x-merge-override": { - "properties": false - } + "type": "object" }, - "type": { - "default": "application_keys", - "description": "Application Keys resource type.", - "enum": [ - "application_keys" - ], - "example": "application_keys", - "type": "string", - "x-enum-varnames": [ - "APPLICATION_KEYS" - ] - } - }, - "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.", - "properties": { - "data": { - "description": "Relationship to user object.", + { + "description": "The definition of `HTTPIntegration` object.", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", "type": "string" }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "The definition of `HTTPIntegrationType` object.", "enum": [ - "users" + "HTTP" ], - "example": "users", + "example": "HTTP", "type": "string", "x-enum-varnames": [ - "USERS" + "HTTP" ] } }, "required": [ - "id", - "type" + "type", + "base_url", + "credentials" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } - }, - "required": [ - "data" - ], - "type": "object" + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" } }, - "type": "object", - "x-merge-override": { - "properties": false - } + "required": [ + "name", + "integration" + ], + "type": "object" }, - "ApplicationKeyResponse": { - "description": "Response for retrieving an application key.", + "ActionConnectionAttributesUpdate": { + "description": "The definition of `ActionConnectionAttributesUpdate` object.", "properties": { - "data": { - "description": "Datadog application key.", - "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 - }, - "last4": { - "description": "The last four characters of the application key.", - "example": "abcd", - "maxLength": 4, - "minLength": 4, - "readOnly": true, - "type": "string", - "x-secret": true - }, - "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": "ID of the application key.", - "type": "string" - }, - "relationships": { - "description": "Resources related to the application key.", + "integration": { + "description": "The definition of `ActionConnectionIntegrationUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegrationUpdate` object.", "properties": { - "owned_by": { - "description": "Relationship to user.", - "properties": { - "data": { - "description": "Relationship to user object.", + "credentials": { + "description": "The definition of `AWSCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "generate_new_external_id": { + "description": "The `AWSAssumeRoleUpdate` `generate_new_external_id`.", + "type": "boolean" + }, + "role": { + "description": "Role to assume", + "example": "my-role", "type": "string" }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "The definition of `AWSAssumeRoleType` object.", "enum": [ - "users" + "AWSAssumeRole" ], - "example": "users", + "example": "AWSAssumeRole", "type": "string", "x-enum-varnames": [ - "USERS" + "AWSASSUMEROLE" ] } }, "required": [ - "id", "type" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" } - }, - "required": [ - "data" + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" ], - "type": "object" + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] } }, - "type": "object", - "x-merge-override": { - "properties": false - } - }, - "type": { - "default": "application_keys", - "description": "Application Keys resource type.", - "enum": [ - "application_keys" + "required": [ + "type" ], - "example": "application_keys", - "type": "string", - "x-enum-varnames": [ - "APPLICATION_KEYS" - ] - } - }, - "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.", - "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.", + "type": "object" + }, + { + "description": "The definition of `HTTPIntegrationUpdate` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuthUpdate` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuthUpdate` `headers`.", + "items": { + "description": "The definition of `HTTPHeaderUpdate` object.", "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuthUpdate` `tokens`.", + "items": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", "type": "string" }, "type": { - "default": "orgs", - "description": "Organizations resource type.", + "description": "The definition of `TokenType` object.", "enum": [ - "orgs" + "SECRET" ], - "example": "orgs", + "example": "SECRET", "type": "string", "x-enum-varnames": [ - "ORGS" + "SECRET" ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" } }, "required": [ - "id", - "type" + "name", + "type", + "value" ], "type": "object" - } + }, + "type": "array" }, - "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" - ] - } + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuthUpdate` `url_parameters`.", + "items": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" }, - "required": [ - "id", - "type" - ], - "type": "object" + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + } }, - "other_users": { - "description": "Relationship to users.", - "properties": { - "data": { - "description": "Relationships to user objects.", - "example": [], - "items": { - "description": "Relationship to user object.", + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "type": "object" + }, + "ActionConnectionData": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", "type": "string" }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" } }, - "required": [ - "id", - "type" - ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, - "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" + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] - } + "required": [ + "name", + "value" + ], + "type": "object" }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "array" }, - "type": "array" - } - }, - "type": "object", - "x-merge-override": { - "required": false + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" } - } + ] }, - "type": "object", - "x-merge-override": { - "properties": false + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] } }, - "type": { - "default": "users", - "description": "Users resource type.", - "enum": [ - "users" - ], - "example": "users", - "type": "string", - "x-enum-varnames": [ - "USERS" - ] - } - }, - "type": "object", - "x-merge-override": { - "required": false + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" } - }, - { - "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" - } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + }, + "ActionConnectionDataType": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + }, + "ActionConnectionDataUpdate": { + "description": "Data related to the connection update.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributesUpdate` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegrationUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegrationUpdate` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRoleUpdate` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "generate_new_external_id": { + "description": "The `AWSAssumeRoleUpdate` `generate_new_external_id`.", + "type": "boolean" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] }, - "type": "object" - }, - "id": { - "description": "The unique identifier of the role.", - "type": "string" + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } }, - "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.", + "required": [ + "type" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegrationUpdate` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuthUpdate` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", "properties": { - "id": { - "description": "ID of the permission.", + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", "type": "string" }, - "type": { - "default": "permissions", - "description": "Permissions resource type.", - "enum": [ - "permissions" - ], - "example": "permissions", - "type": "string", - "x-enum-varnames": [ - "PERMISSIONS" - ] + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, - "type": "array" - } - }, - "type": "object", - "x-merge-override": { - "required": false + "headers": { + "description": "The `HTTPTokenAuthUpdate` `headers`.", + "items": { + "description": "The definition of `HTTPHeaderUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuthUpdate` `tokens`.", + "items": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "type", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuthUpdate` `url_parameters`.", + "items": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" } - } + ] }, - "type": "object" + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } }, - "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": [ + "type" + ], + "type": "object" } - }, - { - "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" - } - ] + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } }, - "type": "array" + "type": "object" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] } }, + "required": [ + "type", + "attributes" + ], "type": "object" }, - "ApplicationKeyResponseIncludedItem": { - "description": "An object related to an application key.", + "ActionConnectionIntegration": { + "description": "The definition of `ActionConnectionIntegration` object.", "oneOf": [ { - "description": "User object returned by the API.", + "description": "The definition of `AWSIntegration` object.", "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" + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" } - }, - "type": "object" + ] }, - "id": { - "description": "ID of the user.", + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", "type": "string" }, - "relationships": { - "description": "Relationships of the user object returned by the API.", - "properties": { - "org": { - "description": "Relationship to an organization.", + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", "properties": { - "data": { - "description": "Relationship to organization object.", + "body": { + "description": "The definition of `HTTPBody` object.", "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", "type": "string" }, - "type": { - "default": "orgs", - "description": "Organizations resource type.", - "enum": [ - "orgs" - ], - "example": "orgs", - "type": "string", - "x-enum-varnames": [ - "ORGS" - ] + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" } }, - "required": [ - "id", - "type" - ], "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "other_orgs": { - "description": "Relationship to organizations.", - "properties": { - "data": { - "description": "Relationships to organization objects.", - "example": [], + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", "items": { - "description": "Relationship to organization object.", + "description": "The definition of `HTTPHeader` object.", "properties": { - "id": { - "description": "ID of the organization.", - "example": "00000000-0000-beef-0000-000000000000", + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", "type": "string" }, - "type": { - "default": "orgs", - "description": "Organizations resource type.", - "enum": [ - "orgs" - ], - "example": "orgs", - "type": "string", - "x-enum-varnames": [ - "ORGS" - ] + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" } }, "required": [ - "id", - "type" + "name", + "value" ], "type": "object" }, "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "other_users": { - "description": "Relationship to users.", - "properties": { - "data": { - "description": "Relationships to user objects.", - "example": [], + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", "items": { - "description": "Relationship to user object.", + "description": "The definition of `HTTPToken` object.", "properties": { - "id": { - "description": "A unique identifier that represents the user.", - "example": "00000000-0000-0000-2345-000000000000", + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", "type": "string" }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "The definition of `TokenType` object.", "enum": [ - "users" + "SECRET" ], - "example": "users", + "example": "SECRET", "type": "string", "x-enum-varnames": [ - "USERS" + "SECRET" ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" } }, "required": [ - "id", + "name", + "value", "type" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, "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.", + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", "items": { - "description": "Relationship to role object.", + "description": "The definition of `UrlParam` object.", "properties": { - "id": { - "description": "The unique identifier of the role.", - "example": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d", + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", "type": "string" }, - "type": { - "default": "roles", - "description": "Roles type.", - "enum": [ - "roles" - ], - "example": "roles", - "type": "string", - "x-enum-varnames": [ - "ROLES" - ] + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "name", + "value" + ], + "type": "object" }, "type": "array" } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "type" + ], + "type": "object" } - }, - "type": "object", - "x-merge-override": { - "properties": false - } + ] }, "type": { - "default": "users", - "description": "Users resource type.", + "description": "The definition of `HTTPIntegrationType` object.", "enum": [ - "users" + "HTTP" ], - "example": "users", + "example": "HTTP", "type": "string", "x-enum-varnames": [ - "USERS" + "HTTP" ] } }, - "type": "object", - "x-merge-override": { - "required": false - } - }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "ActionConnectionIntegrationUpdate": { + "description": "The definition of `ActionConnectionIntegrationUpdate` object.", + "oneOf": [ { - "description": "Role object returned by the API.", + "description": "The definition of `AWSIntegrationUpdate` object.", "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.", + "credentials": { + "description": "The definition of `AWSCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRoleUpdate` object.", "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" + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "generate_new_external_id": { + "description": "The `AWSAssumeRoleUpdate` `generate_new_external_id`.", + "type": "boolean" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] } }, - "type": "object", - "x-merge-override": { - "required": false - } + "required": [ + "type" + ], + "type": "object" } - }, - "type": "object" + ] }, "type": { - "default": "roles", - "description": "Roles type.", + "description": "The definition of `AWSIntegrationType` object.", "enum": [ - "roles" + "AWS" ], - "example": "roles", + "example": "AWS", "type": "string", "x-enum-varnames": [ - "ROLES" + "AWS" ] } }, "required": [ "type" ], - "type": "object", - "x-merge-override": { - "required": false - } + "type": "object" }, { - "description": "The definition of LeakedKey object.", + "description": "The definition of `HTTPIntegrationUpdate` 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", + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", "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" - } + "credentials": { + "description": "The definition of `HTTPCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuthUpdate` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuthUpdate` `headers`.", + "items": { + "description": "The definition of `HTTPHeaderUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuthUpdate` `tokens`.", + "items": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "type", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuthUpdate` `url_parameters`.", + "items": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } ] }, - "ApplicationKeyResponseMeta": { - "description": "Additional information related to the application key response.", + "ActiveBillingDimensionsAttributes": { + "description": "List of active billing dimensions.", "properties": { - "max_allowed_per_user": { - "description": "Max allowed number of application keys per user.", - "format": "int64", - "type": "integer" + "month": { + "description": "Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`.", + "format": "date-time", + "type": "string" }, - "page": { - "description": "Additional information related to the application key response.", + "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": { - "total_filtered_count": { - "description": "Total filtered application key count.", - "format": "int64", - "type": "integer" + "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" }, - "ApplicationKeyResponseMetaPage": { - "description": "Additional information related to the application key response.", + "ActiveBillingDimensionsResponse": { + "description": "Active billing dimensions response.", "properties": { - "total_filtered_count": { - "description": "Total filtered application key count.", - "format": "int64", - "type": "integer" + "data": { + "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" } }, "type": "object" }, - "ApplicationKeyUpdateAttributes": { - "description": "Attributes used to update an application Key.", + "ActiveBillingDimensionsType": { + "default": "billing_dimensions", + "description": "Type of active billing dimensions data.", + "enum": [ + "billing_dimensions" + ], + "type": "string", + "x-enum-varnames": [ + "BILLING_DIMENSIONS" + ] + }, + "Advisory": { + "description": "Advisory.", + "properties": { + "base_severity": { + "description": "Advisory base severity.", + "example": "Critical", + "type": "string" + }, + "id": { + "description": "Advisory id.", + "example": "GHSA-4wrc-f8pq-fpqp", + "type": "string" + }, + "severity": { + "description": "Advisory Datadog severity.", + "example": "Medium", + "type": "string" + } + }, + "required": [ + "id", + "base_severity" + ], + "type": "object" + }, + "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" + ], + "example": "apm_retention_filter", + "type": "string", + "x-enum-varnames": [ + "apm_retention_filter" + ] + }, + "ApplicationKeyCreateAttributes": { + "description": "Attributes used to create an application Key.", "properties": { "name": { "description": "Name of the application key.", @@ -8973,16 +9622,19 @@ "type": "array" } }, + "required": [ + "name" + ], "type": "object", "x-merge-override": { "properties": false } }, - "ApplicationKeyUpdateData": { - "description": "Object used to update an application key.", + "ApplicationKeyCreateData": { + "description": "Object used to create an application key.", "properties": { "attributes": { - "description": "Attributes used to update an application Key.", + "description": "Attributes used to create an application Key.", "properties": { "name": { "description": "Name of the application key.", @@ -9004,16 +9656,14 @@ "type": "array" } }, + "required": [ + "name" + ], "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.", @@ -9029,7 +9679,6 @@ }, "required": [ "attributes", - "id", "type" ], "type": "object", @@ -9037,14 +9686,14 @@ "required": false } }, - "ApplicationKeyUpdateRequest": { - "description": "Request used to update an application key.", + "ApplicationKeyCreateRequest": { + "description": "Request used to create an application key.", "properties": { "data": { - "description": "Object used to update an application key.", + "description": "Object used to create an application key.", "properties": { "attributes": { - "description": "Attributes used to update an application Key.", + "description": "Attributes used to create an application Key.", "properties": { "name": { "description": "Name of the application key.", @@ -9066,16 +9715,14 @@ "type": "array" } }, + "required": [ + "name" + ], "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.", @@ -9091,7 +9738,6 @@ }, "required": [ "attributes", - "id", "type" ], "type": "object", @@ -9105,856 +9751,2035 @@ ], "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" - ] - }, - "Asset": { - "description": "A single vulnerable asset", + "ApplicationKeyRelationships": { + "description": "Resources related to the application key.", "properties": { - "attributes": { - "description": "The JSON:API attributes of the asset.", + "owned_by": { + "description": "Relationship to user.", "properties": { - "arch": { - "description": "Asset architecture.", - "example": "arm64", - "type": "string" - }, - "environments": { - "description": "List of environments where the asset is deployed.", - "example": [ - "staging" - ], - "items": { - "example": "staging", - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Asset name.", - "example": "github.com/DataDog/datadog-agent.git", - "type": "string" - }, - "operating_system": { - "description": "Asset operating system.", + "data": { + "description": "Relationship to user object.", "properties": { - "description": { - "description": "Operating system version.", - "example": "24.04", - "type": "string" - }, - "name": { - "description": "Operating system name.", - "example": "ubuntu", + "id": { + "description": "A unique identifier that represents the user.", + "example": "00000000-0000-0000-2345-000000000000", "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "risks": { - "description": "Asset risks.", - "properties": { - "has_access_to_sensitive_data": { - "description": "Whether the asset has access to sensitive data or not.", - "example": false, - "type": "boolean" }, - "has_privileged_access": { - "description": "Whether the asset has privileged access or not.", - "example": false, - "type": "boolean" - }, - "in_production": { - "description": "Whether the asset is in production or not.", - "example": false, - "type": "boolean" - }, - "is_publicly_accessible": { - "description": "Whether the asset is publicly accessible or not.", - "example": false, - "type": "boolean" - }, - "under_attack": { - "description": "Whether the asset is under attack or not.", - "example": false, - "type": "boolean" + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] } }, "required": [ - "in_production" - ], - "type": "object" - }, - "type": { - "description": "The asset type", - "enum": [ - "Repository", - "Service", - "Host", - "HostImage", - "Image" + "id", + "type" ], - "example": "Repository", - "type": "string", - "x-enum-varnames": [ - "REPOSITORY", - "SERVICE", - "HOST", - "HOSTIMAGE", - "IMAGE" - ] - }, - "version": { - "description": "Asset version.", - "properties": { - "first": { - "description": "Asset first version.", - "example": "_latest", - "type": "string" - }, - "last": { - "description": "Asset last version.", - "example": "_latest", - "type": "string" - } - }, - "type": "object" - } - }, - "required": [ - "name", - "type", - "risks", - "environments" - ], - "type": "object" - }, - "id": { - "description": "The unique ID for this asset.", - "example": "Repository|github.com/DataDog/datadog-agent.git", - "type": "string" - }, - "type": { - "description": "The JSON:API type.", - "enum": [ - "assets" - ], - "example": "assets", - "type": "string", - "x-enum-varnames": [ - "ASSETS" - ] - } - }, - "required": [ - "id", - "type", - "attributes" - ], - "type": "object" - }, - "AssetAttributes": { - "description": "The JSON:API attributes of the asset.", - "properties": { - "arch": { - "description": "Asset architecture.", - "example": "arm64", - "type": "string" - }, - "environments": { - "description": "List of environments where the asset is deployed.", - "example": [ - "staging" - ], - "items": { - "example": "staging", - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Asset name.", - "example": "github.com/DataDog/datadog-agent.git", - "type": "string" - }, - "operating_system": { - "description": "Asset operating system.", - "properties": { - "description": { - "description": "Operating system version.", - "example": "24.04", - "type": "string" - }, - "name": { - "description": "Operating system name.", - "example": "ubuntu", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "risks": { - "description": "Asset risks.", - "properties": { - "has_access_to_sensitive_data": { - "description": "Whether the asset has access to sensitive data or not.", - "example": false, - "type": "boolean" - }, - "has_privileged_access": { - "description": "Whether the asset has privileged access or not.", - "example": false, - "type": "boolean" - }, - "in_production": { - "description": "Whether the asset is in production or not.", - "example": false, - "type": "boolean" - }, - "is_publicly_accessible": { - "description": "Whether the asset is publicly accessible or not.", - "example": false, - "type": "boolean" - }, - "under_attack": { - "description": "Whether the asset is under attack or not.", - "example": false, - "type": "boolean" + "type": "object", + "x-merge-override": { + "required": false + } } }, "required": [ - "in_production" - ], - "type": "object" - }, - "type": { - "description": "The asset type", - "enum": [ - "Repository", - "Service", - "Host", - "HostImage", - "Image" + "data" ], - "example": "Repository", - "type": "string", - "x-enum-varnames": [ - "REPOSITORY", - "SERVICE", - "HOST", - "HOSTIMAGE", - "IMAGE" - ] - }, - "version": { - "description": "Asset version.", - "properties": { - "first": { - "description": "Asset first version.", - "example": "_latest", - "type": "string" - }, - "last": { - "description": "Asset last version.", - "example": "_latest", - "type": "string" - } - }, "type": "object" } }, - "required": [ - "name", - "type", - "risks", - "environments" - ], - "type": "object" - }, - "AssetAttributesOperatingSystem": { - "description": "Asset operating system.", - "properties": { - "description": { - "description": "Operating system version.", - "example": "24.04", - "type": "string" - }, - "name": { - "description": "Operating system name.", - "example": "ubuntu", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "AssetAttributesRisks": { - "description": "Asset risks.", - "properties": { - "has_access_to_sensitive_data": { - "description": "Whether the asset has access to sensitive data or not.", - "example": false, - "type": "boolean" - }, - "has_privileged_access": { - "description": "Whether the asset has privileged access or not.", - "example": false, - "type": "boolean" - }, - "in_production": { - "description": "Whether the asset is in production or not.", - "example": false, - "type": "boolean" - }, - "is_publicly_accessible": { - "description": "Whether the asset is publicly accessible or not.", - "example": false, - "type": "boolean" - }, - "under_attack": { - "description": "Whether the asset is under attack or not.", - "example": false, - "type": "boolean" - } - }, - "required": [ - "in_production" - ], - "type": "object" - }, - "AssetAttributesVersion": { - "description": "Asset version.", - "properties": { - "first": { - "description": "Asset first version.", - "example": "_latest", - "type": "string" - }, - "last": { - "description": "Asset last version.", - "example": "_latest", - "type": "string" - } - }, - "type": "object" - }, - "AssetEntityType": { - "description": "The JSON:API type.", - "enum": [ - "assets" - ], - "example": "assets", - "type": "string", - "x-enum-varnames": [ - "ASSETS" - ] - }, - "AssetType": { - "description": "The asset type", - "enum": [ - "Repository", - "Service", - "Host", - "HostImage", - "Image" - ], - "example": "Repository", - "type": "string", - "x-enum-varnames": [ - "REPOSITORY", - "SERVICE", - "HOST", - "HOSTIMAGE", - "IMAGE" - ] + "type": "object", + "x-merge-override": { + "properties": false + } }, - "AuditLogsEvent": { - "description": "Object description of an Audit Logs event after it is processed and stored by Datadog.", + "ApplicationKeyResponse": { + "description": "Response for retrieving an application key.", "properties": { - "attributes": { - "description": "JSON object containing all event attributes and their associated values.", + "data": { + "description": "Datadog application key.", "properties": { "attributes": { - "additionalProperties": {}, - "description": "JSON object of attributes from Audit Logs events.", - "example": { - "customAttribute": 123, - "duration": 2345 + "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 + }, + "last4": { + "description": "The last four characters of the application key.", + "example": "abcd", + "maxLength": 4, + "minLength": 4, + "readOnly": true, + "type": "string", + "x-secret": true + }, + "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" - }, - "message": { - "description": "Message of the event.", - "type": "string" + "type": "object", + "x-merge-override": { + "properties": false + } }, - "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", + "id": { + "description": "ID of the application key.", "type": "string" }, - "tags": { - "description": "Array of tags associated with your event.", - "example": [ - "team:A" - ], - "items": { - "description": "Tag associated with your event.", - "type": "string" + "relationships": { + "description": "Resources related to the application key.", + "properties": { + "owned_by": { + "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": "array" + "type": "object", + "x-merge-override": { + "properties": false + } }, - "timestamp": { - "description": "Timestamp of your event.", - "example": "2019-01-02T09:42:36.320Z", - "format": "date-time", - "type": "string" + "type": { + "default": "application_keys", + "description": "Application Keys resource type.", + "enum": [ + "application_keys" + ], + "example": "application_keys", + "type": "string", + "x-enum-varnames": [ + "APPLICATION_KEYS" + ] } }, - "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" + "type": "object", + "x-merge-override": { + "required": false + } }, - "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.", + "included": { + "description": "Array of objects related to the application key.", "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.", + "description": "An object related to an application key.", + "oneOf": [ + { + "description": "User object returned by the API.", "properties": { "attributes": { - "additionalProperties": {}, - "description": "JSON object of attributes from Audit Logs events.", - "example": { - "customAttribute": 123, - "duration": 2345 + "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" }, - "message": { - "description": "Message of the event.", + "id": { + "description": "ID of the user.", "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", + "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 unique identifier of the role.", "type": "string" }, - "tags": { - "description": "Array of tags associated with your event.", - "example": [ - "team:A" + "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": { - "description": "Tag associated with your event.", - "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" }, - "timestamp": { - "description": "Timestamp of your event.", - "example": "2019-01-02T09:42:36.320Z", - "format": "date-time", + "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": "array" + } + }, + "type": "object" + }, + "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" + }, + "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" + } }, - "id": { - "description": "Unique ID of the event.", - "example": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", - "type": "string" + "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": { - "default": "audit", - "description": "Type of the event.", - "enum": [ - "audit" - ], - "example": "audit", - "type": "string", - "x-enum-varnames": [ - "Audit" - ] + "type": "object", + "x-merge-override": { + "properties": false } }, - "type": "object" + "type": { + "default": "users", + "description": "Users resource type.", + "enum": [ + "users" + ], + "example": "users", + "type": "string", + "x-enum-varnames": [ + "USERS" + ] + } }, - "type": "array" + "type": "object", + "x-merge-override": { + "required": false + } }, - "links": { - "description": "Links attributes.", + { + "description": "Role object returned by the API.", "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==", + "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" + ] } }, - "type": "object" + "required": [ + "type" + ], + "type": "object", + "x-merge-override": { + "required": false + } }, - "meta": { - "description": "The metadata associated with a request.", + { + "description": "The definition of LeakedKey object.", "properties": { - "elapsed": { - "description": "Time elapsed in milliseconds.", - "example": 132, - "format": "int64", - "type": "integer" - }, - "page": { - "description": "Paging attributes.", + "attributes": { + "description": "The definition of LeakedKeyAttributes object.", "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==", + "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" }, - "request_id": { - "description": "The identifier of the request.", - "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", + "id": { + "description": "The LeakedKey id.", + "example": "id", "type": "string" }, - "status": { - "description": "The status of the response.", + "type": { + "default": "leaked_keys", + "description": "The definition of LeakedKeyType object.", "enum": [ - "done", - "timeout" + "leaked_keys" ], - "example": "done", + "example": "leaked_keys", "type": "string", "x-enum-varnames": [ - "DONE", - "TIMEOUT" + "LEAKED_KEYS" ] - }, - "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" } }, + "required": [ + "attributes", + "id", + "type" + ], "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.", + "ApplicationKeyResponseMeta": { + "description": "Additional information related to the application key response.", "properties": { - "time_offset": { - "description": "Time offset (in seconds) to apply to the query.", + "max_allowed_per_user": { + "description": "Max allowed number of application keys per user.", "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" + "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" }, - "AuditLogsQueryPageOptions": { - "description": "Paging attributes for listing events.", + "ApplicationKeyResponseMetaPage": { + "description": "Additional information related to the application key response.", "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, + "total_filtered_count": { + "description": "Total filtered application key count.", + "format": "int64", "type": "integer" } }, "type": "object" }, - "AuditLogsResponseLinks": { - "description": "Links attributes.", + "ApplicationKeyUpdateAttributes": { + "description": "Attributes used to update an application Key.", "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==", + "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 + } }, - "AuditLogsResponseMetadata": { - "description": "The metadata associated with a request.", + "ApplicationKeyUpdateData": { + "description": "Object used to update an application key.", "properties": { - "elapsed": { - "description": "Time elapsed in milliseconds.", - "example": 132, - "format": "int64", - "type": "integer" - }, - "page": { - "description": "Paging attributes.", + "attributes": { + "description": "Attributes used to update an application Key.", "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==", + "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 + } }, - "request_id": { - "description": "The identifier of the request.", - "example": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", + "id": { + "description": "ID of the application key.", + "example": "00112233-4455-6677-8899-aabbccddeeff", "type": "string" }, - "status": { - "description": "The status of the response.", + "type": { + "default": "application_keys", + "description": "Application Keys resource type.", "enum": [ - "done", - "timeout" + "application_keys" ], - "example": "done", + "example": "application_keys", "type": "string", "x-enum-varnames": [ - "DONE", - "TIMEOUT" + "APPLICATION_KEYS" ] - }, - "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==", - "type": "string" } }, - "type": "object" - }, - "AuditLogsResponseStatus": { - "description": "The status of the response.", - "enum": [ - "done", - "timeout" + "required": [ + "attributes", + "id", + "type" ], - "example": "done", - "type": "string", - "x-enum-varnames": [ - "DONE", - "TIMEOUT" - ] + "type": "object", + "x-merge-override": { + "required": false + } }, - "AuditLogsSearchEventsRequest": { - "description": "The request for a Audit Logs events list.", + "ApplicationKeyUpdateRequest": { + "description": "Request used to update an application key.", "properties": { - "filter": { - "description": "Search and filter query settings.", + "data": { + "description": "Object used to update an application key.", "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", + "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": "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": [ + "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" + ] + }, + "Asset": { + "description": "A single vulnerable asset", + "properties": { + "attributes": { + "description": "The JSON:API attributes of the asset.", + "properties": { + "arch": { + "description": "Asset architecture.", + "example": "arm64", + "type": "string" + }, + "environments": { + "description": "List of environments where the asset is deployed.", + "example": [ + "staging" + ], + "items": { + "example": "staging", + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Asset name.", + "example": "github.com/DataDog/datadog-agent.git", + "type": "string" + }, + "operating_system": { + "description": "Asset operating system.", + "properties": { + "description": { + "description": "Operating system version.", + "example": "24.04", + "type": "string" + }, + "name": { + "description": "Operating system name.", + "example": "ubuntu", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "risks": { + "description": "Asset risks.", + "properties": { + "has_access_to_sensitive_data": { + "description": "Whether the asset has access to sensitive data or not.", + "example": false, + "type": "boolean" + }, + "has_privileged_access": { + "description": "Whether the asset has privileged access or not.", + "example": false, + "type": "boolean" + }, + "in_production": { + "description": "Whether the asset is in production or not.", + "example": false, + "type": "boolean" + }, + "is_publicly_accessible": { + "description": "Whether the asset is publicly accessible or not.", + "example": false, + "type": "boolean" + }, + "under_attack": { + "description": "Whether the asset is under attack or not.", + "example": false, + "type": "boolean" + } + }, + "required": [ + "in_production" + ], + "type": "object" + }, + "type": { + "description": "The asset type", + "enum": [ + "Repository", + "Service", + "Host", + "HostImage", + "Image" + ], + "example": "Repository", + "type": "string", + "x-enum-varnames": [ + "REPOSITORY", + "SERVICE", + "HOST", + "HOSTIMAGE", + "IMAGE" + ] + }, + "version": { + "description": "Asset version.", + "properties": { + "first": { + "description": "Asset first version.", + "example": "_latest", + "type": "string" + }, + "last": { + "description": "Asset last version.", + "example": "_latest", + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "name", + "type", + "risks", + "environments" + ], + "type": "object" + }, + "id": { + "description": "The unique ID for this asset.", + "example": "Repository|github.com/DataDog/datadog-agent.git", + "type": "string" + }, + "type": { + "description": "The JSON:API type.", + "enum": [ + "assets" + ], + "example": "assets", + "type": "string", + "x-enum-varnames": [ + "ASSETS" + ] + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "AssetAttributes": { + "description": "The JSON:API attributes of the asset.", + "properties": { + "arch": { + "description": "Asset architecture.", + "example": "arm64", + "type": "string" + }, + "environments": { + "description": "List of environments where the asset is deployed.", + "example": [ + "staging" + ], + "items": { + "example": "staging", + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Asset name.", + "example": "github.com/DataDog/datadog-agent.git", + "type": "string" + }, + "operating_system": { + "description": "Asset operating system.", + "properties": { + "description": { + "description": "Operating system version.", + "example": "24.04", + "type": "string" + }, + "name": { + "description": "Operating system name.", + "example": "ubuntu", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "risks": { + "description": "Asset risks.", + "properties": { + "has_access_to_sensitive_data": { + "description": "Whether the asset has access to sensitive data or not.", + "example": false, + "type": "boolean" + }, + "has_privileged_access": { + "description": "Whether the asset has privileged access or not.", + "example": false, + "type": "boolean" + }, + "in_production": { + "description": "Whether the asset is in production or not.", + "example": false, + "type": "boolean" + }, + "is_publicly_accessible": { + "description": "Whether the asset is publicly accessible or not.", + "example": false, + "type": "boolean" + }, + "under_attack": { + "description": "Whether the asset is under attack or not.", + "example": false, + "type": "boolean" + } + }, + "required": [ + "in_production" + ], + "type": "object" + }, + "type": { + "description": "The asset type", + "enum": [ + "Repository", + "Service", + "Host", + "HostImage", + "Image" + ], + "example": "Repository", + "type": "string", + "x-enum-varnames": [ + "REPOSITORY", + "SERVICE", + "HOST", + "HOSTIMAGE", + "IMAGE" + ] + }, + "version": { + "description": "Asset version.", + "properties": { + "first": { + "description": "Asset first version.", + "example": "_latest", + "type": "string" + }, + "last": { + "description": "Asset last version.", + "example": "_latest", + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "name", + "type", + "risks", + "environments" + ], + "type": "object" + }, + "AssetAttributesOperatingSystem": { + "description": "Asset operating system.", + "properties": { + "description": { + "description": "Operating system version.", + "example": "24.04", + "type": "string" + }, + "name": { + "description": "Operating system name.", + "example": "ubuntu", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "AssetAttributesRisks": { + "description": "Asset risks.", + "properties": { + "has_access_to_sensitive_data": { + "description": "Whether the asset has access to sensitive data or not.", + "example": false, + "type": "boolean" + }, + "has_privileged_access": { + "description": "Whether the asset has privileged access or not.", + "example": false, + "type": "boolean" + }, + "in_production": { + "description": "Whether the asset is in production or not.", + "example": false, + "type": "boolean" + }, + "is_publicly_accessible": { + "description": "Whether the asset is publicly accessible or not.", + "example": false, + "type": "boolean" + }, + "under_attack": { + "description": "Whether the asset is under attack or not.", + "example": false, + "type": "boolean" + } + }, + "required": [ + "in_production" + ], + "type": "object" + }, + "AssetAttributesVersion": { + "description": "Asset version.", + "properties": { + "first": { + "description": "Asset first version.", + "example": "_latest", + "type": "string" + }, + "last": { + "description": "Asset last version.", + "example": "_latest", + "type": "string" + } + }, + "type": "object" + }, + "AssetEntityType": { + "description": "The JSON:API type.", + "enum": [ + "assets" + ], + "example": "assets", + "type": "string", + "x-enum-varnames": [ + "ASSETS" + ] + }, + "AssetType": { + "description": "The asset type", + "enum": [ + "Repository", + "Service", + "Host", + "HostImage", + "Image" + ], + "example": "Repository", + "type": "string", + "x-enum-varnames": [ + "REPOSITORY", + "SERVICE", + "HOST", + "HOSTIMAGE", + "IMAGE" + ] + }, + "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", + "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": { + "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" + }, + "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" + } + }, + "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==", + "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" @@ -36231,6 +38056,567 @@ "COST_BY_ORG" ] }, + "CreateActionConnectionRequest": { + "description": "Request used to create an action connection.", + "properties": { + "data": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "CreateActionConnectionResponse": { + "description": "The response for a created connection", + "properties": { + "data": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "type": "object" + }, "CreateOpenAPIResponse": { "description": "Response for `CreateOpenAPI` operation.", "properties": { @@ -63050,6 +65436,285 @@ "GCP_SERVICE_ACCOUNT" ] }, + "GetActionConnectionResponse": { + "description": "The response for found connection", + "properties": { + "data": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "type": "object" + }, "GetDeviceAttributes": { "description": "The device attributes", "properties": { @@ -63822,100 +66487,23 @@ }, "type": "array" }, - "HTTPCIAppError": { - "description": "List of errors.", + "HTTPBody": { + "description": "The definition of `HTTPBody` object.", "properties": { - "detail": { - "description": "Error message.", - "example": "Malformed payload", - "type": "string" - }, - "status": { - "description": "Error code.", - "example": "400", + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", "type": "string" }, - "title": { - "description": "Error title.", - "example": "Bad Request", + "content_type": { + "description": "Content type of the body", + "example": "application/json", "type": "string" } }, "type": "object" }, - "HTTPCIAppErrors": { - "description": "Errors occurred.", - "properties": { - "errors": { - "description": "Structured errors.", - "items": { - "description": "List of errors.", - "properties": { - "detail": { - "description": "Error message.", - "example": "Malformed payload", - "type": "string" - }, - "status": { - "description": "Error code.", - "example": "400", - "type": "string" - }, - "title": { - "description": "Error title.", - "example": "Bad Request", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - }, - "HTTPLog": { - "description": "Structured log message.", - "items": { - "additionalProperties": { - "description": "Additional log attributes." - }, - "description": "Logs that are sent over HTTP.", - "properties": { - "ddsource": { - "description": "The integration name associated with your log: the technology from which the log originated.\nWhen it matches an integration name, Datadog automatically installs the corresponding parsers and facets.\nSee [reserved attributes](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes).", - "example": "nginx", - "type": "string" - }, - "ddtags": { - "description": "Tags associated with your logs.", - "example": "env:staging,version:5.1", - "type": "string" - }, - "hostname": { - "description": "The name of the originating host of the log.", - "example": "i-012345678", - "type": "string" - }, - "message": { - "description": "The message [reserved attribute](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes)\nof your log. By default, Datadog ingests the value of the message attribute as the body of the log entry.\nThat value is then highlighted and displayed in the Logstream, where it is indexed for full text search.", - "example": "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World", - "type": "string" - }, - "service": { - "description": "The name of the application or service generating the log events.\nIt is used to switch from Logs to APM, so make sure you define the same value when you use both products.\nSee [reserved attributes](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes).", - "example": "payment", - "type": "string" - } - }, - "required": [ - "message" - ], - "type": "object" - }, - "type": "array" - }, - "HTTPLogError": { + "HTTPCIAppError": { "description": "List of errors.", "properties": { "detail": { @@ -63936,8 +66524,743 @@ }, "type": "object" }, - "HTTPLogErrors": { - "description": "Invalid query performed.", + "HTTPCIAppErrors": { + "description": "Errors occurred.", + "properties": { + "errors": { + "description": "Structured errors.", + "items": { + "description": "List of errors.", + "properties": { + "detail": { + "description": "Error message.", + "example": "Malformed payload", + "type": "string" + }, + "status": { + "description": "Error code.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Error title.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "HTTPCredentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "HTTPCredentialsUpdate": { + "description": "The definition of `HTTPCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuthUpdate` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuthUpdate` `headers`.", + "items": { + "description": "The definition of `HTTPHeaderUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuthUpdate` `tokens`.", + "items": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "type", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuthUpdate` `url_parameters`.", + "items": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "HTTPHeader": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "HTTPHeaderUpdate": { + "description": "The definition of `HTTPHeaderUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "HTTPIntegration": { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + }, + "HTTPIntegrationType": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + }, + "HTTPIntegrationUpdate": { + "description": "The definition of `HTTPIntegrationUpdate` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuthUpdate` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuthUpdate` `headers`.", + "items": { + "description": "The definition of `HTTPHeaderUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuthUpdate` `tokens`.", + "items": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "type", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuthUpdate` `url_parameters`.", + "items": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "HTTPLog": { + "description": "Structured log message.", + "items": { + "additionalProperties": { + "description": "Additional log attributes." + }, + "description": "Logs that are sent over HTTP.", + "properties": { + "ddsource": { + "description": "The integration name associated with your log: the technology from which the log originated.\nWhen it matches an integration name, Datadog automatically installs the corresponding parsers and facets.\nSee [reserved attributes](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes).", + "example": "nginx", + "type": "string" + }, + "ddtags": { + "description": "Tags associated with your logs.", + "example": "env:staging,version:5.1", + "type": "string" + }, + "hostname": { + "description": "The name of the originating host of the log.", + "example": "i-012345678", + "type": "string" + }, + "message": { + "description": "The message [reserved attribute](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes)\nof your log. By default, Datadog ingests the value of the message attribute as the body of the log entry.\nThat value is then highlighted and displayed in the Logstream, where it is indexed for full text search.", + "example": "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World", + "type": "string" + }, + "service": { + "description": "The name of the application or service generating the log events.\nIt is used to switch from Logs to APM, so make sure you define the same value when you use both products.\nSee [reserved attributes](https://docs.datadoghq.com/logs/log_configuration/attributes_naming_convention/#reserved-attributes).", + "example": "payment", + "type": "string" + } + }, + "required": [ + "message" + ], + "type": "object" + }, + "type": "array" + }, + "HTTPLogError": { + "description": "List of errors.", + "properties": { + "detail": { + "description": "Error message.", + "example": "Malformed payload", + "type": "string" + }, + "status": { + "description": "Error code.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Error title.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "HTTPLogErrors": { + "description": "Invalid query performed.", "properties": { "errors": { "description": "Structured errors.", @@ -64004,6 +67327,343 @@ ], "type": "object" }, + "HTTPToken": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "HTTPTokenAuth": { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "HTTPTokenAuthType": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "HTTPTokenAuthUpdate": { + "description": "The definition of `HTTPTokenAuthUpdate` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuthUpdate` `headers`.", + "items": { + "description": "The definition of `HTTPHeaderUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuthUpdate` `tokens`.", + "items": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "type", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuthUpdate` `url_parameters`.", + "items": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "HTTPTokenUpdate": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "type", + "value" + ], + "type": "object" + }, "HistoricalJobDataType": { "description": "Type of payload.", "enum": [ @@ -177642,6 +181302,23 @@ }, "type": "array" }, + "TokenName": { + "description": "Name for tokens.", + "example": "MyTokenName", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "TokenType": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, "Unit": { "description": "Object containing the metric unit family, scale factor, name, and short name.", "nullable": true, @@ -177675,6 +181352,555 @@ }, "type": "object" }, + "UpdateActionConnectionRequest": { + "description": "Request used to update an action connection.", + "properties": { + "data": { + "description": "Data related to the connection update.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributesUpdate` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegrationUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegrationUpdate` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRoleUpdate` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "generate_new_external_id": { + "description": "The `AWSAssumeRoleUpdate` `generate_new_external_id`.", + "type": "boolean" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegrationUpdate` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuthUpdate` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuthUpdate` `headers`.", + "items": { + "description": "The definition of `HTTPHeaderUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuthUpdate` `tokens`.", + "items": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "type", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuthUpdate` `url_parameters`.", + "items": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "UpdateActionConnectionResponse": { + "description": "The response for an updated connection.", + "properties": { + "data": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "type": "object" + }, "UpdateOpenAPIResponse": { "description": "Response for `UpdateOpenAPI`.", "properties": { @@ -183919,6 +188145,51 @@ } ] }, + "UrlParam": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "UrlParamUpdate": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, "UsageApplicationSecurityMonitoringResponse": { "description": "Application Security Monitoring usage response.", "properties": { @@ -191927,365 +196198,2302 @@ "type": "string" } }, - "type": "object" - } - }, - "type": "object" - }, - "WorkflowInstanceCreateResponseData": { - "additionalProperties": {}, - "description": "Data about the created workflow instance.", - "properties": { - "id": { - "description": "The ID of the workflow execution. It can be used to fetch the execution status.", - "type": "string" - } - }, - "type": "object" - }, - "WorkflowInstanceListItem": { - "additionalProperties": {}, - "description": "An item in the workflow instances list.", - "properties": { - "id": { - "description": "The ID of the workflow instance", - "type": "string" - } - }, - "type": "object" - }, - "WorkflowListInstancesResponse": { - "additionalProperties": {}, - "description": "Response returned when listing workflow instances.", - "properties": { - "data": { - "description": "A list of workflow instances.", - "items": { - "additionalProperties": {}, - "description": "An item in the workflow instances list.", - "properties": { - "id": { - "description": "The ID of the workflow instance", - "type": "string" + "type": "object" + } + }, + "type": "object" + }, + "WorkflowInstanceCreateResponseData": { + "additionalProperties": {}, + "description": "Data about the created workflow instance.", + "properties": { + "id": { + "description": "The ID of the workflow execution. It can be used to fetch the execution status.", + "type": "string" + } + }, + "type": "object" + }, + "WorkflowInstanceListItem": { + "additionalProperties": {}, + "description": "An item in the workflow instances list.", + "properties": { + "id": { + "description": "The ID of the workflow instance", + "type": "string" + } + }, + "type": "object" + }, + "WorkflowListInstancesResponse": { + "additionalProperties": {}, + "description": "Response returned when listing workflow instances.", + "properties": { + "data": { + "description": "A list of workflow instances.", + "items": { + "additionalProperties": {}, + "description": "An item in the workflow instances list.", + "properties": { + "id": { + "description": "The ID of the workflow instance", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "additionalProperties": {}, + "description": "Metadata about the instances list", + "properties": { + "page": { + "additionalProperties": {}, + "description": "Page information for the list instances response.", + "properties": { + "totalCount": { + "description": "The total count of items.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "WorkflowListInstancesResponseMeta": { + "additionalProperties": {}, + "description": "Metadata about the instances list", + "properties": { + "page": { + "additionalProperties": {}, + "description": "Page information for the list instances response.", + "properties": { + "totalCount": { + "description": "The total count of items.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "WorkflowListInstancesResponseMetaPage": { + "additionalProperties": {}, + "description": "Page information for the list instances response.", + "properties": { + "totalCount": { + "description": "The total count of items.", + "format": "int64", + "type": "integer" + } + }, + "type": "object" + }, + "WorklflowCancelInstanceResponse": { + "description": "Information about the canceled instance.", + "properties": { + "data": { + "description": "Data about the canceled instance.", + "properties": { + "id": { + "description": "The id of the canceled instance", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "WorklflowCancelInstanceResponseData": { + "description": "Data about the canceled instance.", + "properties": { + "id": { + "description": "The id of the canceled instance", + "type": "string" + } + }, + "type": "object" + }, + "WorklflowGetInstanceResponse": { + "additionalProperties": {}, + "description": "The state of the given workflow instance.", + "properties": { + "data": { + "additionalProperties": {}, + "description": "The data of the instance response.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "The attributes of the instance response data.", + "properties": { + "id": { + "description": "The id of the instance.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "WorklflowGetInstanceResponseData": { + "additionalProperties": {}, + "description": "The data of the instance response.", + "properties": { + "attributes": { + "additionalProperties": {}, + "description": "The attributes of the instance response data.", + "properties": { + "id": { + "description": "The id of the instance.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "WorklflowGetInstanceResponseDataAttributes": { + "additionalProperties": {}, + "description": "The attributes of the instance response data.", + "properties": { + "id": { + "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. Defaults to `[]`.", + "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. Defaults to `include_only`.", + "oneOf": [ + { + "description": "Include all services.", + "properties": { + "include_all": { + "description": "Include all services.", + "example": false, + "type": "boolean" + } + }, + "required": [ + "include_all" + ] + }, + { + "description": "Include only these services. Defaults to `[]`.", + "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": { + "AuthZ": { + "description": "This API uses OAuth 2 with the implicit grant flow.", + "flows": { + "authorizationCode": { + "authorizationUrl": "/oauth2/v1/authorize", + "scopes": { + "apm_api_catalog_read": "View API catalog and API definitions.", + "apm_api_catalog_write": "Add, modify, and delete API catalog definitions.", + "apm_read": "Read and query APM and Trace Analytics.", + "apm_service_catalog_read": "View service catalog and service definitions.", + "apm_service_catalog_write": "Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog.", + "cases_read": "View Cases.", + "cases_write": "Create and update cases.", + "ci_visibility_pipelines_write": "Create CI Visibility pipeline spans using the API.", + "ci_visibility_read": "View CI Visibility.", + "cloud_cost_management_read": "View Cloud Cost pages. This does not restrict access to the cloud cost data source in dashboards and notebooks.", + "cloud_cost_management_write": "Configure cloud cost accounts and global customizations.", + "code_analysis_read": "View Code Analysis.", + "continuous_profiler_pgo_read": "Read and query Continuous Profiler data for Profile-Guided Optimization (PGO).", + "create_webhooks": "Create webhooks integrations.", + "dashboards_public_share": "Generate public and authenticated links to share dashboards or embeddable graphs externally.", + "dashboards_read": "View dashboards.", + "dashboards_write": "Create and change dashboards.", + "data_scanner_read": "View Data Scanner configurations.", + "data_scanner_write": "Edit Data Scanner configurations.", + "events_read": "Read Events data.", + "hosts_read": "List hosts and their attributes.", + "incident_notification_settings_write": "Configure Incidents Notification settings.", + "incident_read": "View incidents in Datadog.", + "incident_settings_write": "Configure Incident Settings.", + "incident_write": "Create, view, and manage incidents in Datadog.", + "metrics_read": "View custom metrics.", + "monitors_downtime": "Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes.", + "monitors_read": "View monitors.", + "monitors_write": "Edit and delete individual monitors.", + "org_management": "Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization.", + "security_monitoring_filters_read": "Read Security Filters.", + "security_monitoring_filters_write": "Create, edit, and delete Security Filters.", + "security_monitoring_findings_read": "View a list of findings that include both misconfigurations and identity risks.", + "security_monitoring_rules_read": "Read Detection Rules.", + "security_monitoring_rules_write": "Create and edit Detection Rules.", + "security_monitoring_signals_read": "View Security Signals.", + "security_monitoring_suppressions_read": "Read Rule Suppressions.", + "security_monitoring_suppressions_write": "Write Rule Suppressions.", + "security_pipelines_read": "View Security Pipelines.", + "security_pipelines_write": "Create, edit, and delete CSM Security Pipelines.", + "slos_corrections": "Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs.", + "slos_read": "View SLOs and status corrections.", + "slos_write": "Create, edit, and delete SLOs.", + "synthetics_global_variable_read": "View, search, and use Synthetics global variables.", + "synthetics_global_variable_write": "Create, edit, and delete global variables for Synthetics.", + "synthetics_private_location_read": "View, search, and use Synthetics private locations.", + "synthetics_private_location_write": "Create and delete private locations in addition to having access to the associated installation guidelines.", + "synthetics_read": "List and view configured Synthetic tests and test results.", + "synthetics_write": "Create, edit, and delete Synthetic tests.", + "teams_manage": "Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission.", + "teams_read": "Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team.", + "test_visibility_read": "View Test Visibility.", + "timeseries_query": "Query Timeseries data.", + "usage_read": "View your organization's usage and usage attribution.", + "user_access_invite": "Invite other users to your organization.", + "user_access_manage": "Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries.", + "user_access_read": "View users and their roles and settings.", + "workflows_read": "View workflows.", + "workflows_run": "Run workflows.", + "workflows_write": "Create, edit, and delete workflows." + }, + "tokenUrl": "/oauth2/v1/token" + } + }, + "type": "oauth2" + }, + "apiKeyAuth": { + "description": "Your Datadog API Key.", + "in": "header", + "name": "DD-API-KEY", + "type": "apiKey", + "x-env-name": "DD_API_KEY" + }, + "appKeyAuth": { + "description": "Your Datadog APP Key.", + "in": "header", + "name": "DD-APPLICATION-KEY", + "type": "apiKey", + "x-env-name": "DD_APP_KEY" + }, + "bearerAuth": { + "in": "header", + "name": "Authorization", + "scheme": "bearer", + "type": "http", + "x-env-name": "DD_BEARER_TOKEN" + } + } + }, + "info": { + "contact": { + "email": "support@datadoghq.com", + "name": "Datadog Support", + "url": "https://www.datadoghq.com/support/" + }, + "description": "Collection of all Datadog Public endpoints.", + "title": "Datadog API V2 Collection", + "version": "1.0" + }, + "openapi": "3.0.0", + "paths": { + "/api/v2/actions/connections": { + "post": { + "description": "Create a new Action Connection", + "operationId": "CreateActionConnection", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request used to create an action connection.", + "properties": { + "data": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "The response for a created connection", + "properties": { + "data": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Successfully created Action Connection" + }, + "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" + } + }, + "summary": "Create a new Action Connection", + "tags": [ + "Action Connection" + ], + "x-given": { + "action_connection": { + "parameters": [ + { + "name": "body", + "value": "{\n \"data\": {\n \"type\": \"action_connection\",\n \"attributes\": {\n \"name\": \"Cassette Connection DELETE\",\n \"integration\": {\n \"type\": \"AWS\",\n \"credentials\": {\n \"type\": \"AWSAssumeRole\",\n \"role\": \"MyRole\",\n \"account_id\": \"123456789123\"\n }\n }\n }\n }\n}" + } + ], + "step": "there is a valid \"action_connection\" in the system" + } + }, + "x-menu-order": 2, + "x-undo": { + "operationId": "DeleteActionConnection", + "parameters": [ + { + "name": "connection_id", + "source": "data.id" + } + ], + "type": "unsafe" + } + } + }, + "/api/v2/actions/connections/{connection_id}": { + "delete": { + "description": "Delete an existing Action Connection", + "operationId": "DeleteActionConnection", + "parameters": [ + { + "description": "The ID of the action connection", + "in": "path", + "name": "connection_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + }, + "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" + } + }, + "summary": "Delete an existing Action Connection", + "tags": [ + "Action Connection" + ], + "x-menu-order": 4, + "x-permission": { + "operator": "OR", + "permissions": [ + "connection_write" + ] + }, + "x-undo": { + "type": "idempotent" + } + }, + "get": { + "description": "Get an existing Action Connection", + "operationId": "GetActionConnection", + "parameters": [ + { + "description": "The ID of the action connection", + "in": "path", + "name": "connection_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The response for found connection", + "properties": { + "data": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Successfully get Action Connection" + }, + "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" } - }, - "type": "object" + } }, - "type": "array" + "description": "Bad Request" }, - "meta": { - "additionalProperties": {}, - "description": "Metadata about the instances list", - "properties": { - "page": { - "additionalProperties": {}, - "description": "Page information for the list instances response.", - "properties": { - "totalCount": { - "description": "The total count of items.", - "format": "int64", - "type": "integer" - } - }, - "type": "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" + } } }, - "type": "object" - } - }, - "type": "object" - }, - "WorkflowListInstancesResponseMeta": { - "additionalProperties": {}, - "description": "Metadata about the instances list", - "properties": { - "page": { - "additionalProperties": {}, - "description": "Page information for the list instances response.", - "properties": { - "totalCount": { - "description": "The total count of items.", - "format": "int64", - "type": "integer" + "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" + } } }, - "type": "object" - } - }, - "type": "object" - }, - "WorkflowListInstancesResponseMetaPage": { - "additionalProperties": {}, - "description": "Page information for the list instances response.", - "properties": { - "totalCount": { - "description": "The total count of items.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "WorklflowCancelInstanceResponse": { - "description": "Information about the canceled instance.", - "properties": { - "data": { - "description": "Data about the canceled instance.", - "properties": { - "id": { - "description": "The id of the canceled instance", - "type": "string" + "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" + } } }, - "type": "object" + "description": "Too many requests" } }, - "type": "object" + "summary": "Get an existing Action Connection", + "tags": [ + "Action Connection" + ], + "x-menu-order": 1, + "x-undo": { + "type": "safe" + } }, - "WorklflowCancelInstanceResponseData": { - "description": "Data about the canceled instance.", - "properties": { - "id": { - "description": "The id of the canceled instance", - "type": "string" + "patch": { + "description": "Update an existing Action Connection", + "operationId": "UpdateActionConnection", + "parameters": [ + { + "description": "The ID of the action connection", + "in": "path", + "name": "connection_id", + "required": true, + "schema": { + "type": "string" + } } - }, - "type": "object" - }, - "WorklflowGetInstanceResponse": { - "additionalProperties": {}, - "description": "The state of the given workflow instance.", - "properties": { - "data": { - "additionalProperties": {}, - "description": "The data of the instance response.", - "properties": { - "attributes": { - "additionalProperties": {}, - "description": "The attributes of the instance response data.", + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request used to update an action connection.", "properties": { - "id": { - "description": "The id of the instance.", - "type": "string" + "data": { + "description": "Data related to the connection update.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributesUpdate` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegrationUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegrationUpdate` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRoleUpdate` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "generate_new_external_id": { + "description": "The `AWSAssumeRoleUpdate` `generate_new_external_id`.", + "type": "boolean" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegrationUpdate` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentialsUpdate` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuthUpdate` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuthUpdate` `headers`.", + "items": { + "description": "The definition of `HTTPHeaderUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPHeaderUpdate` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeaderUpdate` `value`.", + "example": "Updated Header Value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuthUpdate` `tokens`.", + "items": { + "description": "The definition of `HTTPTokenUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "type", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuthUpdate` `url_parameters`.", + "items": { + "description": "The definition of `UrlParamUpdate` object.", + "properties": { + "deleted": { + "description": "Should the header be deleted.", + "type": "boolean" + }, + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParamUpdate` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" } }, + "required": [ + "data" + ], "type": "object" } - }, - "type": "object" - } + } + }, + "description": "Update an existing Action Connection request body", + "required": true }, - "type": "object" - }, - "WorklflowGetInstanceResponseData": { - "additionalProperties": {}, - "description": "The data of the instance response.", - "properties": { - "attributes": { - "additionalProperties": {}, - "description": "The attributes of the instance response data.", - "properties": { - "id": { - "description": "The id of the instance.", - "type": "string" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "The response for an updated connection.", + "properties": { + "data": { + "description": "Data related to the connection.", + "properties": { + "attributes": { + "description": "The definition of `ActionConnectionAttributes` object.", + "properties": { + "integration": { + "description": "The definition of `ActionConnectionIntegration` object.", + "oneOf": [ + { + "description": "The definition of `AWSIntegration` object.", + "properties": { + "credentials": { + "description": "The definition of `AWSCredentials` object.", + "oneOf": [ + { + "description": "The definition of `AWSAssumeRole` object.", + "properties": { + "account_id": { + "description": "AWS account the connection is created for", + "example": "111222333444", + "pattern": "^\\d{12}$", + "type": "string" + }, + "external_id": { + "description": "External ID used to scope which connection can be used to assume the role", + "example": "33a1011635c44b38a064cf14e82e1d8f", + "readOnly": true, + "type": "string" + }, + "principal_id": { + "description": "AWS account that will assume the role", + "example": "123456789012", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Role to assume", + "example": "my-role", + "type": "string" + }, + "type": { + "description": "The definition of `AWSAssumeRoleType` object.", + "enum": [ + "AWSAssumeRole" + ], + "example": "AWSAssumeRole", + "type": "string", + "x-enum-varnames": [ + "AWSASSUMEROLE" + ] + } + }, + "required": [ + "type", + "account_id", + "role" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `AWSIntegrationType` object.", + "enum": [ + "AWS" + ], + "example": "AWS", + "type": "string", + "x-enum-varnames": [ + "AWS" + ] + } + }, + "required": [ + "type", + "credentials" + ], + "type": "object" + }, + { + "description": "The definition of `HTTPIntegration` object.", + "properties": { + "base_url": { + "description": "Base HTTP url for the integration", + "example": "http://datadoghq.com", + "pattern": "url", + "type": "string" + }, + "credentials": { + "description": "The definition of `HTTPCredentials` object.", + "oneOf": [ + { + "description": "The definition of `HTTPTokenAuth` object.", + "properties": { + "body": { + "description": "The definition of `HTTPBody` object.", + "properties": { + "content": { + "description": "Serialized body content", + "example": "{\"some-json\": \"with-value\"}", + "type": "string" + }, + "content_type": { + "description": "Content type of the body", + "example": "application/json", + "type": "string" + } + }, + "type": "object" + }, + "headers": { + "description": "The `HTTPTokenAuth` `headers`.", + "items": { + "description": "The definition of `HTTPHeader` object.", + "properties": { + "name": { + "description": "The `HTTPHeader` `name`.", + "example": "MyHttpHeader", + "pattern": "^[A-Za-z][A-Za-z\\\\d\\\\-\\\\_]*$", + "type": "string" + }, + "value": { + "description": "The `HTTPHeader` `value`.", + "example": "Some header value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tokens": { + "description": "The `HTTPTokenAuth` `tokens`.", + "items": { + "description": "The definition of `HTTPToken` object.", + "properties": { + "name": { + "description": "The `HTTPToken` `name`.", + "example": "MyToken", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "type": { + "description": "The definition of `TokenType` object.", + "enum": [ + "SECRET" + ], + "example": "SECRET", + "type": "string", + "x-enum-varnames": [ + "SECRET" + ] + }, + "value": { + "description": "The `HTTPToken` `value`.", + "example": "Some Token Value", + "type": "string" + } + }, + "required": [ + "name", + "value", + "type" + ], + "type": "object" + }, + "type": "array" + }, + "type": { + "description": "The definition of `HTTPTokenAuthType` object.", + "enum": [ + "HTTPTokenAuth" + ], + "example": "HTTPTokenAuth", + "type": "string", + "x-enum-varnames": [ + "HTTPTOKENAUTH" + ] + }, + "url_parameters": { + "description": "The `HTTPTokenAuth` `url_parameters`.", + "items": { + "description": "The definition of `UrlParam` object.", + "properties": { + "name": { + "example": "MyUrlParameter", + "description": "Name for tokens.", + "pattern": "^[A-Za-z][A-Za-z\\\\d]*$", + "type": "string" + }, + "value": { + "description": "The `UrlParam` `value`.", + "example": "Some Url Parameter value", + "type": "string" + } + }, + "required": [ + "name", + "value" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "type" + ], + "type": "object" + } + ] + }, + "type": { + "description": "The definition of `HTTPIntegrationType` object.", + "enum": [ + "HTTP" + ], + "example": "HTTP", + "type": "string", + "x-enum-varnames": [ + "HTTP" + ] + } + }, + "required": [ + "type", + "base_url", + "credentials" + ], + "type": "object" + } + ] + }, + "name": { + "description": "Name of the connection", + "example": "My AWS Connection", + "type": "string" + } + }, + "required": [ + "name", + "integration" + ], + "type": "object" + }, + "id": { + "description": "The connection identifier", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The definition of `ActionConnectionDataType` object.", + "enum": [ + "action_connection" + ], + "example": "action_connection", + "type": "string", + "x-enum-varnames": [ + "ACTION_CONNECTION" + ] + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "type": "object" + } } }, - "type": "object" - } - }, - "type": "object" - }, - "WorklflowGetInstanceResponseDataAttributes": { - "additionalProperties": {}, - "description": "The attributes of the instance response data.", - "properties": { - "id": { - "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. Defaults to `[]`.", - "nullable": true, - "properties": { - "include_only": { - "description": "Include only these services.", - "example": [ - "AWS/AppSync" - ], - "items": { - "example": "AWS/AppSync", - "type": "string" + "description": "Successfully updated Action Connection" + }, + "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" + } + } }, - "type": "array" - } - }, - "required": [ - "include_only" - ] - }, - "XRayServicesList": { - "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", - "oneOf": [ - { - "description": "Include all services.", - "properties": { - "include_all": { - "description": "Include all services.", - "example": false, - "type": "boolean" + "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" + } } }, - "required": [ - "include_all" - ] + "description": "Forbidden" }, - { - "description": "Include only these services. Defaults to `[]`.", - "nullable": true, - "properties": { - "include_only": { - "description": "Include only these services.", - "example": [ - "AWS/AppSync" - ], - "items": { - "example": "AWS/AppSync", - "type": "string" - }, - "type": "array" + "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" + } } }, - "required": [ - "include_only" - ] - } - ] - } - }, - "securitySchemes": { - "AuthZ": { - "description": "This API uses OAuth 2 with the implicit grant flow.", - "flows": { - "authorizationCode": { - "authorizationUrl": "/oauth2/v1/authorize", - "scopes": { - "apm_api_catalog_read": "View API catalog and API definitions.", - "apm_api_catalog_write": "Add, modify, and delete API catalog definitions.", - "apm_read": "Read and query APM and Trace Analytics.", - "apm_service_catalog_read": "View service catalog and service definitions.", - "apm_service_catalog_write": "Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog.", - "cases_read": "View Cases.", - "cases_write": "Create and update cases.", - "ci_visibility_pipelines_write": "Create CI Visibility pipeline spans using the API.", - "ci_visibility_read": "View CI Visibility.", - "cloud_cost_management_read": "View Cloud Cost pages. This does not restrict access to the cloud cost data source in dashboards and notebooks.", - "cloud_cost_management_write": "Configure cloud cost accounts and global customizations.", - "code_analysis_read": "View Code Analysis.", - "continuous_profiler_pgo_read": "Read and query Continuous Profiler data for Profile-Guided Optimization (PGO).", - "create_webhooks": "Create webhooks integrations.", - "dashboards_public_share": "Generate public and authenticated links to share dashboards or embeddable graphs externally.", - "dashboards_read": "View dashboards.", - "dashboards_write": "Create and change dashboards.", - "data_scanner_read": "View Data Scanner configurations.", - "data_scanner_write": "Edit Data Scanner configurations.", - "events_read": "Read Events data.", - "hosts_read": "List hosts and their attributes.", - "incident_notification_settings_write": "Configure Incidents Notification settings.", - "incident_read": "View incidents in Datadog.", - "incident_settings_write": "Configure Incident Settings.", - "incident_write": "Create, view, and manage incidents in Datadog.", - "metrics_read": "View custom metrics.", - "monitors_downtime": "Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes.", - "monitors_read": "View monitors.", - "monitors_write": "Edit and delete individual monitors.", - "org_management": "Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization.", - "security_monitoring_filters_read": "Read Security Filters.", - "security_monitoring_filters_write": "Create, edit, and delete Security Filters.", - "security_monitoring_findings_read": "View a list of findings that include both misconfigurations and identity risks.", - "security_monitoring_rules_read": "Read Detection Rules.", - "security_monitoring_rules_write": "Create and edit Detection Rules.", - "security_monitoring_signals_read": "View Security Signals.", - "security_monitoring_suppressions_read": "Read Rule Suppressions.", - "security_monitoring_suppressions_write": "Write Rule Suppressions.", - "security_pipelines_read": "View Security Pipelines.", - "security_pipelines_write": "Create, edit, and delete CSM Security Pipelines.", - "slos_corrections": "Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs.", - "slos_read": "View SLOs and status corrections.", - "slos_write": "Create, edit, and delete SLOs.", - "synthetics_global_variable_read": "View, search, and use Synthetics global variables.", - "synthetics_global_variable_write": "Create, edit, and delete global variables for Synthetics.", - "synthetics_private_location_read": "View, search, and use Synthetics private locations.", - "synthetics_private_location_write": "Create and delete private locations in addition to having access to the associated installation guidelines.", - "synthetics_read": "List and view configured Synthetic tests and test results.", - "synthetics_write": "Create, edit, and delete Synthetic tests.", - "teams_manage": "Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission.", - "teams_read": "Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team.", - "test_visibility_read": "View Test Visibility.", - "timeseries_query": "Query Timeseries data.", - "usage_read": "View your organization's usage and usage attribution.", - "user_access_invite": "Invite other users to your organization.", - "user_access_manage": "Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries.", - "user_access_read": "View users and their roles and settings.", - "workflows_read": "View workflows.", - "workflows_run": "Run workflows.", - "workflows_write": "Create, edit, and delete workflows." + "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" + } + } }, - "tokenUrl": "/oauth2/v1/token" + "description": "Too many requests" } }, - "type": "oauth2" - }, - "apiKeyAuth": { - "description": "Your Datadog API Key.", - "in": "header", - "name": "DD-API-KEY", - "type": "apiKey", - "x-env-name": "DD_API_KEY" - }, - "appKeyAuth": { - "description": "Your Datadog APP Key.", - "in": "header", - "name": "DD-APPLICATION-KEY", - "type": "apiKey", - "x-env-name": "DD_APP_KEY" - }, - "bearerAuth": { - "in": "header", - "name": "Authorization", - "scheme": "bearer", - "type": "http", - "x-env-name": "DD_BEARER_TOKEN" + "summary": "Update an existing Action Connection", + "tags": [ + "Action Connection" + ], + "x-menu-order": 3, + "x-undo": { + "type": "idempotent" + } } - } - }, - "info": { - "contact": { - "email": "support@datadoghq.com", - "name": "Datadog Support", - "url": "https://www.datadoghq.com/support/" }, - "description": "Collection of all Datadog Public endpoints.", - "title": "Datadog API V2 Collection", - "version": "1.0" - }, - "openapi": "3.0.0", - "paths": { "/api/v2/api_keys": { "get": { "description": "List all API keys available for your account.", @@ -371594,6 +377802,14 @@ }, "name": "AWS Logs Integration" }, + { + "description": "Action connections extend your installed integrations and allow you to take action in your third-party systems\n(e.g. AWS, Gitlab, and Statuspage) with Datadog’s Workflow Automation and App Builder products.\n\nDatadog’s Integrations automatically provide authentication for Slack, Microsoft Teams, PagerDuty, Opsgenie,\nJIRA, GitHub, and Statuspage. You do not need additional connections in order to access these tools within\nWorkflow Automation and App Builder.\n\nWe offer granular access control for editing and resolving connections.", + "externalDocs": { + "description": "Find out more at", + "url": "https://docs.datadoghq.com/service_management/workflows/connections/" + }, + "name": "Action Connection" + }, { "description": "Search your Audit Logs events over HTTP.", "name": "Audit"