diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 3367116f801..83dc8df0880 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -11735,6 +11735,75 @@ menu: - GetDomainAllowlist unstable: [] order: 1 + - name: Elastic Cloud Integration Accounts + url: /api/latest/elastic-cloud-integration-accounts/ + identifier: elastic-cloud-integration-accounts + generated: true + - name: Update an Elastic Cloud integration account + url: /api/latest/elastic-cloud-integration-accounts/update-an-elastic-cloud-integration-account/ + identifier: elastic-cloud-integration-accounts-update-an-elastic-cloud-integration-account + parent: elastic-cloud-integration-accounts + generated: true + params: + versions: + - v2 + operationids: + - UpdateElasticCloudIntegrationAccount + unstable: + - v2 + order: 4 + - name: Get an Elastic Cloud integration account + url: /api/latest/elastic-cloud-integration-accounts/get-an-elastic-cloud-integration-account/ + identifier: elastic-cloud-integration-accounts-get-an-elastic-cloud-integration-account + parent: elastic-cloud-integration-accounts + generated: true + params: + versions: + - v2 + operationids: + - GetElasticCloudIntegrationAccount + unstable: + - v2 + order: 3 + - name: Delete an Elastic Cloud integration account + url: /api/latest/elastic-cloud-integration-accounts/delete-an-elastic-cloud-integration-account/ + identifier: elastic-cloud-integration-accounts-delete-an-elastic-cloud-integration-account + parent: elastic-cloud-integration-accounts + generated: true + params: + versions: + - v2 + operationids: + - DeleteElasticCloudIntegrationAccount + unstable: + - v2 + order: 5 + - name: Create an Elastic Cloud integration account + url: /api/latest/elastic-cloud-integration-accounts/create-an-elastic-cloud-integration-account/ + identifier: elastic-cloud-integration-accounts-create-an-elastic-cloud-integration-account + parent: elastic-cloud-integration-accounts + generated: true + params: + versions: + - v2 + operationids: + - CreateElasticCloudIntegrationAccount + unstable: + - v2 + order: 2 + - name: List Elastic Cloud integration accounts + url: /api/latest/elastic-cloud-integration-accounts/list-elastic-cloud-integration-accounts/ + identifier: elastic-cloud-integration-accounts-list-elastic-cloud-integration-accounts + parent: elastic-cloud-integration-accounts + generated: true + params: + versions: + - v2 + operationids: + - ListElasticCloudIntegrationAccounts + unstable: + - v2 + order: 1 - name: Entity Integration Configs url: /api/latest/entity-integration-configs/ identifier: entity-integration-configs @@ -21018,6 +21087,75 @@ menu: - UpdateFlakyTestsManagementPolicies unstable: [] order: 7 + - name: Twilio Integration Accounts + url: /api/latest/twilio-integration-accounts/ + identifier: twilio-integration-accounts + generated: true + - name: Update a Twilio integration account + url: /api/latest/twilio-integration-accounts/update-a-twilio-integration-account/ + identifier: twilio-integration-accounts-update-a-twilio-integration-account + parent: twilio-integration-accounts + generated: true + params: + versions: + - v2 + operationids: + - UpdateTwilioIntegrationAccount + unstable: + - v2 + order: 4 + - name: Get a Twilio integration account + url: /api/latest/twilio-integration-accounts/get-a-twilio-integration-account/ + identifier: twilio-integration-accounts-get-a-twilio-integration-account + parent: twilio-integration-accounts + generated: true + params: + versions: + - v2 + operationids: + - GetTwilioIntegrationAccount + unstable: + - v2 + order: 3 + - name: Delete a Twilio integration account + url: /api/latest/twilio-integration-accounts/delete-a-twilio-integration-account/ + identifier: twilio-integration-accounts-delete-a-twilio-integration-account + parent: twilio-integration-accounts + generated: true + params: + versions: + - v2 + operationids: + - DeleteTwilioIntegrationAccount + unstable: + - v2 + order: 5 + - name: Create a Twilio integration account + url: /api/latest/twilio-integration-accounts/create-a-twilio-integration-account/ + identifier: twilio-integration-accounts-create-a-twilio-integration-account + parent: twilio-integration-accounts + generated: true + params: + versions: + - v2 + operationids: + - CreateTwilioIntegrationAccount + unstable: + - v2 + order: 2 + - name: List Twilio integration accounts + url: /api/latest/twilio-integration-accounts/list-twilio-integration-accounts/ + identifier: twilio-integration-accounts-list-twilio-integration-accounts + parent: twilio-integration-accounts + generated: true + params: + versions: + - v2 + operationids: + - ListTwilioIntegrationAccounts + unstable: + - v2 + order: 1 - name: User Authorized Clients url: /api/latest/user-authorized-clients/ identifier: user-authorized-clients diff --git a/content/en/api/latest/elastic-cloud-integration-accounts/_index.md b/content/en/api/latest/elastic-cloud-integration-accounts/_index.md new file mode 100644 index 00000000000..67180dd2b13 --- /dev/null +++ b/content/en/api/latest/elastic-cloud-integration-accounts/_index.md @@ -0,0 +1,3 @@ +--- +title: Elastic Cloud Integration Accounts +--- diff --git a/content/en/api/latest/elastic-cloud-integration-accounts/create-an-elastic-cloud-integration-account/index.md b/content/en/api/latest/elastic-cloud-integration-accounts/create-an-elastic-cloud-integration-account/index.md new file mode 100644 index 00000000000..4d0f9c1779d --- /dev/null +++ b/content/en/api/latest/elastic-cloud-integration-accounts/create-an-elastic-cloud-integration-account/index.md @@ -0,0 +1,3 @@ +--- +title: Create an Elastic Cloud integration account +--- diff --git a/content/en/api/latest/elastic-cloud-integration-accounts/delete-an-elastic-cloud-integration-account/index.md b/content/en/api/latest/elastic-cloud-integration-accounts/delete-an-elastic-cloud-integration-account/index.md new file mode 100644 index 00000000000..2364de09f21 --- /dev/null +++ b/content/en/api/latest/elastic-cloud-integration-accounts/delete-an-elastic-cloud-integration-account/index.md @@ -0,0 +1,3 @@ +--- +title: Delete an Elastic Cloud integration account +--- diff --git a/content/en/api/latest/elastic-cloud-integration-accounts/get-an-elastic-cloud-integration-account/index.md b/content/en/api/latest/elastic-cloud-integration-accounts/get-an-elastic-cloud-integration-account/index.md new file mode 100644 index 00000000000..c26e4d4519e --- /dev/null +++ b/content/en/api/latest/elastic-cloud-integration-accounts/get-an-elastic-cloud-integration-account/index.md @@ -0,0 +1,3 @@ +--- +title: Get an Elastic Cloud integration account +--- diff --git a/content/en/api/latest/elastic-cloud-integration-accounts/list-elastic-cloud-integration-accounts/index.md b/content/en/api/latest/elastic-cloud-integration-accounts/list-elastic-cloud-integration-accounts/index.md new file mode 100644 index 00000000000..f15a9c2f47e --- /dev/null +++ b/content/en/api/latest/elastic-cloud-integration-accounts/list-elastic-cloud-integration-accounts/index.md @@ -0,0 +1,3 @@ +--- +title: List Elastic Cloud integration accounts +--- diff --git a/content/en/api/latest/elastic-cloud-integration-accounts/update-an-elastic-cloud-integration-account/index.md b/content/en/api/latest/elastic-cloud-integration-accounts/update-an-elastic-cloud-integration-account/index.md new file mode 100644 index 00000000000..af23d6c4ca4 --- /dev/null +++ b/content/en/api/latest/elastic-cloud-integration-accounts/update-an-elastic-cloud-integration-account/index.md @@ -0,0 +1,3 @@ +--- +title: Update an Elastic Cloud integration account +--- diff --git a/content/en/api/latest/twilio-integration-accounts/_index.md b/content/en/api/latest/twilio-integration-accounts/_index.md new file mode 100644 index 00000000000..eb26262f7bc --- /dev/null +++ b/content/en/api/latest/twilio-integration-accounts/_index.md @@ -0,0 +1,3 @@ +--- +title: Twilio Integration Accounts +--- diff --git a/content/en/api/latest/twilio-integration-accounts/create-a-twilio-integration-account/index.md b/content/en/api/latest/twilio-integration-accounts/create-a-twilio-integration-account/index.md new file mode 100644 index 00000000000..38dc286647d --- /dev/null +++ b/content/en/api/latest/twilio-integration-accounts/create-a-twilio-integration-account/index.md @@ -0,0 +1,3 @@ +--- +title: Create a Twilio integration account +--- diff --git a/content/en/api/latest/twilio-integration-accounts/delete-a-twilio-integration-account/index.md b/content/en/api/latest/twilio-integration-accounts/delete-a-twilio-integration-account/index.md new file mode 100644 index 00000000000..b0df038fc2a --- /dev/null +++ b/content/en/api/latest/twilio-integration-accounts/delete-a-twilio-integration-account/index.md @@ -0,0 +1,3 @@ +--- +title: Delete a Twilio integration account +--- diff --git a/content/en/api/latest/twilio-integration-accounts/get-a-twilio-integration-account/index.md b/content/en/api/latest/twilio-integration-accounts/get-a-twilio-integration-account/index.md new file mode 100644 index 00000000000..f8b665d4191 --- /dev/null +++ b/content/en/api/latest/twilio-integration-accounts/get-a-twilio-integration-account/index.md @@ -0,0 +1,3 @@ +--- +title: Get a Twilio integration account +--- diff --git a/content/en/api/latest/twilio-integration-accounts/list-twilio-integration-accounts/index.md b/content/en/api/latest/twilio-integration-accounts/list-twilio-integration-accounts/index.md new file mode 100644 index 00000000000..db7b1da1570 --- /dev/null +++ b/content/en/api/latest/twilio-integration-accounts/list-twilio-integration-accounts/index.md @@ -0,0 +1,3 @@ +--- +title: List Twilio integration accounts +--- diff --git a/content/en/api/latest/twilio-integration-accounts/update-a-twilio-integration-account/index.md b/content/en/api/latest/twilio-integration-accounts/update-a-twilio-integration-account/index.md new file mode 100644 index 00000000000..985cd666c0b --- /dev/null +++ b/content/en/api/latest/twilio-integration-accounts/update-a-twilio-integration-account/index.md @@ -0,0 +1,3 @@ +--- +title: Update a Twilio integration account +--- diff --git a/content/en/api/v2/elastic-cloud-integration-accounts/_index.md b/content/en/api/v2/elastic-cloud-integration-accounts/_index.md new file mode 100644 index 00000000000..637b9ada4fc --- /dev/null +++ b/content/en/api/v2/elastic-cloud-integration-accounts/_index.md @@ -0,0 +1,4 @@ +--- +title: Elastic Cloud Integration Accounts +headless: true +--- diff --git a/content/en/api/v2/elastic-cloud-integration-accounts/examples.json b/content/en/api/v2/elastic-cloud-integration-accounts/examples.json new file mode 100644 index 00000000000..7233c9c32b1 --- /dev/null +++ b/content/en/api/v2/elastic-cloud-integration-accounts/examples.json @@ -0,0 +1,499 @@ +{ + "ListElasticCloudIntegrationAccounts": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "interface": { + "authentication": { + "password": "your-password", + "type": "basic", + "username": "datadog" + }, + "dataflows": [ + { + "enabled": true, + "id": "elastic-cloud-metrics", + "status": { + "health": "DATAFLOW_HEALTH_OK", + "message": "", + "updated_at": "2026-06-25T08:30:50Z" + } + } + ], + "settings": { + "cat_allocation_stats_enabled": false, + "detailed_index_stats_enabled": false, + "index_stats_enabled": false, + "pending_task_stats_enabled": false, + "pshard_graceful_to_enabled": false, + "pshard_stats_enabled": false, + "slm_stats_enabled": false, + "tags": [ + "env:prod" + ], + "url": "https://example.es.us-central1.gcp.cloud.es.io:9243" + }, + "type": "elastic-cloud" + }, + "name": "elastic-cloud-prod", + "permissions": { + "resource_id": "integration-account:twilio:953a0060-81ec-4221-aed4-d4733b59cd96", + "user_can_edit": true + } + }, + "id": "953a0060-81ec-4221-aed4-d4733b59cd96", + "type": "integration-account" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of Elastic Cloud integration accounts.

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

