diff --git a/.apigentools-info b/.apigentools-info index 2e5c781a97a3b..87ec0053aaec6 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2025-02-12 18:35:12.089667", - "spec_repo_commit": "6a4cfb82" + "regenerated": "2025-02-12 21:49:24.700850", + "spec_repo_commit": "41fcc78b" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2025-02-12 18:35:20.202071", - "spec_repo_commit": "6a4cfb82" + "regenerated": "2025-02-12 21:49:32.942461", + "spec_repo_commit": "41fcc78b" } } } \ No newline at end of file diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 24e0b3c59e207..bba35db7b6bfe 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -4667,14 +4667,14 @@ menu: - ListApmRetentionFilters unstable: [] order: 1 - - name: Action Connection - url: /api/latest/action-connection/ - identifier: action-connection + - name: Action Connections + url: /api/latest/action-connections/ + identifier: action-connections 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 + identifier: action-connections-update-an-existing-action-connection + parent: action-connections generated: true params: versions: @@ -4685,8 +4685,8 @@ menu: 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 + identifier: action-connections-get-an-existing-action-connection + parent: action-connections generated: true params: versions: @@ -4697,8 +4697,8 @@ menu: 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 + identifier: action-connections-delete-an-existing-action-connection + parent: action-connections generated: true params: versions: @@ -4709,8 +4709,8 @@ menu: 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 + identifier: action-connections-create-a-new-action-connection + parent: action-connections generated: true params: versions: diff --git a/content/en/api/latest/action-connections/_index.md b/content/en/api/latest/action-connections/_index.md new file mode 100644 index 0000000000000..6d48cd74148ac --- /dev/null +++ b/content/en/api/latest/action-connections/_index.md @@ -0,0 +1,3 @@ +--- +title: Action Connections +--- diff --git a/content/en/api/v2/action-connections/_index.md b/content/en/api/v2/action-connections/_index.md new file mode 100644 index 0000000000000..3f4a779dfacf4 --- /dev/null +++ b/content/en/api/v2/action-connections/_index.md @@ -0,0 +1,4 @@ +--- +title: Action Connections +headless: true +--- diff --git a/content/en/api/v2/action-connections/examples.json b/content/en/api/v2/action-connections/examples.json new file mode 100644 index 0000000000000..650eb46d5f84f --- /dev/null +++ b/content/en/api/v2/action-connections/examples.json @@ -0,0 +1,400 @@ +{ + "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": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \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": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \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": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \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": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \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-connections/request.CreateActionConnection.json b/content/en/api/v2/action-connections/request.CreateActionConnection.json new file mode 100644 index 0000000000000..0fe2682684700 --- /dev/null +++ b/content/en/api/v2/action-connections/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-connections/request.UpdateActionConnection.json b/content/en/api/v2/action-connections/request.UpdateActionConnection.json new file mode 100644 index 0000000000000..b219f4ae127fa --- /dev/null +++ b/content/en/api/v2/action-connections/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 0dd4b3477940e..9bff4756083fd 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -41,16 +41,16 @@ ], "CreateActionConnection": [ { - "group": "action_connection", + "group": "action_connections", "suffix": "", - "description": "Create a new Action Connection returns \"Successfully created Action Connection\" response" + "description": "Create a new Action Connection returns \"Created\" response" } ], "UpdateActionConnection": [ { - "group": "action_connection", + "group": "action_connections", "suffix": "", - "description": "Update an existing Action Connection returns \"Successfully updated Action Connection\" response" + "description": "Update an existing Action Connection returns \"OK\" response" } ], "CreateApp": [ diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 64cc8dd374ff5..6f8a74701b8bb 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -219,7 +219,7 @@ components: schema: type: string ConnectionId: - description: The ID of the action connection + description: The ID of the Action Connection. in: path name: connection_id required: true @@ -1296,23 +1296,23 @@ components: description: The definition of `AWSAssumeRole` object. properties: account_id: - description: AWS account the connection is created for + 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 + the role. example: 33a1011635c44b38a064cf14e82e1d8f readOnly: true type: string principal_id: - description: AWS account that will assume the role + description: AWS account that will assume the role. example: '123456789012' readOnly: true type: string role: - description: Role to assume + description: Role to assume. example: my-role type: string type: @@ -1334,7 +1334,7 @@ components: description: The definition of `AWSAssumeRoleUpdate` object. properties: account_id: - description: AWS account the connection is created for + description: AWS account the connection is created for. example: '111222333444' pattern: ^\d{12}$ type: string @@ -1744,7 +1744,7 @@ components: integration: $ref: '#/components/schemas/ActionConnectionIntegration' name: - description: Name of the connection + description: Name of the connection. example: My AWS Connection type: string required: @@ -1757,7 +1757,7 @@ components: integration: $ref: '#/components/schemas/ActionConnectionIntegrationUpdate' name: - description: Name of the connection + description: Name of the connection. example: My AWS Connection type: string type: object @@ -1767,7 +1767,7 @@ components: attributes: $ref: '#/components/schemas/ActionConnectionAttributes' id: - description: The connection identifier + description: The connection identifier. readOnly: true type: string type: @@ -7567,7 +7567,7 @@ components: x-enum-varnames: - COST_BY_ORG CreateActionConnectionRequest: - description: Request used to create an action connection. + description: Request used to create an Action Connection. properties: data: $ref: '#/components/schemas/ActionConnectionData' @@ -7575,7 +7575,7 @@ components: - data type: object CreateActionConnectionResponse: - description: The response for a created connection + description: The response for a created connection. properties: data: $ref: '#/components/schemas/ActionConnectionData' @@ -12917,7 +12917,7 @@ components: x-enum-varnames: - GCP_SERVICE_ACCOUNT GetActionConnectionResponse: - description: The response for found connection + description: The response for found connection. properties: data: $ref: '#/components/schemas/ActionConnectionData' @@ -13302,7 +13302,7 @@ components: description: The definition of `HTTPIntegration` object. properties: base_url: - description: Base HTTP url for the integration + description: Base HTTP url for the integration. example: http://datadoghq.com pattern: url type: string @@ -13327,7 +13327,7 @@ components: description: The definition of `HTTPIntegrationUpdate` object. properties: base_url: - description: Base HTTP url for the integration + description: Base HTTP url for the integration. example: http://datadoghq.com pattern: url type: string @@ -31189,7 +31189,7 @@ components: $ref: '#/components/schemas/Deployment' type: object UpdateActionConnectionRequest: - description: Request used to update an action connection. + description: Request used to update an Action Connection. properties: data: $ref: '#/components/schemas/ActionConnectionDataUpdate' @@ -32999,7 +32999,7 @@ openapi: 3.0.0 paths: /api/v2/actions/connections: post: - description: Create a new Action Connection + description: Create a new Action Connection. operationId: CreateActionConnection requestBody: content: @@ -33013,7 +33013,7 @@ paths: application/json: schema: $ref: '#/components/schemas/CreateActionConnectionResponse' - description: Successfully created Action Connection + description: Created '400': content: application/json: @@ -33031,10 +33031,10 @@ paths: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' - description: Too Many Request + description: Too Many Requests summary: Create a new Action Connection tags: - - Action Connection + - Action Connections x-given: action_connection: parameters: @@ -33047,6 +33047,10 @@ paths: \ }\n }\n }\n}" step: there is a valid "action_connection" in the system x-menu-order: 2 + x-permission: + operator: OR + permissions: + - connection_read x-undo: operationId: DeleteActionConnection parameters: @@ -33055,13 +33059,13 @@ paths: type: unsafe /api/v2/actions/connections/{connection_id}: delete: - description: Delete an existing Action Connection + description: Delete an existing Action Connection. operationId: DeleteActionConnection parameters: - $ref: '#/components/parameters/ConnectionId' responses: '204': - description: The resource was deleted successfully. + description: No Content '403': content: application/json: @@ -33079,10 +33083,10 @@ paths: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' - description: Too Many Request + description: Too Many Requests summary: Delete an existing Action Connection tags: - - Action Connection + - Action Connections x-menu-order: 4 x-permission: operator: OR @@ -33091,7 +33095,7 @@ paths: x-undo: type: idempotent get: - description: Get an existing Action Connection + description: Get an existing Action Connection. operationId: GetActionConnection parameters: - $ref: '#/components/parameters/ConnectionId' @@ -33101,7 +33105,7 @@ paths: application/json: schema: $ref: '#/components/schemas/GetActionConnectionResponse' - description: Successfully get Action Connection + description: OK '400': content: application/json: @@ -33125,11 +33129,15 @@ paths: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' - description: Too Many Request + description: Too Many Requests summary: Get an existing Action Connection tags: - - Action Connection + - Action Connections x-menu-order: 1 + x-permission: + operator: OR + permissions: + - connection_read x-undo: type: safe patch: @@ -33142,7 +33150,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateActionConnectionRequest' - description: Update an existing Action Connection request body + description: Update an existing Action Connection request body. required: true responses: '200': @@ -33150,7 +33158,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpdateActionConnectionResponse' - description: Successfully updated Action Connection + description: OK '400': content: application/json: @@ -33174,11 +33182,15 @@ paths: application/json: schema: $ref: '#/components/schemas/JSONAPIErrorResponse' - description: Too Many Request + description: Too Many Requests summary: Update an existing Action Connection tags: - - Action Connection + - Action Connections x-menu-order: 3 + x-permission: + operator: OR + permissions: + - connection_write x-undo: type: idempotent /api/v2/agentless_scanning/accounts/aws: @@ -55125,17 +55137,19 @@ 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 +- description: "Action Connections extend your installed integrations and allow you + to take action in your third-party systems\n(such as AWS, GitLab, and OpenAI) + with Datadog\u2019s [Workflow Automation](https://docs.datadoghq.com/service_management/workflows/)\nand + [App Builder](https://docs.datadoghq.com/service_management/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 + 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." + Builder.\n\nWe offer granular access control for editing and resolving connections.\n\n**Note:** + The Action Connection API supports AWS and HTTP integrations." externalDocs: description: Find out more at url: https://docs.datadoghq.com/service_management/workflows/connections/ - name: Action Connection + name: Action Connections - description: "Datadog Agentless Scanning provides visibility into risks and vulnerabilities\nwithin your hosts, running containers, and serverless functions\u2014all without\nrequiring teams to install Agents on every host or where Agents cannot be installed.\nGo diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index fafd8225aff5e..cef5f8fc1d2a1 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -311,7 +311,7 @@ } }, "ConnectionId": { - "description": "The ID of the action connection", + "description": "The ID of the Action Connection.", "in": "path", "name": "connection_id", "required": true, @@ -7352,25 +7352,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -7408,7 +7408,7 @@ "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "description": "AWS account the connection is created for.", "example": "111222333444", "pattern": "^\\d{12}$", "type": "string" @@ -7533,25 +7533,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -7583,7 +7583,7 @@ "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "description": "AWS account the connection is created for.", "example": "111222333444", "pattern": "^\\d{12}$", "type": "string" @@ -7626,25 +7626,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -7708,7 +7708,7 @@ "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "description": "AWS account the connection is created for.", "example": "111222333444", "pattern": "^\\d{12}$", "type": "string" @@ -8545,25 +8545,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -8610,7 +8610,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -8765,7 +8765,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -8792,7 +8792,7 @@ "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "description": "AWS account the connection is created for.", "example": "111222333444", "pattern": "^\\d{12}$", "type": "string" @@ -8846,7 +8846,7 @@ "description": "The definition of `HTTPIntegrationUpdate` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -9009,7 +9009,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -9035,25 +9035,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -9100,7 +9100,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -9255,7 +9255,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -9267,7 +9267,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -9319,7 +9319,7 @@ "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "description": "AWS account the connection is created for.", "example": "111222333444", "pattern": "^\\d{12}$", "type": "string" @@ -9373,7 +9373,7 @@ "description": "The definition of `HTTPIntegrationUpdate` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -9536,7 +9536,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -9574,25 +9574,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -9639,7 +9639,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -9806,7 +9806,7 @@ "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "description": "AWS account the connection is created for.", "example": "111222333444", "pattern": "^\\d{12}$", "type": "string" @@ -9860,7 +9860,7 @@ "description": "The definition of `HTTPIntegrationUpdate` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -40570,7 +40570,7 @@ ] }, "CreateActionConnectionRequest": { - "description": "Request used to create an action connection.", + "description": "Request used to create an Action Connection.", "properties": { "data": { "description": "Data related to the connection.", @@ -40591,25 +40591,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -40656,7 +40656,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -40811,7 +40811,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -40823,7 +40823,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -40852,7 +40852,7 @@ "type": "object" }, "CreateActionConnectionResponse": { - "description": "The response for a created connection", + "description": "The response for a created connection.", "properties": { "data": { "description": "Data related to the connection.", @@ -40873,25 +40873,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -40938,7 +40938,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -41093,7 +41093,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -41105,7 +41105,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -74422,7 +74422,7 @@ ] }, "GetActionConnectionResponse": { - "description": "The response for found connection", + "description": "The response for found connection.", "properties": { "data": { "description": "Data related to the connection.", @@ -74443,25 +74443,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -74508,7 +74508,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -74663,7 +74663,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -74675,7 +74675,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -78793,7 +78793,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -78960,7 +78960,7 @@ "description": "The definition of `HTTPIntegrationUpdate` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -201549,7 +201549,7 @@ "type": "object" }, "UpdateActionConnectionRequest": { - "description": "Request used to update an action connection.", + "description": "Request used to update an Action Connection.", "properties": { "data": { "description": "Data related to the connection update.", @@ -201570,7 +201570,7 @@ "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "description": "AWS account the connection is created for.", "example": "111222333444", "pattern": "^\\d{12}$", "type": "string" @@ -201624,7 +201624,7 @@ "description": "The definition of `HTTPIntegrationUpdate` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -201787,7 +201787,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -201840,25 +201840,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -201905,7 +201905,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -202060,7 +202060,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -202072,7 +202072,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -227950,13 +227950,13 @@ "paths": { "/api/v2/actions/connections": { "post": { - "description": "Create a new Action Connection", + "description": "Create a new Action Connection.", "operationId": "CreateActionConnection", "requestBody": { "content": { "application/json": { "schema": { - "description": "Request used to create an action connection.", + "description": "Request used to create an Action Connection.", "properties": { "data": { "description": "Data related to the connection.", @@ -227977,25 +227977,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -228042,7 +228042,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -228197,7 +228197,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -228209,7 +228209,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -228246,7 +228246,7 @@ "content": { "application/json": { "schema": { - "description": "The response for a created connection", + "description": "The response for a created connection.", "properties": { "data": { "description": "Data related to the connection.", @@ -228267,25 +228267,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -228332,7 +228332,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -228487,7 +228487,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -228499,7 +228499,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -228526,7 +228526,7 @@ } } }, - "description": "Successfully created Action Connection" + "description": "Created" }, "400": { "content": { @@ -228727,12 +228727,12 @@ } } }, - "description": "Too Many Request" + "description": "Too Many Requests" } }, "summary": "Create a new Action Connection", "tags": [ - "Action Connection" + "Action Connections" ], "x-given": { "action_connection": { @@ -228746,6 +228746,12 @@ } }, "x-menu-order": 2, + "x-permission": { + "operator": "OR", + "permissions": [ + "connection_read" + ] + }, "x-undo": { "operationId": "DeleteActionConnection", "parameters": [ @@ -228760,11 +228766,11 @@ }, "/api/v2/actions/connections/{connection_id}": { "delete": { - "description": "Delete an existing Action Connection", + "description": "Delete an existing Action Connection.", "operationId": "DeleteActionConnection", "parameters": [ { - "description": "The ID of the action connection", + "description": "The ID of the Action Connection.", "in": "path", "name": "connection_id", "required": true, @@ -228775,7 +228781,7 @@ ], "responses": { "204": { - "description": "The resource was deleted successfully." + "description": "No Content" }, "403": { "content": { @@ -228976,12 +228982,12 @@ } } }, - "description": "Too Many Request" + "description": "Too Many Requests" } }, "summary": "Delete an existing Action Connection", "tags": [ - "Action Connection" + "Action Connections" ], "x-menu-order": 4, "x-permission": { @@ -228995,11 +229001,11 @@ } }, "get": { - "description": "Get an existing Action Connection", + "description": "Get an existing Action Connection.", "operationId": "GetActionConnection", "parameters": [ { - "description": "The ID of the action connection", + "description": "The ID of the Action Connection.", "in": "path", "name": "connection_id", "required": true, @@ -229013,7 +229019,7 @@ "content": { "application/json": { "schema": { - "description": "The response for found connection", + "description": "The response for found connection.", "properties": { "data": { "description": "Data related to the connection.", @@ -229034,25 +229040,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -229099,7 +229105,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -229254,7 +229260,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -229266,7 +229272,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -229293,7 +229299,7 @@ } } }, - "description": "Successfully get Action Connection" + "description": "OK" }, "400": { "content": { @@ -229561,14 +229567,20 @@ } } }, - "description": "Too Many Request" + "description": "Too Many Requests" } }, "summary": "Get an existing Action Connection", "tags": [ - "Action Connection" + "Action Connections" ], "x-menu-order": 1, + "x-permission": { + "operator": "OR", + "permissions": [ + "connection_read" + ] + }, "x-undo": { "type": "safe" } @@ -229578,7 +229590,7 @@ "operationId": "UpdateActionConnection", "parameters": [ { - "description": "The ID of the action connection", + "description": "The ID of the Action Connection.", "in": "path", "name": "connection_id", "required": true, @@ -229591,7 +229603,7 @@ "content": { "application/json": { "schema": { - "description": "Request used to update an action connection.", + "description": "Request used to update an Action Connection.", "properties": { "data": { "description": "Data related to the connection update.", @@ -229612,7 +229624,7 @@ "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "description": "AWS account the connection is created for.", "example": "111222333444", "pattern": "^\\d{12}$", "type": "string" @@ -229666,7 +229678,7 @@ "description": "The definition of `HTTPIntegrationUpdate` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -229829,7 +229841,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -229862,7 +229874,7 @@ } } }, - "description": "Update an existing Action Connection request body", + "description": "Update an existing Action Connection request body.", "required": true }, "responses": { @@ -229891,25 +229903,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -229956,7 +229968,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -230111,7 +230123,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -230123,7 +230135,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -230150,7 +230162,7 @@ } } }, - "description": "Successfully updated Action Connection" + "description": "OK" }, "400": { "content": { @@ -230418,14 +230430,20 @@ } } }, - "description": "Too Many Request" + "description": "Too Many Requests" } }, "summary": "Update an existing Action Connection", "tags": [ - "Action Connection" + "Action Connections" ], "x-menu-order": 3, + "x-permission": { + "operator": "OR", + "permissions": [ + "connection_write" + ] + }, "x-undo": { "type": "idempotent" } @@ -430829,12 +430847,12 @@ "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.", + "description": "Action Connections extend your installed integrations and allow you to take action in your third-party systems\n(such as AWS, GitLab, and OpenAI) with Datadog’s [Workflow Automation](https://docs.datadoghq.com/service_management/workflows/)\nand [App Builder](https://docs.datadoghq.com/service_management/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.\n\n**Note:** The Action Connection API supports AWS and HTTP integrations.", "externalDocs": { "description": "Find out more at", "url": "https://docs.datadoghq.com/service_management/workflows/connections/" }, - "name": "Action Connection" + "name": "Action Connections" }, { "description": "Datadog Agentless Scanning provides visibility into risks and vulnerabilities\nwithin your hosts, running containers, and serverless functions—all without\nrequiring teams to install Agents on every host or where Agents cannot be installed.\nGo to https://www.datadoghq.com/blog/agentless-scanning/ to learn more", diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index b721b6a1ea399..0eba5a09c2a7e 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1,23 +1,23 @@ { "CreateActionConnection": { - "description": "Create a new Action Connection", + "description": "Create a new Action Connection.", "summary": "Create a new Action Connection", "request_description": "", - "request_schema_description": "Request used to create an action connection." + "request_schema_description": "Request used to create an Action Connection." }, "DeleteActionConnection": { - "description": "Delete an existing Action Connection", + "description": "Delete an existing Action Connection.", "summary": "Delete an existing Action Connection" }, "GetActionConnection": { - "description": "Get an existing Action Connection", + "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." + "request_description": "Update an existing Action Connection request body.", + "request_schema_description": "Request used to update an Action Connection." }, "ListAwsScanOptions": { "description": "Fetches the scan options configured for AWS accounts.", diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index e2dc563abf6db..de301948e0cc0 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -15,9 +15,9 @@ "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." + "action-connections": { + "name": "Action Connections", + "description": "Action Connections extend your installed integrations and allow you to take action in your third-party systems\n(such as AWS, GitLab, and OpenAI) with Datadog’s [Workflow Automation](https://docs.datadoghq.com/service_management/workflows/)\nand [App Builder](https://docs.datadoghq.com/service_management/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.\n\n**Note:** The Action Connection API supports AWS and HTTP integrations." }, "agentless-scanning": { "name": "Agentless Scanning", diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index fafd8225aff5e..cef5f8fc1d2a1 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -311,7 +311,7 @@ } }, "ConnectionId": { - "description": "The ID of the action connection", + "description": "The ID of the Action Connection.", "in": "path", "name": "connection_id", "required": true, @@ -7352,25 +7352,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -7408,7 +7408,7 @@ "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "description": "AWS account the connection is created for.", "example": "111222333444", "pattern": "^\\d{12}$", "type": "string" @@ -7533,25 +7533,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -7583,7 +7583,7 @@ "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "description": "AWS account the connection is created for.", "example": "111222333444", "pattern": "^\\d{12}$", "type": "string" @@ -7626,25 +7626,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -7708,7 +7708,7 @@ "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "description": "AWS account the connection is created for.", "example": "111222333444", "pattern": "^\\d{12}$", "type": "string" @@ -8545,25 +8545,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -8610,7 +8610,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -8765,7 +8765,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -8792,7 +8792,7 @@ "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "description": "AWS account the connection is created for.", "example": "111222333444", "pattern": "^\\d{12}$", "type": "string" @@ -8846,7 +8846,7 @@ "description": "The definition of `HTTPIntegrationUpdate` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -9009,7 +9009,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -9035,25 +9035,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -9100,7 +9100,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -9255,7 +9255,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -9267,7 +9267,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -9319,7 +9319,7 @@ "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "description": "AWS account the connection is created for.", "example": "111222333444", "pattern": "^\\d{12}$", "type": "string" @@ -9373,7 +9373,7 @@ "description": "The definition of `HTTPIntegrationUpdate` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -9536,7 +9536,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -9574,25 +9574,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -9639,7 +9639,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -9806,7 +9806,7 @@ "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "description": "AWS account the connection is created for.", "example": "111222333444", "pattern": "^\\d{12}$", "type": "string" @@ -9860,7 +9860,7 @@ "description": "The definition of `HTTPIntegrationUpdate` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -40570,7 +40570,7 @@ ] }, "CreateActionConnectionRequest": { - "description": "Request used to create an action connection.", + "description": "Request used to create an Action Connection.", "properties": { "data": { "description": "Data related to the connection.", @@ -40591,25 +40591,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -40656,7 +40656,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -40811,7 +40811,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -40823,7 +40823,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -40852,7 +40852,7 @@ "type": "object" }, "CreateActionConnectionResponse": { - "description": "The response for a created connection", + "description": "The response for a created connection.", "properties": { "data": { "description": "Data related to the connection.", @@ -40873,25 +40873,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -40938,7 +40938,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -41093,7 +41093,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -41105,7 +41105,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -74422,7 +74422,7 @@ ] }, "GetActionConnectionResponse": { - "description": "The response for found connection", + "description": "The response for found connection.", "properties": { "data": { "description": "Data related to the connection.", @@ -74443,25 +74443,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -74508,7 +74508,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -74663,7 +74663,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -74675,7 +74675,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -78793,7 +78793,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -78960,7 +78960,7 @@ "description": "The definition of `HTTPIntegrationUpdate` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -201549,7 +201549,7 @@ "type": "object" }, "UpdateActionConnectionRequest": { - "description": "Request used to update an action connection.", + "description": "Request used to update an Action Connection.", "properties": { "data": { "description": "Data related to the connection update.", @@ -201570,7 +201570,7 @@ "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "description": "AWS account the connection is created for.", "example": "111222333444", "pattern": "^\\d{12}$", "type": "string" @@ -201624,7 +201624,7 @@ "description": "The definition of `HTTPIntegrationUpdate` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -201787,7 +201787,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -201840,25 +201840,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -201905,7 +201905,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -202060,7 +202060,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -202072,7 +202072,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -227950,13 +227950,13 @@ "paths": { "/api/v2/actions/connections": { "post": { - "description": "Create a new Action Connection", + "description": "Create a new Action Connection.", "operationId": "CreateActionConnection", "requestBody": { "content": { "application/json": { "schema": { - "description": "Request used to create an action connection.", + "description": "Request used to create an Action Connection.", "properties": { "data": { "description": "Data related to the connection.", @@ -227977,25 +227977,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -228042,7 +228042,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -228197,7 +228197,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -228209,7 +228209,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -228246,7 +228246,7 @@ "content": { "application/json": { "schema": { - "description": "The response for a created connection", + "description": "The response for a created connection.", "properties": { "data": { "description": "Data related to the connection.", @@ -228267,25 +228267,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -228332,7 +228332,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -228487,7 +228487,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -228499,7 +228499,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -228526,7 +228526,7 @@ } } }, - "description": "Successfully created Action Connection" + "description": "Created" }, "400": { "content": { @@ -228727,12 +228727,12 @@ } } }, - "description": "Too Many Request" + "description": "Too Many Requests" } }, "summary": "Create a new Action Connection", "tags": [ - "Action Connection" + "Action Connections" ], "x-given": { "action_connection": { @@ -228746,6 +228746,12 @@ } }, "x-menu-order": 2, + "x-permission": { + "operator": "OR", + "permissions": [ + "connection_read" + ] + }, "x-undo": { "operationId": "DeleteActionConnection", "parameters": [ @@ -228760,11 +228766,11 @@ }, "/api/v2/actions/connections/{connection_id}": { "delete": { - "description": "Delete an existing Action Connection", + "description": "Delete an existing Action Connection.", "operationId": "DeleteActionConnection", "parameters": [ { - "description": "The ID of the action connection", + "description": "The ID of the Action Connection.", "in": "path", "name": "connection_id", "required": true, @@ -228775,7 +228781,7 @@ ], "responses": { "204": { - "description": "The resource was deleted successfully." + "description": "No Content" }, "403": { "content": { @@ -228976,12 +228982,12 @@ } } }, - "description": "Too Many Request" + "description": "Too Many Requests" } }, "summary": "Delete an existing Action Connection", "tags": [ - "Action Connection" + "Action Connections" ], "x-menu-order": 4, "x-permission": { @@ -228995,11 +229001,11 @@ } }, "get": { - "description": "Get an existing Action Connection", + "description": "Get an existing Action Connection.", "operationId": "GetActionConnection", "parameters": [ { - "description": "The ID of the action connection", + "description": "The ID of the Action Connection.", "in": "path", "name": "connection_id", "required": true, @@ -229013,7 +229019,7 @@ "content": { "application/json": { "schema": { - "description": "The response for found connection", + "description": "The response for found connection.", "properties": { "data": { "description": "Data related to the connection.", @@ -229034,25 +229040,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -229099,7 +229105,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -229254,7 +229260,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -229266,7 +229272,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -229293,7 +229299,7 @@ } } }, - "description": "Successfully get Action Connection" + "description": "OK" }, "400": { "content": { @@ -229561,14 +229567,20 @@ } } }, - "description": "Too Many Request" + "description": "Too Many Requests" } }, "summary": "Get an existing Action Connection", "tags": [ - "Action Connection" + "Action Connections" ], "x-menu-order": 1, + "x-permission": { + "operator": "OR", + "permissions": [ + "connection_read" + ] + }, "x-undo": { "type": "safe" } @@ -229578,7 +229590,7 @@ "operationId": "UpdateActionConnection", "parameters": [ { - "description": "The ID of the action connection", + "description": "The ID of the Action Connection.", "in": "path", "name": "connection_id", "required": true, @@ -229591,7 +229603,7 @@ "content": { "application/json": { "schema": { - "description": "Request used to update an action connection.", + "description": "Request used to update an Action Connection.", "properties": { "data": { "description": "Data related to the connection update.", @@ -229612,7 +229624,7 @@ "description": "The definition of `AWSAssumeRoleUpdate` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "description": "AWS account the connection is created for.", "example": "111222333444", "pattern": "^\\d{12}$", "type": "string" @@ -229666,7 +229678,7 @@ "description": "The definition of `HTTPIntegrationUpdate` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -229829,7 +229841,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -229862,7 +229874,7 @@ } } }, - "description": "Update an existing Action Connection request body", + "description": "Update an existing Action Connection request body.", "required": true }, "responses": { @@ -229891,25 +229903,25 @@ "description": "The definition of `AWSAssumeRole` object.", "properties": { "account_id": { - "description": "AWS account the connection is created for", + "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", + "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", + "description": "AWS account that will assume the role.", "example": "123456789012", "readOnly": true, "type": "string" }, "role": { - "description": "Role to assume", + "description": "Role to assume.", "example": "my-role", "type": "string" }, @@ -229956,7 +229968,7 @@ "description": "The definition of `HTTPIntegration` object.", "properties": { "base_url": { - "description": "Base HTTP url for the integration", + "description": "Base HTTP url for the integration.", "example": "http://datadoghq.com", "pattern": "url", "type": "string" @@ -230111,7 +230123,7 @@ ] }, "name": { - "description": "Name of the connection", + "description": "Name of the connection.", "example": "My AWS Connection", "type": "string" } @@ -230123,7 +230135,7 @@ "type": "object" }, "id": { - "description": "The connection identifier", + "description": "The connection identifier.", "readOnly": true, "type": "string" }, @@ -230150,7 +230162,7 @@ } } }, - "description": "Successfully updated Action Connection" + "description": "OK" }, "400": { "content": { @@ -230418,14 +230430,20 @@ } } }, - "description": "Too Many Request" + "description": "Too Many Requests" } }, "summary": "Update an existing Action Connection", "tags": [ - "Action Connection" + "Action Connections" ], "x-menu-order": 3, + "x-permission": { + "operator": "OR", + "permissions": [ + "connection_write" + ] + }, "x-undo": { "type": "idempotent" } @@ -430829,12 +430847,12 @@ "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.", + "description": "Action Connections extend your installed integrations and allow you to take action in your third-party systems\n(such as AWS, GitLab, and OpenAI) with Datadog’s [Workflow Automation](https://docs.datadoghq.com/service_management/workflows/)\nand [App Builder](https://docs.datadoghq.com/service_management/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.\n\n**Note:** The Action Connection API supports AWS and HTTP integrations.", "externalDocs": { "description": "Find out more at", "url": "https://docs.datadoghq.com/service_management/workflows/connections/" }, - "name": "Action Connection" + "name": "Action Connections" }, { "description": "Datadog Agentless Scanning provides visibility into risks and vulnerabilities\nwithin your hosts, running containers, and serverless functions—all without\nrequiring teams to install Agents on every host or where Agents cannot be installed.\nGo to https://www.datadoghq.com/blog/agentless-scanning/ to learn more",