attributes [required]

\n
\n

object

\n

Attributes of an Elastic Cloud integration account.

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

interface [required]

\n
\n

 <oneOf>

\n

Elastic Cloud interface (source-type). Exactly one interface variant is set, selected by its type.

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

<type=elastic-cloud>

\n
\n

object

\n

Elastic Cloud monitoring interface (source-type) configuration.

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

authentication [required]

\n
\n

 <oneOf>

\n

Authentication methods supported by the Elastic Cloud interface. Exactly one is set, selected by its type.

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

<type=basic>

\n
\n

object

\n

Username & password authentication for Elastic Cloud.

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

password [required]

\n
\n

string

\n

Password used to authenticate against the deployment. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: basic

default: basic

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

username [required]

\n
\n

string

\n

Username used to authenticate against the deployment.

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

dataflows

\n
\n

[object]

\n

Dataflows for the Elastic Cloud monitoring interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of an Elastic Cloud dataflow. \nAllowed enum values: elastic-cloud-metrics

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Elastic Cloud interface settings.

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

cat_allocation_stats_enabled

\n
\n

boolean

\n

Enable to collect shard allocation metrics.

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

detailed_index_stats_enabled

\n
\n

boolean

\n

Enable to collect index-specific stats.

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

index_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics about the indices in your cluster.

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

pending_task_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics about pending tasks.

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

pshard_graceful_to_enabled

\n
\n

boolean

\n

Enable to collect all metrics even if primary shard metric collection times out.

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

pshard_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics over primary shards.

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

slm_stats_enabled

\n
\n

boolean

\n

Enable to collect snapshot lifecycle management metrics.

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

tags

\n
\n

[string]

\n

Custom tags for this deployment.

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

url [required]

\n
\n

string

\n

Deployment URL.

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

type [required]

\n
\n

enum

\n

Interface discriminator for the Elastic Cloud monitoring interface. \nAllowed enum values: elastic-cloud

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

<type=elastic-cloud-ccm>

\n
\n

object

\n

Elastic Cloud CCM (Cloud Cost Management) interface configuration.

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

authentication [required]

\n
\n

 <oneOf>

\n

Authentication methods supported by the Elastic Cloud CCM interface. Exactly one is set, selected by its type.

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

<type=bearer_token>

\n
\n

object

\n

Encrypted token (bearer token) authentication for Elastic Cloud CCM.

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

api_key [required]

\n
\n

string

\n

Billing API key. An Elastic Cloud API key with read access to both Billing and Deployments. Create one under Organization settings > API Keys. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: bearer_token

default: bearer_token

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

dataflows

\n
\n

[object]

\n

Dataflows for the Elastic Cloud CCM interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of an Elastic Cloud CCM dataflow. \nAllowed enum values: elastic-cloud-cost-data

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Elastic Cloud CCM interface settings.

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

elastic_org_id [required]

\n
\n

string

\n

Your Elastic Cloud organization ID, found in your organization settings.

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

type [required]

\n
\n

enum

\n

Interface discriminator for the Elastic Cloud CCM interface. \nAllowed enum values: elastic-cloud-ccm

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

name [required]

\n
\n

string

\n

Human-readable name of the account.

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

permissions

\n
\n

object

\n

Read-only permission information for the account, derived from its restriction policy.

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

resource_id

\n
\n

string

\n

Restriction-policy resource identifier of this account.

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

user_can_edit

\n
\n

boolean

\n

Whether the requesting user may edit this account.

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

id [required]

\n
\n

string

\n

Server-generated unique identifier of the integration account.

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

type [required]

\n
\n

enum

\n

JSON:API resource type for an integration account. Always integration-account. \nAllowed enum values: integration-account

default: integration-account

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateElasticCloudIntegrationAccount": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "interface": { + "authentication": { + "password": "your-password", + "type": "basic", + "username": "datadog" + }, + "dataflows": [ + { + "enabled": true, + "id": "elastic-cloud-metrics", + "status": { + "health": "DATAFLOW_HEALTH_OK", + "message": "", + "updated_at": "2026-06-25T08:30:50Z" + } + } + ], + "settings": { + "cat_allocation_stats_enabled": false, + "detailed_index_stats_enabled": false, + "index_stats_enabled": false, + "pending_task_stats_enabled": false, + "pshard_graceful_to_enabled": false, + "pshard_stats_enabled": false, + "slm_stats_enabled": false, + "tags": [ + "env:prod" + ], + "url": "https://example.es.us-central1.gcp.cloud.es.io:9243" + }, + "type": "elastic-cloud" + }, + "name": "elastic-cloud-prod", + "permissions": { + "resource_id": "integration-account:twilio:953a0060-81ec-4221-aed4-d4733b59cd96", + "user_can_edit": true + } + }, + "id": "953a0060-81ec-4221-aed4-d4733b59cd96", + "type": "integration-account" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data envelope of an Elastic Cloud integration account, including server-assigned identity.

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

attributes [required]

\n
\n

object

\n

Attributes of an Elastic Cloud integration account.

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

interface [required]

\n
\n

 <oneOf>

\n

Elastic Cloud interface (source-type). Exactly one interface variant is set, selected by its type.

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

<type=elastic-cloud>

\n
\n

object

\n

Elastic Cloud monitoring interface (source-type) configuration.

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

authentication [required]

\n
\n

 <oneOf>

\n

Authentication methods supported by the Elastic Cloud interface. Exactly one is set, selected by its type.

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

<type=basic>

\n
\n

object

\n

Username & password authentication for Elastic Cloud.

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

password [required]

\n
\n

string

\n

Password used to authenticate against the deployment. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: basic

default: basic

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

username [required]

\n
\n

string

\n

Username used to authenticate against the deployment.

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

dataflows

\n
\n

[object]

\n

Dataflows for the Elastic Cloud monitoring interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of an Elastic Cloud dataflow. \nAllowed enum values: elastic-cloud-metrics

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Elastic Cloud interface settings.

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

cat_allocation_stats_enabled

\n
\n

boolean

\n

Enable to collect shard allocation metrics.

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

detailed_index_stats_enabled

\n
\n

boolean

\n

Enable to collect index-specific stats.

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

index_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics about the indices in your cluster.

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

pending_task_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics about pending tasks.

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

pshard_graceful_to_enabled

\n
\n

boolean

\n

Enable to collect all metrics even if primary shard metric collection times out.

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

pshard_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics over primary shards.

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

slm_stats_enabled

\n
\n

boolean

\n

Enable to collect snapshot lifecycle management metrics.

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

tags

\n
\n

[string]

\n

Custom tags for this deployment.

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

url [required]

\n
\n

string

\n

Deployment URL.

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

type [required]

\n
\n

enum

\n

Interface discriminator for the Elastic Cloud monitoring interface. \nAllowed enum values: elastic-cloud

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

<type=elastic-cloud-ccm>

\n
\n

object

\n

Elastic Cloud CCM (Cloud Cost Management) interface configuration.

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

authentication [required]

\n
\n

 <oneOf>

\n

Authentication methods supported by the Elastic Cloud CCM interface. Exactly one is set, selected by its type.

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

<type=bearer_token>

\n
\n

object

\n

Encrypted token (bearer token) authentication for Elastic Cloud CCM.

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

api_key [required]

\n
\n

string

\n

Billing API key. An Elastic Cloud API key with read access to both Billing and Deployments. Create one under Organization settings > API Keys. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: bearer_token

default: bearer_token

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

dataflows

\n
\n

[object]

\n

Dataflows for the Elastic Cloud CCM interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of an Elastic Cloud CCM dataflow. \nAllowed enum values: elastic-cloud-cost-data

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Elastic Cloud CCM interface settings.

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

elastic_org_id [required]

\n
\n

string

\n

Your Elastic Cloud organization ID, found in your organization settings.

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

type [required]

\n
\n

enum

\n

Interface discriminator for the Elastic Cloud CCM interface. \nAllowed enum values: elastic-cloud-ccm

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

name [required]

\n
\n

string

\n

Human-readable name of the account.

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

permissions

\n
\n

object

\n

Read-only permission information for the account, derived from its restriction policy.

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

resource_id

\n
\n

string

\n

Restriction-policy resource identifier of this account.

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

user_can_edit

\n
\n

boolean

\n

Whether the requesting user may edit this account.

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

id [required]

\n
\n

string

\n

Server-generated unique identifier of the integration account.

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

type [required]

\n
\n

enum

\n

JSON:API resource type for an integration account. Always integration-account. \nAllowed enum values: integration-account

default: integration-account

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "interface": { + "dataflows": [ + { + "id": "elastic-cloud-metrics" + } + ], + "settings": { + "url": "https://example.es.us-central1.gcp.cloud.es.io:9243" + } + }, + "name": "elastic-cloud-prod" + }, + "type": "integration-account" + } + }, + "json": { + "data": { + "attributes": { + "interface": { + "authentication": { + "password": "your-password", + "type": "basic", + "username": "datadog" + }, + "dataflows": [ + { + "enabled": true, + "id": "elastic-cloud-metrics" + } + ], + "settings": { + "cat_allocation_stats_enabled": false, + "detailed_index_stats_enabled": false, + "index_stats_enabled": false, + "pending_task_stats_enabled": false, + "pshard_graceful_to_enabled": false, + "pshard_stats_enabled": false, + "slm_stats_enabled": false, + "tags": [ + "env:prod" + ], + "url": "https://example.es.us-central1.gcp.cloud.es.io:9243" + }, + "type": "elastic-cloud" + }, + "name": "elastic-cloud-prod" + }, + "type": "integration-account" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data envelope for creating an Elastic Cloud integration account.

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

attributes [required]

\n
\n

object

\n

Attributes of an Elastic Cloud integration account.

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

interface [required]

\n
\n

 <oneOf>

\n

Elastic Cloud interface (source-type). Exactly one interface variant is set, selected by its type.

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

<type=elastic-cloud>

\n
\n

object

\n

Elastic Cloud monitoring interface (source-type) configuration.

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

authentication [required]

\n
\n

 <oneOf>

\n

Authentication methods supported by the Elastic Cloud interface. Exactly one is set, selected by its type.

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

<type=basic>

\n
\n

object

\n

Username & password authentication for Elastic Cloud.

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

password [required]

\n
\n

string

\n

Password used to authenticate against the deployment. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: basic

default: basic

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

username [required]

\n
\n

string

\n

Username used to authenticate against the deployment.

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

dataflows

\n
\n

[object]

\n

Dataflows for the Elastic Cloud monitoring interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of an Elastic Cloud dataflow. \nAllowed enum values: elastic-cloud-metrics

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Elastic Cloud interface settings.

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

cat_allocation_stats_enabled

\n
\n

boolean

\n

Enable to collect shard allocation metrics.

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

detailed_index_stats_enabled

\n
\n

boolean

\n

Enable to collect index-specific stats.

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

index_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics about the indices in your cluster.

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

pending_task_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics about pending tasks.

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

pshard_graceful_to_enabled

\n
\n

boolean

\n

Enable to collect all metrics even if primary shard metric collection times out.

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

pshard_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics over primary shards.

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

slm_stats_enabled

\n
\n

boolean

\n

Enable to collect snapshot lifecycle management metrics.

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

tags

\n
\n

[string]

\n

Custom tags for this deployment.

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

url [required]

\n
\n

string

\n

Deployment URL.

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

type [required]

\n
\n

enum

\n

Interface discriminator for the Elastic Cloud monitoring interface. \nAllowed enum values: elastic-cloud

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

<type=elastic-cloud-ccm>

\n
\n

object

\n

Elastic Cloud CCM (Cloud Cost Management) interface configuration.

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

authentication [required]

\n
\n

 <oneOf>

\n

Authentication methods supported by the Elastic Cloud CCM interface. Exactly one is set, selected by its type.

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

<type=bearer_token>

\n
\n

object

\n

Encrypted token (bearer token) authentication for Elastic Cloud CCM.

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

api_key [required]

\n
\n

string

\n

Billing API key. An Elastic Cloud API key with read access to both Billing and Deployments. Create one under Organization settings > API Keys. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: bearer_token

default: bearer_token

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

dataflows

\n
\n

[object]

\n

Dataflows for the Elastic Cloud CCM interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of an Elastic Cloud CCM dataflow. \nAllowed enum values: elastic-cloud-cost-data

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Elastic Cloud CCM interface settings.

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

elastic_org_id [required]

\n
\n

string

\n

Your Elastic Cloud organization ID, found in your organization settings.

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

type [required]

\n
\n

enum

\n

Interface discriminator for the Elastic Cloud CCM interface. \nAllowed enum values: elastic-cloud-ccm

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

name [required]

\n
\n

string

\n

Human-readable name of the account.

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

permissions

\n
\n

object

\n

Read-only permission information for the account, derived from its restriction policy.

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

resource_id

\n
\n

string

\n

Restriction-policy resource identifier of this account.

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

user_can_edit

\n
\n

boolean

\n

Whether the requesting user may edit this account.

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

type [required]

\n
\n

enum

\n

JSON:API resource type for an integration account. Always integration-account. \nAllowed enum values: integration-account

default: integration-account

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetElasticCloudIntegrationAccount": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "interface": { + "authentication": { + "password": "your-password", + "type": "basic", + "username": "datadog" + }, + "dataflows": [ + { + "enabled": true, + "id": "elastic-cloud-metrics", + "status": { + "health": "DATAFLOW_HEALTH_OK", + "message": "", + "updated_at": "2026-06-25T08:30:50Z" + } + } + ], + "settings": { + "cat_allocation_stats_enabled": false, + "detailed_index_stats_enabled": false, + "index_stats_enabled": false, + "pending_task_stats_enabled": false, + "pshard_graceful_to_enabled": false, + "pshard_stats_enabled": false, + "slm_stats_enabled": false, + "tags": [ + "env:prod" + ], + "url": "https://example.es.us-central1.gcp.cloud.es.io:9243" + }, + "type": "elastic-cloud" + }, + "name": "elastic-cloud-prod", + "permissions": { + "resource_id": "integration-account:twilio:953a0060-81ec-4221-aed4-d4733b59cd96", + "user_can_edit": true + } + }, + "id": "953a0060-81ec-4221-aed4-d4733b59cd96", + "type": "integration-account" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data envelope of an Elastic Cloud integration account, including server-assigned identity.

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

attributes [required]

\n
\n

object

\n

Attributes of an Elastic Cloud integration account.

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

interface [required]

\n
\n

 <oneOf>

\n

Elastic Cloud interface (source-type). Exactly one interface variant is set, selected by its type.

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

<type=elastic-cloud>

\n
\n

object

\n

Elastic Cloud monitoring interface (source-type) configuration.

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

authentication [required]

\n
\n

 <oneOf>

\n

Authentication methods supported by the Elastic Cloud interface. Exactly one is set, selected by its type.

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

<type=basic>

\n
\n

object

\n

Username & password authentication for Elastic Cloud.

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

password [required]

\n
\n

string

\n

Password used to authenticate against the deployment. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: basic

default: basic

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

username [required]

\n
\n

string

\n

Username used to authenticate against the deployment.

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

dataflows

\n
\n

[object]

\n

Dataflows for the Elastic Cloud monitoring interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of an Elastic Cloud dataflow. \nAllowed enum values: elastic-cloud-metrics

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Elastic Cloud interface settings.

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

cat_allocation_stats_enabled

\n
\n

boolean

\n

Enable to collect shard allocation metrics.

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

detailed_index_stats_enabled

\n
\n

boolean

\n

Enable to collect index-specific stats.

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

index_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics about the indices in your cluster.

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

pending_task_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics about pending tasks.

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

pshard_graceful_to_enabled

\n
\n

boolean

\n

Enable to collect all metrics even if primary shard metric collection times out.

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

pshard_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics over primary shards.

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

slm_stats_enabled

\n
\n

boolean

\n

Enable to collect snapshot lifecycle management metrics.

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

tags

\n
\n

[string]

\n

Custom tags for this deployment.

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

url [required]

\n
\n

string

\n

Deployment URL.

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

type [required]

\n
\n

enum

\n

Interface discriminator for the Elastic Cloud monitoring interface. \nAllowed enum values: elastic-cloud

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

<type=elastic-cloud-ccm>

\n
\n

object

\n

Elastic Cloud CCM (Cloud Cost Management) interface configuration.

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

authentication [required]

\n
\n

 <oneOf>

\n

Authentication methods supported by the Elastic Cloud CCM interface. Exactly one is set, selected by its type.

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

<type=bearer_token>

\n
\n

object

\n

Encrypted token (bearer token) authentication for Elastic Cloud CCM.

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

api_key [required]

\n
\n

string

\n

Billing API key. An Elastic Cloud API key with read access to both Billing and Deployments. Create one under Organization settings > API Keys. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: bearer_token

default: bearer_token

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

dataflows

\n
\n

[object]

\n

Dataflows for the Elastic Cloud CCM interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of an Elastic Cloud CCM dataflow. \nAllowed enum values: elastic-cloud-cost-data

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Elastic Cloud CCM interface settings.

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

elastic_org_id [required]

\n
\n

string

\n

Your Elastic Cloud organization ID, found in your organization settings.

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

type [required]

\n
\n

enum

\n

Interface discriminator for the Elastic Cloud CCM interface. \nAllowed enum values: elastic-cloud-ccm

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

name [required]

\n
\n

string

\n

Human-readable name of the account.

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

permissions

\n
\n

object

\n

Read-only permission information for the account, derived from its restriction policy.

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

resource_id

\n
\n

string

\n

Restriction-policy resource identifier of this account.

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

user_can_edit

\n
\n

boolean

\n

Whether the requesting user may edit this account.

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

id [required]

\n
\n

string

\n

Server-generated unique identifier of the integration account.

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

type [required]

\n
\n

enum

\n

JSON:API resource type for an integration account. Always integration-account. \nAllowed enum values: integration-account

default: integration-account

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateElasticCloudIntegrationAccount": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "interface": { + "authentication": { + "password": "your-password", + "type": "basic", + "username": "datadog" + }, + "dataflows": [ + { + "enabled": true, + "id": "elastic-cloud-metrics", + "status": { + "health": "DATAFLOW_HEALTH_OK", + "message": "", + "updated_at": "2026-06-25T08:30:50Z" + } + } + ], + "settings": { + "cat_allocation_stats_enabled": false, + "detailed_index_stats_enabled": false, + "index_stats_enabled": false, + "pending_task_stats_enabled": false, + "pshard_graceful_to_enabled": false, + "pshard_stats_enabled": false, + "slm_stats_enabled": false, + "tags": [ + "env:prod" + ], + "url": "https://example.es.us-central1.gcp.cloud.es.io:9243" + }, + "type": "elastic-cloud" + }, + "name": "elastic-cloud-prod", + "permissions": { + "resource_id": "integration-account:twilio:953a0060-81ec-4221-aed4-d4733b59cd96", + "user_can_edit": true + } + }, + "id": "953a0060-81ec-4221-aed4-d4733b59cd96", + "type": "integration-account" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data envelope of an Elastic Cloud integration account, including server-assigned identity.

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

attributes [required]

\n
\n

object

\n

Attributes of an Elastic Cloud integration account.

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

interface [required]

\n
\n

 <oneOf>

\n

Elastic Cloud interface (source-type). Exactly one interface variant is set, selected by its type.

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

<type=elastic-cloud>

\n
\n

object

\n

Elastic Cloud monitoring interface (source-type) configuration.

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

authentication [required]

\n
\n

 <oneOf>

\n

Authentication methods supported by the Elastic Cloud interface. Exactly one is set, selected by its type.

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

<type=basic>

\n
\n

object

\n

Username & password authentication for Elastic Cloud.

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

password [required]

\n
\n

string

\n

Password used to authenticate against the deployment. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: basic

default: basic

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

username [required]

\n
\n

string

\n

Username used to authenticate against the deployment.

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

dataflows

\n
\n

[object]

\n

Dataflows for the Elastic Cloud monitoring interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of an Elastic Cloud dataflow. \nAllowed enum values: elastic-cloud-metrics

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Elastic Cloud interface settings.

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

cat_allocation_stats_enabled

\n
\n

boolean

\n

Enable to collect shard allocation metrics.

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

detailed_index_stats_enabled

\n
\n

boolean

\n

Enable to collect index-specific stats.

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

index_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics about the indices in your cluster.

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

pending_task_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics about pending tasks.

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

pshard_graceful_to_enabled

\n
\n

boolean

\n

Enable to collect all metrics even if primary shard metric collection times out.

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

pshard_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics over primary shards.

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

slm_stats_enabled

\n
\n

boolean

\n

Enable to collect snapshot lifecycle management metrics.

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

tags

\n
\n

[string]

\n

Custom tags for this deployment.

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

url [required]

\n
\n

string

\n

Deployment URL.

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

type [required]

\n
\n

enum

\n

Interface discriminator for the Elastic Cloud monitoring interface. \nAllowed enum values: elastic-cloud

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

<type=elastic-cloud-ccm>

\n
\n

object

\n

Elastic Cloud CCM (Cloud Cost Management) interface configuration.

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

authentication [required]

\n
\n

 <oneOf>

\n

Authentication methods supported by the Elastic Cloud CCM interface. Exactly one is set, selected by its type.

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

<type=bearer_token>

\n
\n

object

\n

Encrypted token (bearer token) authentication for Elastic Cloud CCM.

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

api_key [required]

\n
\n

string

\n

Billing API key. An Elastic Cloud API key with read access to both Billing and Deployments. Create one under Organization settings > API Keys. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: bearer_token

default: bearer_token

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

dataflows

\n
\n

[object]

\n

Dataflows for the Elastic Cloud CCM interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of an Elastic Cloud CCM dataflow. \nAllowed enum values: elastic-cloud-cost-data

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Elastic Cloud CCM interface settings.

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

elastic_org_id [required]

\n
\n

string

\n

Your Elastic Cloud organization ID, found in your organization settings.

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

type [required]

\n
\n

enum

\n

Interface discriminator for the Elastic Cloud CCM interface. \nAllowed enum values: elastic-cloud-ccm

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

name [required]

\n
\n

string

\n

Human-readable name of the account.

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

permissions

\n
\n

object

\n

Read-only permission information for the account, derived from its restriction policy.

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

resource_id

\n
\n

string

\n

Restriction-policy resource identifier of this account.

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

user_can_edit

\n
\n

boolean

\n

Whether the requesting user may edit this account.

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

id [required]

\n
\n

string

\n

Server-generated unique identifier of the integration account.

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

type [required]

\n
\n

enum

\n

JSON:API resource type for an integration account. Always integration-account. \nAllowed enum values: integration-account

default: integration-account

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "interface": { + "dataflows": [ + { + "id": "elastic-cloud-metrics" + } + ] + } + }, + "type": "integration-account" + } + }, + "json": { + "data": { + "attributes": { + "interface": { + "authentication": { + "password": "your-password", + "type": "basic", + "username": "datadog" + }, + "dataflows": [ + { + "enabled": true, + "id": "elastic-cloud-metrics" + } + ], + "settings": { + "cat_allocation_stats_enabled": false, + "detailed_index_stats_enabled": false, + "index_stats_enabled": false, + "pending_task_stats_enabled": false, + "pshard_graceful_to_enabled": false, + "pshard_stats_enabled": false, + "slm_stats_enabled": false, + "tags": [ + "env:prod" + ], + "url": "https://example.es.us-central1.gcp.cloud.es.io:9243" + }, + "type": "elastic-cloud" + }, + "name": "elastic-cloud-prod" + }, + "type": "integration-account" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data envelope for updating an Elastic Cloud integration account.

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

attributes [required]

\n
\n

object

\n

Updatable attributes of an Elastic Cloud integration account. Every field is optional; only the fields provided are changed.

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

interface

\n
\n

 <oneOf>

\n

Partial Elastic Cloud interface for updates. Exactly one interface variant is set, selected by its type.

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

<type=elastic-cloud>

\n
\n

object

\n

Partial Elastic Cloud monitoring interface for updates.

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

authentication

\n
\n

 <oneOf>

\n

Authentication methods supported by the Elastic Cloud interface. Exactly one is set, selected by its type.

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

<type=basic>

\n
\n

object

\n

Username & password authentication for Elastic Cloud.

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

password [required]

\n
\n

string

\n

Password used to authenticate against the deployment. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: basic

default: basic

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

username [required]

\n
\n

string

\n

Username used to authenticate against the deployment.

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

dataflows

\n
\n

[object]

\n

Dataflows for the Elastic Cloud monitoring interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of an Elastic Cloud dataflow. \nAllowed enum values: elastic-cloud-metrics

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Partial Elastic Cloud interface settings for updates.

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

cat_allocation_stats_enabled

\n
\n

boolean

\n

Enable to collect shard allocation metrics.

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

detailed_index_stats_enabled

\n
\n

boolean

\n

Enable to collect index-specific stats.

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

index_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics about the indices in your cluster.

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

pending_task_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics about pending tasks.

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

pshard_graceful_to_enabled

\n
\n

boolean

\n

Enable to collect all metrics even if primary shard metric collection times out.

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

pshard_stats_enabled

\n
\n

boolean

\n

Enable to collect metrics over primary shards.

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

slm_stats_enabled

\n
\n

boolean

\n

Enable to collect snapshot lifecycle management metrics.

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

tags

\n
\n

[string]

\n

Custom tags for this deployment.

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

url

\n
\n

string

\n

Deployment URL.

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

type [required]

\n
\n

enum

\n

Interface discriminator for the Elastic Cloud monitoring interface. \nAllowed enum values: elastic-cloud

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

<type=elastic-cloud-ccm>

\n
\n

object

\n

Partial Elastic Cloud CCM interface for updates.

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

authentication

\n
\n

 <oneOf>

\n

Authentication methods supported by the Elastic Cloud CCM interface. Exactly one is set, selected by its type.

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

<type=bearer_token>

\n
\n

object

\n

Encrypted token (bearer token) authentication for Elastic Cloud CCM.

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

api_key [required]

\n
\n

string

\n

Billing API key. An Elastic Cloud API key with read access to both Billing and Deployments. Create one under Organization settings > API Keys. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: bearer_token

default: bearer_token

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

dataflows

\n
\n

[object]

\n

Dataflows for the Elastic Cloud CCM interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of an Elastic Cloud CCM dataflow. \nAllowed enum values: elastic-cloud-cost-data

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Partial Elastic Cloud CCM interface settings for updates.

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

elastic_org_id

\n
\n

string

\n

Your Elastic Cloud organization ID, found in your organization settings.

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

type [required]

\n
\n

enum

\n

Interface discriminator for the Elastic Cloud CCM interface. \nAllowed enum values: elastic-cloud-ccm

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

name

\n
\n

string

\n

Human-readable name of the account.

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

type [required]

\n
\n

enum

\n

JSON:API resource type for an integration account. Always integration-account. \nAllowed enum values: integration-account

default: integration-account

\n
\n \n
\n
\n
\n
" + } + } +} \ No newline at end of file diff --git a/content/en/api/v2/twilio-integration-accounts/_index.md b/content/en/api/v2/twilio-integration-accounts/_index.md new file mode 100644 index 00000000000..cab60212806 --- /dev/null +++ b/content/en/api/v2/twilio-integration-accounts/_index.md @@ -0,0 +1,4 @@ +--- +title: Twilio Integration Accounts +headless: true +--- diff --git a/content/en/api/v2/twilio-integration-accounts/examples.json b/content/en/api/v2/twilio-integration-accounts/examples.json new file mode 100644 index 00000000000..55b224e2a0b --- /dev/null +++ b/content/en/api/v2/twilio-integration-accounts/examples.json @@ -0,0 +1,448 @@ +{ + "ListTwilioIntegrationAccounts": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "interface": { + "authentication": { + "api_key": "SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "api_key_token": "your-api-key-secret", + "type": "basic" + }, + "dataflows": [ + { + "enabled": true, + "id": "twilio-messages-logs", + "status": { + "health": "DATAFLOW_HEALTH_OK", + "message": "", + "updated_at": "2026-06-25T08:30:50Z" + } + } + ], + "settings": { + "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "censor_logs": true + }, + "type": "twilio" + }, + "name": "twilio-prod", + "permissions": { + "resource_id": "integration-account:twilio:953a0060-81ec-4221-aed4-d4733b59cd96", + "user_can_edit": true + } + }, + "id": "953a0060-81ec-4221-aed4-d4733b59cd96", + "type": "integration-account" + } + ] + }, + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of Twilio integration accounts.

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

attributes [required]

\n
\n

object

\n

Attributes of a Twilio integration account.

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

interface [required]

\n
\n

object

\n

Twilio interface (source-type) configuration.

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

authentication [required]

\n
\n

 <oneOf>

\n

Authentication methods supported by the Twilio interface. Exactly one is set, selected by its type.

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

<type=basic>

\n
\n

object

\n

API Key & Secret authentication for Twilio.

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

api_key [required]

\n
\n

string

\n

Twilio API Key SID for authentication. Create from Twilio Console > Account > API Keys & Tokens.

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

api_key_token [required]

\n
\n

string

\n

Twilio API Key Secret (token) corresponding to the API Key SID. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: basic

default: basic

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

dataflows

\n
\n

[object]

\n

Dataflows for the Twilio interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of a Twilio dataflow. \nAllowed enum values: twilio-cloud-cost-metrics,twilio-events-logs,twilio-messages-logs,twilio-alerts-logs,twilio-call-summaries-logs

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Twilio interface settings.

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

account_sid [required]

\n
\n

string

\n

Twilio Account SID that uniquely identifies your Twilio account.

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

censor_logs

\n
\n

boolean

\n

When enabled, phone numbers in the to field and SMS message bodies are censored for privacy.

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

type [required]

\n
\n

enum

\n

Interface discriminator for Twilio. \nAllowed enum values: twilio

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

name [required]

\n
\n

string

\n

Human-readable name of the account.

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

permissions

\n
\n

object

\n

Read-only permission information for the account, derived from its restriction policy.

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

resource_id

\n
\n

string

\n

Restriction-policy resource identifier of this account.

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

user_can_edit

\n
\n

boolean

\n

Whether the requesting user may edit this account.

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

id [required]

\n
\n

string

\n

Server-generated unique identifier of the integration account.

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

type [required]

\n
\n

enum

\n

JSON:API resource type for an integration account. Always integration-account. \nAllowed enum values: integration-account

default: integration-account

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateTwilioIntegrationAccount": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "interface": { + "authentication": { + "api_key": "SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "api_key_token": "your-api-key-secret", + "type": "basic" + }, + "dataflows": [ + { + "enabled": true, + "id": "twilio-messages-logs", + "status": { + "health": "DATAFLOW_HEALTH_OK", + "message": "", + "updated_at": "2026-06-25T08:30:50Z" + } + } + ], + "settings": { + "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "censor_logs": true + }, + "type": "twilio" + }, + "name": "twilio-prod", + "permissions": { + "resource_id": "integration-account:twilio:953a0060-81ec-4221-aed4-d4733b59cd96", + "user_can_edit": true + } + }, + "id": "953a0060-81ec-4221-aed4-d4733b59cd96", + "type": "integration-account" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data envelope of a Twilio integration account, including server-assigned identity.

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

attributes [required]

\n
\n

object

\n

Attributes of a Twilio integration account.

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

interface [required]

\n
\n

object

\n

Twilio interface (source-type) configuration.

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

authentication [required]

\n
\n

 <oneOf>

\n

Authentication methods supported by the Twilio interface. Exactly one is set, selected by its type.

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

<type=basic>

\n
\n

object

\n

API Key & Secret authentication for Twilio.

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

api_key [required]

\n
\n

string

\n

Twilio API Key SID for authentication. Create from Twilio Console > Account > API Keys & Tokens.

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

api_key_token [required]

\n
\n

string

\n

Twilio API Key Secret (token) corresponding to the API Key SID. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: basic

default: basic

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

dataflows

\n
\n

[object]

\n

Dataflows for the Twilio interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of a Twilio dataflow. \nAllowed enum values: twilio-cloud-cost-metrics,twilio-events-logs,twilio-messages-logs,twilio-alerts-logs,twilio-call-summaries-logs

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Twilio interface settings.

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

account_sid [required]

\n
\n

string

\n

Twilio Account SID that uniquely identifies your Twilio account.

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

censor_logs

\n
\n

boolean

\n

When enabled, phone numbers in the to field and SMS message bodies are censored for privacy.

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

type [required]

\n
\n

enum

\n

Interface discriminator for Twilio. \nAllowed enum values: twilio

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

name [required]

\n
\n

string

\n

Human-readable name of the account.

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

permissions

\n
\n

object

\n

Read-only permission information for the account, derived from its restriction policy.

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

resource_id

\n
\n

string

\n

Restriction-policy resource identifier of this account.

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

user_can_edit

\n
\n

boolean

\n

Whether the requesting user may edit this account.

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

id [required]

\n
\n

string

\n

Server-generated unique identifier of the integration account.

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

type [required]

\n
\n

enum

\n

JSON:API resource type for an integration account. Always integration-account. \nAllowed enum values: integration-account

default: integration-account

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "interface": { + "authentication": {}, + "dataflows": [ + { + "id": "twilio-messages-logs" + } + ], + "settings": { + "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + }, + "type": "twilio" + }, + "name": "twilio-prod" + }, + "type": "integration-account" + } + }, + "json": { + "data": { + "attributes": { + "interface": { + "authentication": { + "api_key": "SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "api_key_token": "your-api-key-secret", + "type": "basic" + }, + "dataflows": [ + { + "enabled": true, + "id": "twilio-messages-logs" + } + ], + "settings": { + "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "censor_logs": true + }, + "type": "twilio" + }, + "name": "twilio-prod" + }, + "type": "integration-account" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data envelope for creating a Twilio integration account.

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

attributes [required]

\n
\n

object

\n

Attributes of a Twilio integration account.

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

interface [required]

\n
\n

object

\n

Twilio interface (source-type) configuration.

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

authentication [required]

\n
\n

 <oneOf>

\n

Authentication methods supported by the Twilio interface. Exactly one is set, selected by its type.

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

<type=basic>

\n
\n

object

\n

API Key & Secret authentication for Twilio.

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

api_key [required]

\n
\n

string

\n

Twilio API Key SID for authentication. Create from Twilio Console > Account > API Keys & Tokens.

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

api_key_token [required]

\n
\n

string

\n

Twilio API Key Secret (token) corresponding to the API Key SID. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: basic

default: basic

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

dataflows

\n
\n

[object]

\n

Dataflows for the Twilio interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of a Twilio dataflow. \nAllowed enum values: twilio-cloud-cost-metrics,twilio-events-logs,twilio-messages-logs,twilio-alerts-logs,twilio-call-summaries-logs

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Twilio interface settings.

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

account_sid [required]

\n
\n

string

\n

Twilio Account SID that uniquely identifies your Twilio account.

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

censor_logs

\n
\n

boolean

\n

When enabled, phone numbers in the to field and SMS message bodies are censored for privacy.

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

type [required]

\n
\n

enum

\n

Interface discriminator for Twilio. \nAllowed enum values: twilio

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

name [required]

\n
\n

string

\n

Human-readable name of the account.

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

permissions

\n
\n

object

\n

Read-only permission information for the account, derived from its restriction policy.

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

resource_id

\n
\n

string

\n

Restriction-policy resource identifier of this account.

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

user_can_edit

\n
\n

boolean

\n

Whether the requesting user may edit this account.

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

type [required]

\n
\n

enum

\n

JSON:API resource type for an integration account. Always integration-account. \nAllowed enum values: integration-account

default: integration-account

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetTwilioIntegrationAccount": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "interface": { + "authentication": { + "api_key": "SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "api_key_token": "your-api-key-secret", + "type": "basic" + }, + "dataflows": [ + { + "enabled": true, + "id": "twilio-messages-logs", + "status": { + "health": "DATAFLOW_HEALTH_OK", + "message": "", + "updated_at": "2026-06-25T08:30:50Z" + } + } + ], + "settings": { + "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "censor_logs": true + }, + "type": "twilio" + }, + "name": "twilio-prod", + "permissions": { + "resource_id": "integration-account:twilio:953a0060-81ec-4221-aed4-d4733b59cd96", + "user_can_edit": true + } + }, + "id": "953a0060-81ec-4221-aed4-d4733b59cd96", + "type": "integration-account" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data envelope of a Twilio integration account, including server-assigned identity.

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

attributes [required]

\n
\n

object

\n

Attributes of a Twilio integration account.

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

interface [required]

\n
\n

object

\n

Twilio interface (source-type) configuration.

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

authentication [required]

\n
\n

 <oneOf>

\n

Authentication methods supported by the Twilio interface. Exactly one is set, selected by its type.

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

<type=basic>

\n
\n

object

\n

API Key & Secret authentication for Twilio.

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

api_key [required]

\n
\n

string

\n

Twilio API Key SID for authentication. Create from Twilio Console > Account > API Keys & Tokens.

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

api_key_token [required]

\n
\n

string

\n

Twilio API Key Secret (token) corresponding to the API Key SID. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: basic

default: basic

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

dataflows

\n
\n

[object]

\n

Dataflows for the Twilio interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of a Twilio dataflow. \nAllowed enum values: twilio-cloud-cost-metrics,twilio-events-logs,twilio-messages-logs,twilio-alerts-logs,twilio-call-summaries-logs

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Twilio interface settings.

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

account_sid [required]

\n
\n

string

\n

Twilio Account SID that uniquely identifies your Twilio account.

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

censor_logs

\n
\n

boolean

\n

When enabled, phone numbers in the to field and SMS message bodies are censored for privacy.

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

type [required]

\n
\n

enum

\n

Interface discriminator for Twilio. \nAllowed enum values: twilio

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

name [required]

\n
\n

string

\n

Human-readable name of the account.

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

permissions

\n
\n

object

\n

Read-only permission information for the account, derived from its restriction policy.

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

resource_id

\n
\n

string

\n

Restriction-policy resource identifier of this account.

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

user_can_edit

\n
\n

boolean

\n

Whether the requesting user may edit this account.

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

id [required]

\n
\n

string

\n

Server-generated unique identifier of the integration account.

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

type [required]

\n
\n

enum

\n

JSON:API resource type for an integration account. Always integration-account. \nAllowed enum values: integration-account

default: integration-account

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateTwilioIntegrationAccount": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "interface": { + "authentication": { + "api_key": "SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "api_key_token": "your-api-key-secret", + "type": "basic" + }, + "dataflows": [ + { + "enabled": true, + "id": "twilio-messages-logs", + "status": { + "health": "DATAFLOW_HEALTH_OK", + "message": "", + "updated_at": "2026-06-25T08:30:50Z" + } + } + ], + "settings": { + "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "censor_logs": true + }, + "type": "twilio" + }, + "name": "twilio-prod", + "permissions": { + "resource_id": "integration-account:twilio:953a0060-81ec-4221-aed4-d4733b59cd96", + "user_can_edit": true + } + }, + "id": "953a0060-81ec-4221-aed4-d4733b59cd96", + "type": "integration-account" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data envelope of a Twilio integration account, including server-assigned identity.

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

attributes [required]

\n
\n

object

\n

Attributes of a Twilio integration account.

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

interface [required]

\n
\n

object

\n

Twilio interface (source-type) configuration.

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

authentication [required]

\n
\n

 <oneOf>

\n

Authentication methods supported by the Twilio interface. Exactly one is set, selected by its type.

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

<type=basic>

\n
\n

object

\n

API Key & Secret authentication for Twilio.

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

api_key [required]

\n
\n

string

\n

Twilio API Key SID for authentication. Create from Twilio Console > Account > API Keys & Tokens.

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

api_key_token [required]

\n
\n

string

\n

Twilio API Key Secret (token) corresponding to the API Key SID. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: basic

default: basic

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

dataflows

\n
\n

[object]

\n

Dataflows for the Twilio interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of a Twilio dataflow. \nAllowed enum values: twilio-cloud-cost-metrics,twilio-events-logs,twilio-messages-logs,twilio-alerts-logs,twilio-call-summaries-logs

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Twilio interface settings.

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

account_sid [required]

\n
\n

string

\n

Twilio Account SID that uniquely identifies your Twilio account.

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

censor_logs

\n
\n

boolean

\n

When enabled, phone numbers in the to field and SMS message bodies are censored for privacy.

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

type [required]

\n
\n

enum

\n

Interface discriminator for Twilio. \nAllowed enum values: twilio

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

name [required]

\n
\n

string

\n

Human-readable name of the account.

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

permissions

\n
\n

object

\n

Read-only permission information for the account, derived from its restriction policy.

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

resource_id

\n
\n

string

\n

Restriction-policy resource identifier of this account.

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

user_can_edit

\n
\n

boolean

\n

Whether the requesting user may edit this account.

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

id [required]

\n
\n

string

\n

Server-generated unique identifier of the integration account.

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

type [required]

\n
\n

enum

\n

JSON:API resource type for an integration account. Always integration-account. \nAllowed enum values: integration-account

default: integration-account

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "interface": { + "dataflows": [ + { + "id": "twilio-messages-logs" + } + ], + "type": "twilio" + } + }, + "type": "integration-account" + } + }, + "json": { + "data": { + "attributes": { + "interface": { + "authentication": { + "api_key": "SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "api_key_token": "your-api-key-secret", + "type": "basic" + }, + "dataflows": [ + { + "enabled": true, + "id": "twilio-messages-logs" + } + ], + "settings": { + "account_sid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "censor_logs": true + }, + "type": "twilio" + }, + "name": "twilio-prod" + }, + "type": "integration-account" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data envelope for updating a Twilio integration account.

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

attributes [required]

\n
\n

object

\n

Updatable attributes of a Twilio integration account. Every field is optional; only the fields provided are changed.

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

interface

\n
\n

object

\n

Partial Twilio interface (source-type) configuration for updates.

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

authentication

\n
\n

 <oneOf>

\n

Authentication methods supported by the Twilio interface. Exactly one is set, selected by its type.

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

<type=basic>

\n
\n

object

\n

API Key & Secret authentication for Twilio.

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

api_key [required]

\n
\n

string

\n

Twilio API Key SID for authentication. Create from Twilio Console > Account > API Keys & Tokens.

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

api_key_token [required]

\n
\n

string

\n

Twilio API Key Secret (token) corresponding to the API Key SID. This field is not returned by the API.

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

type [required]

\n
\n

enum

\n

Authentication method discriminator. \nAllowed enum values: basic

default: basic

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

dataflows

\n
\n

[object]

\n

Dataflows for the Twilio interface.

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

enabled

\n
\n

boolean

\n

Whether the dataflow is enabled.

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

id [required]

\n
\n

enum

\n

Identifier of a Twilio dataflow. \nAllowed enum values: twilio-cloud-cost-metrics,twilio-events-logs,twilio-messages-logs,twilio-alerts-logs,twilio-call-summaries-logs

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

status

\n
\n

object

\n

Read-only, server-computed collection status of a dataflow.

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

health

\n
\n

enum

\n

Collection health of a single dataflow. \nAllowed enum values: DATAFLOW_HEALTH_OK,DATAFLOW_HEALTH_BROKEN,DATAFLOW_HEALTH_UNKNOWN

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

message

\n
\n

string

\n

Human-readable detail, populated when the dataflow is not healthy.

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

updated_at

\n
\n

date-time

\n

Time the status was last computed.

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

settings

\n
\n

object

\n

Partial Twilio interface settings for updates.

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

account_sid

\n
\n

string

\n

Twilio Account SID that uniquely identifies your Twilio account.

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

censor_logs

\n
\n

boolean

\n

When enabled, phone numbers in the to field and SMS message bodies are censored for privacy.

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

type [required]

\n
\n

enum

\n

Interface discriminator for Twilio. \nAllowed enum values: twilio

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

name

\n
\n

string

\n

Human-readable name of the account.

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

type [required]

\n
\n

enum

\n

JSON:API resource type for an integration account. Always integration-account. \nAllowed enum values: integration-account

default: integration-account

\n
\n \n
\n
\n
\n
" + } + } +} \ No newline at end of file diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 7eb7a35a63a..0a02a0c9462 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -505,6 +505,13 @@ components: default: false example: false type: boolean + ElasticCloudInterfaceIdParameter: + description: "Selects the Elastic Cloud interface (source-type). Supported values: `elastic-cloud`, `elastic-cloud-ccm`." + in: path + name: interface_id + required: true + schema: + $ref: "#/components/schemas/ElasticCloudInterfaceId" EntityID: description: UUID or Entity Ref. in: path @@ -885,6 +892,13 @@ components: required: true schema: type: string + IntegrationAccountIdParameter: + description: Unique identifier of the integration account. + in: path + name: account_id + required: true + schema: + type: string IssueIDPathParameter: description: The identifier of the issue. example: "c1726a66-1f64-11ee-b338-da7ad0900002" @@ -1963,6 +1977,13 @@ components: required: true schema: type: string + TwilioInterfaceIdParameter: + description: "Selects the Twilio interface (source-type). Supported values: `twilio`." + in: path + name: interface_id + required: true + schema: + $ref: "#/components/schemas/TwilioInterfaceType" UserAuthorizedClientId: description: The ID of the user authorized client. in: path @@ -33839,6 +33860,422 @@ components: - score - severity type: object + ElasticCloudAuthentication: + description: >- + Authentication methods supported by the Elastic Cloud interface. Exactly one is set, selected by its `type`. + oneOf: + - $ref: "#/components/schemas/ElasticCloudBasicAuth" + ElasticCloudBasicAuth: + description: Username & password authentication for Elastic Cloud. + properties: + password: + description: Password used to authenticate against the deployment. This field is not returned by the API. + example: your-password + type: string + writeOnly: true + type: + $ref: "#/components/schemas/ElasticCloudBasicAuthType" + username: + description: Username used to authenticate against the deployment. + example: datadog + type: string + required: + - type + - username + - password + type: object + ElasticCloudBasicAuthType: + default: basic + description: Authentication method discriminator. + enum: + - basic + example: basic + type: string + x-enum-varnames: + - BASIC + ElasticCloudCcmAuthentication: + description: >- + Authentication methods supported by the Elastic Cloud CCM interface. Exactly one is set, selected by its `type`. + oneOf: + - $ref: "#/components/schemas/ElasticCloudCcmTokenAuth" + ElasticCloudCcmDataflow: + description: An Elastic Cloud CCM dataflow toggle. The set of dataflow ids is fixed by the interface schema. + properties: + enabled: + description: Whether the dataflow is enabled. + example: true + type: boolean + id: + $ref: "#/components/schemas/ElasticCloudCcmDataflowId" + status: + $ref: "#/components/schemas/IntegrationAccountDataflowStatus" + required: + - id + type: object + ElasticCloudCcmDataflowId: + description: Identifier of an Elastic Cloud CCM dataflow. + enum: + - elastic-cloud-cost-data + example: elastic-cloud-cost-data + type: string + x-enum-varnames: + - COST_DATA + ElasticCloudCcmInterface: + description: Elastic Cloud CCM (Cloud Cost Management) interface configuration. + properties: + authentication: + $ref: "#/components/schemas/ElasticCloudCcmAuthentication" + dataflows: + description: Dataflows for the Elastic Cloud CCM interface. + items: + $ref: "#/components/schemas/ElasticCloudCcmDataflow" + type: array + settings: + $ref: "#/components/schemas/ElasticCloudCcmSettings" + type: + $ref: "#/components/schemas/ElasticCloudCcmInterfaceType" + required: + - type + - authentication + type: object + ElasticCloudCcmInterfaceType: + description: Interface discriminator for the Elastic Cloud CCM interface. + enum: + - elastic-cloud-ccm + example: elastic-cloud-ccm + type: string + x-enum-varnames: + - ELASTIC_CLOUD_CCM + ElasticCloudCcmInterfaceUpdate: + description: Partial Elastic Cloud CCM interface for updates. + properties: + authentication: + $ref: "#/components/schemas/ElasticCloudCcmAuthentication" + dataflows: + description: Dataflows for the Elastic Cloud CCM interface. + items: + $ref: "#/components/schemas/ElasticCloudCcmDataflow" + type: array + settings: + $ref: "#/components/schemas/ElasticCloudCcmSettingsUpdate" + type: + $ref: "#/components/schemas/ElasticCloudCcmInterfaceType" + required: + - type + type: object + ElasticCloudCcmSettings: + description: Elastic Cloud CCM interface settings. + properties: + elastic_org_id: + description: Your Elastic Cloud organization ID, found in your organization settings. + example: "2079364244" + type: string + required: + - elastic_org_id + type: object + ElasticCloudCcmSettingsUpdate: + description: Partial Elastic Cloud CCM interface settings for updates. + properties: + elastic_org_id: + description: Your Elastic Cloud organization ID, found in your organization settings. + example: "2079364244" + type: string + type: object + ElasticCloudCcmTokenAuth: + description: Encrypted token (bearer token) authentication for Elastic Cloud CCM. + properties: + api_key: + description: >- + Billing API key. An Elastic Cloud API key with read access to both Billing and Deployments. Create one under Organization settings > API Keys. This field is not returned by the API. + example: your-billing-api-key + type: string + writeOnly: true + type: + $ref: "#/components/schemas/ElasticCloudCcmTokenAuthType" + required: + - type + - api_key + type: object + ElasticCloudCcmTokenAuthType: + default: bearer_token + description: Authentication method discriminator. + enum: + - bearer_token + example: bearer_token + type: string + x-enum-varnames: + - BEARER_TOKEN + ElasticCloudDataflow: + description: An Elastic Cloud dataflow toggle. The set of dataflow ids is fixed by the interface schema. + properties: + enabled: + description: Whether the dataflow is enabled. + example: true + type: boolean + id: + $ref: "#/components/schemas/ElasticCloudDataflowId" + status: + $ref: "#/components/schemas/IntegrationAccountDataflowStatus" + required: + - id + type: object + ElasticCloudDataflowId: + description: Identifier of an Elastic Cloud dataflow. + enum: + - elastic-cloud-metrics + example: elastic-cloud-metrics + type: string + x-enum-varnames: + - METRICS + ElasticCloudIntegrationAccountAttributes: + description: Attributes of an Elastic Cloud integration account. + properties: + interface: + $ref: "#/components/schemas/ElasticCloudInterface" + name: + description: Human-readable name of the account. + example: elastic-cloud-prod + type: string + permissions: + $ref: "#/components/schemas/IntegrationAccountPermissions" + required: + - name + - interface + type: object + ElasticCloudIntegrationAccountCreateData: + description: Data envelope for creating an Elastic Cloud integration account. + properties: + attributes: + $ref: "#/components/schemas/ElasticCloudIntegrationAccountAttributes" + type: + $ref: "#/components/schemas/IntegrationAccountType" + required: + - type + - attributes + type: object + ElasticCloudIntegrationAccountData: + description: Data envelope of an Elastic Cloud integration account, including server-assigned identity. + properties: + attributes: + $ref: "#/components/schemas/ElasticCloudIntegrationAccountAttributes" + id: + description: Server-generated unique identifier of the integration account. + example: 953a0060-81ec-4221-aed4-d4733b59cd96 + readOnly: true + type: string + type: + $ref: "#/components/schemas/IntegrationAccountType" + required: + - id + - type + - attributes + type: object + ElasticCloudIntegrationAccountRequest: + description: Request payload to create an Elastic Cloud integration account. + properties: + data: + $ref: "#/components/schemas/ElasticCloudIntegrationAccountCreateData" + required: + - data + type: object + ElasticCloudIntegrationAccountResponse: + description: Response payload for a single Elastic Cloud integration account. + properties: + data: + $ref: "#/components/schemas/ElasticCloudIntegrationAccountData" + type: object + ElasticCloudIntegrationAccountUpdateAttributes: + description: >- + Updatable attributes of an Elastic Cloud integration account. Every field is optional; only the fields provided are changed. + properties: + interface: + $ref: "#/components/schemas/ElasticCloudInterfaceUpdate" + name: + description: Human-readable name of the account. + example: elastic-cloud-prod + type: string + type: object + ElasticCloudIntegrationAccountUpdateData: + description: Data envelope for updating an Elastic Cloud integration account. + properties: + attributes: + $ref: "#/components/schemas/ElasticCloudIntegrationAccountUpdateAttributes" + type: + $ref: "#/components/schemas/IntegrationAccountType" + required: + - type + - attributes + type: object + ElasticCloudIntegrationAccountUpdateRequest: + description: Request payload to update an Elastic Cloud integration account as a partial merge. + properties: + data: + $ref: "#/components/schemas/ElasticCloudIntegrationAccountUpdateData" + required: + - data + type: object + ElasticCloudIntegrationAccountsResponse: + description: Response payload for a list of Elastic Cloud integration accounts. + properties: + data: + description: List of Elastic Cloud integration accounts. + items: + $ref: "#/components/schemas/ElasticCloudIntegrationAccountData" + type: array + type: object + ElasticCloudInterface: + description: >- + Elastic Cloud interface (source-type). Exactly one interface variant is set, selected by its `type`. + oneOf: + - $ref: "#/components/schemas/ElasticCloudMonitoringInterface" + - $ref: "#/components/schemas/ElasticCloudCcmInterface" + ElasticCloudInterfaceId: + description: Supported Elastic Cloud interface (source-type) ids. + enum: + - elastic-cloud + - elastic-cloud-ccm + example: elastic-cloud + type: string + x-enum-varnames: + - ELASTIC_CLOUD + - ELASTIC_CLOUD_CCM + ElasticCloudInterfaceUpdate: + description: >- + Partial Elastic Cloud interface for updates. Exactly one interface variant is set, selected by its `type`. + oneOf: + - $ref: "#/components/schemas/ElasticCloudMonitoringInterfaceUpdate" + - $ref: "#/components/schemas/ElasticCloudCcmInterfaceUpdate" + ElasticCloudMonitoringInterface: + description: Elastic Cloud monitoring interface (source-type) configuration. + properties: + authentication: + $ref: "#/components/schemas/ElasticCloudAuthentication" + dataflows: + description: Dataflows for the Elastic Cloud monitoring interface. + items: + $ref: "#/components/schemas/ElasticCloudDataflow" + type: array + settings: + $ref: "#/components/schemas/ElasticCloudSettings" + type: + $ref: "#/components/schemas/ElasticCloudMonitoringInterfaceType" + required: + - type + - authentication + type: object + ElasticCloudMonitoringInterfaceType: + description: Interface discriminator for the Elastic Cloud monitoring interface. + enum: + - elastic-cloud + example: elastic-cloud + type: string + x-enum-varnames: + - ELASTIC_CLOUD + ElasticCloudMonitoringInterfaceUpdate: + description: Partial Elastic Cloud monitoring interface for updates. + properties: + authentication: + $ref: "#/components/schemas/ElasticCloudAuthentication" + dataflows: + description: Dataflows for the Elastic Cloud monitoring interface. + items: + $ref: "#/components/schemas/ElasticCloudDataflow" + type: array + settings: + $ref: "#/components/schemas/ElasticCloudSettingsUpdate" + type: + $ref: "#/components/schemas/ElasticCloudMonitoringInterfaceType" + required: + - type + type: object + ElasticCloudSettings: + description: Elastic Cloud interface settings. + properties: + cat_allocation_stats_enabled: + description: Enable to collect shard allocation metrics. + example: false + type: boolean + detailed_index_stats_enabled: + description: Enable to collect index-specific stats. + example: false + type: boolean + index_stats_enabled: + description: Enable to collect metrics about the indices in your cluster. + example: false + type: boolean + pending_task_stats_enabled: + description: Enable to collect metrics about pending tasks. + example: false + type: boolean + pshard_graceful_to_enabled: + description: Enable to collect all metrics even if primary shard metric collection times out. + example: false + type: boolean + pshard_stats_enabled: + description: Enable to collect metrics over primary shards. + example: false + type: boolean + slm_stats_enabled: + description: Enable to collect snapshot lifecycle management metrics. + example: false + type: boolean + tags: + description: Custom tags for this deployment. + example: + - env:prod + items: + type: string + type: array + url: + description: Deployment URL. + example: "https://example.es.us-central1.gcp.cloud.es.io:9243" + type: string + required: + - url + type: object + ElasticCloudSettingsUpdate: + description: Partial Elastic Cloud interface settings for updates. + properties: + cat_allocation_stats_enabled: + description: Enable to collect shard allocation metrics. + example: false + type: boolean + detailed_index_stats_enabled: + description: Enable to collect index-specific stats. + example: false + type: boolean + index_stats_enabled: + description: Enable to collect metrics about the indices in your cluster. + example: false + type: boolean + pending_task_stats_enabled: + description: Enable to collect metrics about pending tasks. + example: false + type: boolean + pshard_graceful_to_enabled: + description: Enable to collect all metrics even if primary shard metric collection times out. + example: false + type: boolean + pshard_stats_enabled: + description: Enable to collect metrics over primary shards. + example: false + type: boolean + slm_stats_enabled: + description: Enable to collect snapshot lifecycle management metrics. + example: false + type: boolean + tags: + description: Custom tags for this deployment. + example: + - env:prod + items: + type: string + type: array + url: + description: Deployment URL. + example: "https://example.es.us-central1.gcp.cloud.es.io:9243" + type: string + type: object EmailTypeType: description: The type of email. enum: @@ -48914,6 +49351,58 @@ components: - id - attributes type: object + IntegrationAccountDataflowHealth: + description: Collection health of a single dataflow. + enum: + - DATAFLOW_HEALTH_OK + - DATAFLOW_HEALTH_BROKEN + - DATAFLOW_HEALTH_UNKNOWN + example: DATAFLOW_HEALTH_OK + type: string + x-enum-varnames: + - OK + - BROKEN + - UNKNOWN + IntegrationAccountDataflowStatus: + description: Read-only, server-computed collection status of a dataflow. + properties: + health: + $ref: "#/components/schemas/IntegrationAccountDataflowHealth" + message: + description: Human-readable detail, populated when the dataflow is not healthy. + example: "" + type: string + updated_at: + description: Time the status was last computed. + example: "2026-06-25T08:30:50Z" + format: date-time + type: string + readOnly: true + type: object + IntegrationAccountPermissions: + description: Read-only permission information for the account, derived from its restriction policy. + properties: + resource_id: + description: Restriction-policy resource identifier of this account. + example: "integration-account:twilio:953a0060-81ec-4221-aed4-d4733b59cd96" + readOnly: true + type: string + user_can_edit: + description: Whether the requesting user may edit this account. + example: true + readOnly: true + type: boolean + readOnly: true + type: object + IntegrationAccountType: + default: integration-account + description: JSON:API resource type for an integration account. Always `integration-account`. + enum: + - integration-account + example: integration-account + type: string + x-enum-varnames: + - INTEGRATION_ACCOUNT IntegrationAttributes: description: Attributes for an integration. properties: @@ -111822,6 +112311,234 @@ components: type: string x-enum-varnames: - TRIGGER_WORKFLOW_AUTOMATION + TwilioAuthentication: + description: >- + Authentication methods supported by the Twilio interface. Exactly one is set, selected by its `type`. + oneOf: + - $ref: "#/components/schemas/TwilioBasicAuth" + TwilioBasicAuth: + description: API Key & Secret authentication for Twilio. + properties: + api_key: + description: Twilio API Key SID for authentication. Create from Twilio Console > Account > API Keys & Tokens. + example: SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + type: string + api_key_token: + description: Twilio API Key Secret (token) corresponding to the API Key SID. This field is not returned by the API. + example: your-api-key-secret + type: string + writeOnly: true + type: + $ref: "#/components/schemas/TwilioBasicAuthType" + required: + - type + - api_key + - api_key_token + type: object + TwilioBasicAuthType: + default: basic + description: Authentication method discriminator. + enum: + - basic + example: basic + type: string + x-enum-varnames: + - BASIC + TwilioDataflow: + description: A Twilio dataflow toggle. The set of dataflow ids is fixed by the interface schema. + properties: + enabled: + description: Whether the dataflow is enabled. + example: true + type: boolean + id: + $ref: "#/components/schemas/TwilioDataflowId" + status: + $ref: "#/components/schemas/IntegrationAccountDataflowStatus" + required: + - id + type: object + TwilioDataflowId: + description: Identifier of a Twilio dataflow. + enum: + - twilio-cloud-cost-metrics + - twilio-events-logs + - twilio-messages-logs + - twilio-alerts-logs + - twilio-call-summaries-logs + example: twilio-messages-logs + type: string + x-enum-varnames: + - CLOUD_COST_METRICS + - EVENTS_LOGS + - MESSAGES_LOGS + - ALERTS_LOGS + - CALL_SUMMARIES_LOGS + TwilioIntegrationAccountAttributes: + description: Attributes of a Twilio integration account. + properties: + interface: + $ref: "#/components/schemas/TwilioInterface" + name: + description: Human-readable name of the account. + example: twilio-prod + type: string + permissions: + $ref: "#/components/schemas/IntegrationAccountPermissions" + required: + - name + - interface + type: object + TwilioIntegrationAccountCreateData: + description: Data envelope for creating a Twilio integration account. + properties: + attributes: + $ref: "#/components/schemas/TwilioIntegrationAccountAttributes" + type: + $ref: "#/components/schemas/IntegrationAccountType" + required: + - type + - attributes + type: object + TwilioIntegrationAccountData: + description: Data envelope of a Twilio integration account, including server-assigned identity. + properties: + attributes: + $ref: "#/components/schemas/TwilioIntegrationAccountAttributes" + id: + description: Server-generated unique identifier of the integration account. + example: 953a0060-81ec-4221-aed4-d4733b59cd96 + readOnly: true + type: string + type: + $ref: "#/components/schemas/IntegrationAccountType" + required: + - id + - type + - attributes + type: object + TwilioIntegrationAccountRequest: + description: Request payload to create a Twilio integration account. + properties: + data: + $ref: "#/components/schemas/TwilioIntegrationAccountCreateData" + required: + - data + type: object + TwilioIntegrationAccountResponse: + description: Response payload for a single Twilio integration account. + properties: + data: + $ref: "#/components/schemas/TwilioIntegrationAccountData" + type: object + TwilioIntegrationAccountUpdateAttributes: + description: >- + Updatable attributes of a Twilio integration account. Every field is optional; only the fields provided are changed. + properties: + interface: + $ref: "#/components/schemas/TwilioInterfaceUpdate" + name: + description: Human-readable name of the account. + example: twilio-prod + type: string + type: object + TwilioIntegrationAccountUpdateData: + description: Data envelope for updating a Twilio integration account. + properties: + attributes: + $ref: "#/components/schemas/TwilioIntegrationAccountUpdateAttributes" + type: + $ref: "#/components/schemas/IntegrationAccountType" + required: + - type + - attributes + type: object + TwilioIntegrationAccountUpdateRequest: + description: Request payload to update a Twilio integration account as a partial merge. + properties: + data: + $ref: "#/components/schemas/TwilioIntegrationAccountUpdateData" + required: + - data + type: object + TwilioIntegrationAccountsResponse: + description: Response payload for a list of Twilio integration accounts. + properties: + data: + description: List of Twilio integration accounts. + items: + $ref: "#/components/schemas/TwilioIntegrationAccountData" + type: array + type: object + TwilioInterface: + description: Twilio interface (source-type) configuration. + properties: + authentication: + $ref: "#/components/schemas/TwilioAuthentication" + dataflows: + description: Dataflows for the Twilio interface. + items: + $ref: "#/components/schemas/TwilioDataflow" + type: array + settings: + $ref: "#/components/schemas/TwilioSettings" + type: + $ref: "#/components/schemas/TwilioInterfaceType" + required: + - type + - authentication + type: object + TwilioInterfaceType: + description: Interface discriminator for Twilio. + enum: + - twilio + example: twilio + type: string + x-enum-varnames: + - TWILIO + TwilioInterfaceUpdate: + description: Partial Twilio interface (source-type) configuration for updates. + properties: + authentication: + $ref: "#/components/schemas/TwilioAuthentication" + dataflows: + description: Dataflows for the Twilio interface. + items: + $ref: "#/components/schemas/TwilioDataflow" + type: array + settings: + $ref: "#/components/schemas/TwilioSettingsUpdate" + type: + $ref: "#/components/schemas/TwilioInterfaceType" + required: + - type + type: object + TwilioSettings: + description: Twilio interface settings. + properties: + account_sid: + description: Twilio Account SID that uniquely identifies your Twilio account. + example: ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + type: string + censor_logs: + description: When enabled, phone numbers in the `to` field and SMS message bodies are censored for privacy. + example: true + type: boolean + required: + - account_sid + type: object + TwilioSettingsUpdate: + description: Partial Twilio interface settings for updates. + properties: + account_sid: + description: Twilio Account SID that uniquely identifies your Twilio account. + example: ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + type: string + censor_logs: + description: When enabled, phone numbers in the `to` field and SMS message bodies are censored for privacy. + example: true + type: boolean + type: object UCConfigPair: description: The definition of `UCConfigPair` object. example: @@ -152748,6 +153465,261 @@ paths: operator: OR permissions: - manage_integrations + /api/v2/integrations/elastic-cloud/interfaces/{interface_id}/accounts: + get: + description: List the Elastic Cloud integration accounts for a given interface. + operationId: ListElasticCloudIntegrationAccounts + parameters: + - $ref: "#/components/parameters/ElasticCloudInterfaceIdParameter" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + interface: + authentication: + type: basic + username: datadog + dataflows: + - enabled: true + id: elastic-cloud-metrics + status: + health: DATAFLOW_HEALTH_OK + updated_at: "2026-06-25T08:30:50Z" + settings: + tags: + - env:prod + url: "https://example.es.us-central1.gcp.cloud.es.io:9243" + type: elastic-cloud + name: elastic-cloud-prod + permissions: + resource_id: "integration-account:elastic-cloud:953a0060-81ec-4221-aed4-d4733b59cd96" + user_can_edit: true + id: 953a0060-81ec-4221-aed4-d4733b59cd96 + type: integration-account + schema: + $ref: "#/components/schemas/ElasticCloudIntegrationAccountsResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: List Elastic Cloud integration accounts + tags: + - Elastic Cloud Integration Accounts + x-menu-order: 1 + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + post: + description: Create an Elastic Cloud integration account for a given interface. + operationId: CreateElasticCloudIntegrationAccount + parameters: + - $ref: "#/components/parameters/ElasticCloudInterfaceIdParameter" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ElasticCloudIntegrationAccountRequest" + required: true + responses: + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + interface: + authentication: + type: basic + username: datadog + dataflows: + - enabled: true + id: elastic-cloud-metrics + status: + health: DATAFLOW_HEALTH_OK + updated_at: "2026-06-25T08:30:50Z" + settings: + tags: + - env:prod + url: "https://example.es.us-central1.gcp.cloud.es.io:9243" + type: elastic-cloud + name: elastic-cloud-prod + permissions: + resource_id: "integration-account:elastic-cloud:953a0060-81ec-4221-aed4-d4733b59cd96" + user_can_edit: true + id: 953a0060-81ec-4221-aed4-d4733b59cd96 + type: integration-account + schema: + $ref: "#/components/schemas/ElasticCloudIntegrationAccountResponse" + description: Created + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Create an Elastic Cloud integration account + tags: + - Elastic Cloud Integration Accounts + x-codegen-request-body-name: body + x-menu-order: 2 + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/integrations/elastic-cloud/interfaces/{interface_id}/accounts/{account_id}: + delete: + description: Delete an Elastic Cloud integration account. + operationId: DeleteElasticCloudIntegrationAccount + parameters: + - $ref: "#/components/parameters/ElasticCloudInterfaceIdParameter" + - $ref: "#/components/parameters/IntegrationAccountIdParameter" + responses: + "204": + description: No Content + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Delete an Elastic Cloud integration account + tags: + - Elastic Cloud Integration Accounts + x-menu-order: 5 + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + get: + description: Get a single Elastic Cloud integration account. + operationId: GetElasticCloudIntegrationAccount + parameters: + - $ref: "#/components/parameters/ElasticCloudInterfaceIdParameter" + - $ref: "#/components/parameters/IntegrationAccountIdParameter" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + interface: + authentication: + type: basic + username: datadog + dataflows: + - enabled: true + id: elastic-cloud-metrics + status: + health: DATAFLOW_HEALTH_OK + updated_at: "2026-06-25T08:30:50Z" + settings: + tags: + - env:prod + url: "https://example.es.us-central1.gcp.cloud.es.io:9243" + type: elastic-cloud + name: elastic-cloud-prod + permissions: + resource_id: "integration-account:elastic-cloud:953a0060-81ec-4221-aed4-d4733b59cd96" + user_can_edit: true + id: 953a0060-81ec-4221-aed4-d4733b59cd96 + type: integration-account + schema: + $ref: "#/components/schemas/ElasticCloudIntegrationAccountResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Get an Elastic Cloud integration account + tags: + - Elastic Cloud Integration Accounts + x-menu-order: 3 + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + patch: + description: >- + Update an Elastic Cloud integration account. The update is a partial merge: only the fields provided are changed, so a name-only or settings-only update does not need to resend the full payload or write-only credentials. + operationId: UpdateElasticCloudIntegrationAccount + parameters: + - $ref: "#/components/parameters/ElasticCloudInterfaceIdParameter" + - $ref: "#/components/parameters/IntegrationAccountIdParameter" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ElasticCloudIntegrationAccountUpdateRequest" + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + interface: + authentication: + type: basic + username: datadog + dataflows: + - enabled: true + id: elastic-cloud-metrics + status: + health: DATAFLOW_HEALTH_OK + updated_at: "2026-06-25T08:30:50Z" + settings: + tags: + - env:prod + url: "https://example.es.us-central1.gcp.cloud.es.io:9243" + type: elastic-cloud + name: elastic-cloud-prod + permissions: + resource_id: "integration-account:elastic-cloud:953a0060-81ec-4221-aed4-d4733b59cd96" + user_can_edit: true + id: 953a0060-81ec-4221-aed4-d4733b59cd96 + type: integration-account + schema: + $ref: "#/components/schemas/ElasticCloudIntegrationAccountResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Update an Elastic Cloud integration account + tags: + - Elastic Cloud Integration Accounts + x-codegen-request-body-name: body + x-menu-order: 4 + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/integrations/fastly/accounts: get: description: List Fastly accounts. @@ -153386,6 +154358,257 @@ paths: operator: OR permissions: - manage_integrations + /api/v2/integrations/twilio/interfaces/{interface_id}/accounts: + get: + description: List the Twilio integration accounts for a given interface. + operationId: ListTwilioIntegrationAccounts + parameters: + - $ref: "#/components/parameters/TwilioInterfaceIdParameter" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + interface: + authentication: + api_key: SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + type: basic + dataflows: + - enabled: true + id: twilio-messages-logs + status: + health: DATAFLOW_HEALTH_OK + updated_at: "2026-06-25T08:30:50Z" + settings: + account_sid: ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + censor_logs: true + type: twilio + name: twilio-prod + permissions: + resource_id: "integration-account:twilio:953a0060-81ec-4221-aed4-d4733b59cd96" + user_can_edit: true + id: 953a0060-81ec-4221-aed4-d4733b59cd96 + type: integration-account + schema: + $ref: "#/components/schemas/TwilioIntegrationAccountsResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: List Twilio integration accounts + tags: + - Twilio Integration Accounts + x-menu-order: 1 + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + post: + description: Create a Twilio integration account for a given interface. + operationId: CreateTwilioIntegrationAccount + parameters: + - $ref: "#/components/parameters/TwilioInterfaceIdParameter" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/TwilioIntegrationAccountRequest" + required: true + responses: + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + interface: + authentication: + api_key: SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + type: basic + dataflows: + - enabled: true + id: twilio-messages-logs + status: + health: DATAFLOW_HEALTH_OK + updated_at: "2026-06-25T08:30:50Z" + settings: + account_sid: ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + censor_logs: true + type: twilio + name: twilio-prod + permissions: + resource_id: "integration-account:twilio:953a0060-81ec-4221-aed4-d4733b59cd96" + user_can_edit: true + id: 953a0060-81ec-4221-aed4-d4733b59cd96 + type: integration-account + schema: + $ref: "#/components/schemas/TwilioIntegrationAccountResponse" + description: Created + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Create a Twilio integration account + tags: + - Twilio Integration Accounts + x-codegen-request-body-name: body + x-menu-order: 2 + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/integrations/twilio/interfaces/{interface_id}/accounts/{account_id}: + delete: + description: Delete a Twilio integration account. + operationId: DeleteTwilioIntegrationAccount + parameters: + - $ref: "#/components/parameters/TwilioInterfaceIdParameter" + - $ref: "#/components/parameters/IntegrationAccountIdParameter" + responses: + "204": + description: No Content + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Delete a Twilio integration account + tags: + - Twilio Integration Accounts + x-menu-order: 5 + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + get: + description: Get a single Twilio integration account. + operationId: GetTwilioIntegrationAccount + parameters: + - $ref: "#/components/parameters/TwilioInterfaceIdParameter" + - $ref: "#/components/parameters/IntegrationAccountIdParameter" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + interface: + authentication: + api_key: SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + type: basic + dataflows: + - enabled: true + id: twilio-messages-logs + status: + health: DATAFLOW_HEALTH_OK + updated_at: "2026-06-25T08:30:50Z" + settings: + account_sid: ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + censor_logs: true + type: twilio + name: twilio-prod + permissions: + resource_id: "integration-account:twilio:953a0060-81ec-4221-aed4-d4733b59cd96" + user_can_edit: true + id: 953a0060-81ec-4221-aed4-d4733b59cd96 + type: integration-account + schema: + $ref: "#/components/schemas/TwilioIntegrationAccountResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Get a Twilio integration account + tags: + - Twilio Integration Accounts + x-menu-order: 3 + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + patch: + description: >- + Update a Twilio integration account. The update is a partial merge: only the fields provided are changed, so a name-only or settings-only update does not need to resend the full payload or write-only credentials. + operationId: UpdateTwilioIntegrationAccount + parameters: + - $ref: "#/components/parameters/TwilioInterfaceIdParameter" + - $ref: "#/components/parameters/IntegrationAccountIdParameter" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/TwilioIntegrationAccountUpdateRequest" + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + interface: + authentication: + api_key: SKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + type: basic + dataflows: + - enabled: true + id: twilio-messages-logs + status: + health: DATAFLOW_HEALTH_OK + updated_at: "2026-06-25T08:30:50Z" + settings: + account_sid: ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + censor_logs: true + type: twilio + name: twilio-prod + permissions: + resource_id: "integration-account:twilio:953a0060-81ec-4221-aed4-d4733b59cd96" + user_can_edit: true + id: 953a0060-81ec-4221-aed4-d4733b59cd96 + type: integration-account + schema: + $ref: "#/components/schemas/TwilioIntegrationAccountResponse" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "404": + $ref: "#/components/responses/NotFoundResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Update a Twilio integration account + tags: + - Twilio Integration Accounts + x-codegen-request-body-name: body + x-menu-order: 4 + x-unstable: |- + **Note**: This endpoint is in public beta. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/ip_allowlist: get: description: Returns the IP allowlist and its enabled or disabled state. @@ -209669,6 +210892,9 @@ tags: scopes from alerting. Downtime settings, which can be scheduled with start and end times, prevent all alerting related to specified Datadog tags. name: Downtimes + - description: >- + Manage Elastic Cloud accounts for the Elastic Cloud integration, served by the Account Management Service (AMS). The account payload is strongly typed to Elastic Cloud; the supported interfaces (monitoring and Cloud Cost Management) are modeled as a nested union. + name: Elastic Cloud Integration Accounts - description: Manage per-integration configurations for the Internal Developer Portal (IDP). These configurations control which external resources (for example, GitHub repositories, Jira projects, or PagerDuty services) are synced as entities into the Software Catalog. name: Entity Integration Configs - description: Retrieves security risk scores for entities in your organization. @@ -210101,6 +211327,9 @@ tags: - description: |- Search and manage flaky tests through Test Optimization. See the [Test Optimization page](https://docs.datadoghq.com/tests/) for more information. name: Test Optimization + - description: >- + Manage Twilio accounts for the Twilio integration, served by the Account Management Service (AMS). The account payload is strongly typed to Twilio; the Twilio interface and its authentication are modeled inline. + name: Twilio Integration Accounts - description: |- The usage metering API allows you to get hourly, daily, and monthly usage across multiple facets of Datadog. diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 48a15c63095..2d66319ec61 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -2925,6 +2925,30 @@ "request_description": "Confluent payload", "request_schema_description": "The JSON:API request for updating a Confluent resource." }, + "ListElasticCloudIntegrationAccounts": { + "description": "List the Elastic Cloud integration accounts for a given interface.", + "summary": "List Elastic Cloud integration accounts" + }, + "CreateElasticCloudIntegrationAccount": { + "description": "Create an Elastic Cloud integration account for a given interface.", + "summary": "Create an Elastic Cloud integration account", + "request_description": "", + "request_schema_description": "Request payload to create an Elastic Cloud integration account." + }, + "DeleteElasticCloudIntegrationAccount": { + "description": "Delete an Elastic Cloud integration account.", + "summary": "Delete an Elastic Cloud integration account" + }, + "GetElasticCloudIntegrationAccount": { + "description": "Get a single Elastic Cloud integration account.", + "summary": "Get an Elastic Cloud integration account" + }, + "UpdateElasticCloudIntegrationAccount": { + "description": "Update an Elastic Cloud integration account. The update is a partial merge: only the fields provided are changed, so a name-only or settings-only update does not need to resend the full payload or write-only credentials.", + "summary": "Update an Elastic Cloud integration account", + "request_description": "", + "request_schema_description": "Request payload to update an Elastic Cloud integration account as a partial merge." + }, "ListFastlyAccounts": { "description": "List Fastly accounts.", "summary": "List Fastly accounts" @@ -2997,6 +3021,30 @@ "request_description": "", "request_schema_description": "Payload schema when updating an Okta account." }, + "ListTwilioIntegrationAccounts": { + "description": "List the Twilio integration accounts for a given interface.", + "summary": "List Twilio integration accounts" + }, + "CreateTwilioIntegrationAccount": { + "description": "Create a Twilio integration account for a given interface.", + "summary": "Create a Twilio integration account", + "request_description": "", + "request_schema_description": "Request payload to create a Twilio integration account." + }, + "DeleteTwilioIntegrationAccount": { + "description": "Delete a Twilio integration account.", + "summary": "Delete a Twilio integration account" + }, + "GetTwilioIntegrationAccount": { + "description": "Get a single Twilio integration account.", + "summary": "Get a Twilio integration account" + }, + "UpdateTwilioIntegrationAccount": { + "description": "Update a Twilio integration account. The update is a partial merge: only the fields provided are changed, so a name-only or settings-only update does not need to resend the full payload or write-only credentials.", + "summary": "Update a Twilio integration account", + "request_description": "", + "request_schema_description": "Request payload to update a Twilio integration account as a partial merge." + }, "GetIPAllowlist": { "description": "Returns the IP allowlist and its enabled or disabled state.", "summary": "Get IP Allowlist" diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index 4dc2f0a2f35..fbafd7a635b 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -187,6 +187,10 @@ "name": "Downtimes", "description": "**Note**: Downtime V2 is currently in private beta. To request access, contact [Datadog support](https://docs.datadoghq.com/help/).\n\n[Downtiming](https://docs.datadoghq.com/monitors/notify/downtimes) gives\nyou greater control over monitor notifications by allowing you to globally exclude\nscopes from alerting. Downtime settings, which can be scheduled with start and\nend times, prevent all alerting related to specified Datadog tags." }, + "elastic-cloud-integration-accounts": { + "name": "Elastic Cloud Integration Accounts", + "description": "Manage Elastic Cloud accounts for the Elastic Cloud integration, served by the Account Management Service (AMS). The account payload is strongly typed to Elastic Cloud; the supported interfaces (monitoring and Cloud Cost Management) are modeled as a nested union." + }, "entity-integration-configs": { "name": "Entity Integration Configs", "description": "Manage per-integration configurations for the Internal Developer Portal (IDP). These configurations control which external resources (for example, GitHub repositories, Jira projects, or PagerDuty services) are synced as entities into the Software Catalog." @@ -535,6 +539,10 @@ "name": "Test Optimization", "description": "Search and manage flaky tests through Test Optimization. See the [Test Optimization page](https://docs.datadoghq.com/tests/) for more information." }, + "twilio-integration-accounts": { + "name": "Twilio Integration Accounts", + "description": "Manage Twilio accounts for the Twilio integration, served by the Account Management Service (AMS). The account payload is strongly typed to Twilio; the Twilio interface and its authentication are modeled inline." + }, "usage-metering": { "name": "Usage Metering", "description": "The usage metering API allows you to get hourly, daily, and\nmonthly usage across multiple facets of Datadog.\nThis API is available to all Pro and Enterprise customers.\n\n**Note**: Usage data is delayed by up to 72 hours from when it was incurred.\nIt is retained for 15 months.\n\nYou can retrieve up to 24 hours of hourly usage data for multiple organizations,\nand up to two months of hourly usage data for a single organization in one request.\nLearn more on the [usage details documentation](https://docs.datadoghq.com/account_management/billing/usage_details/)."