diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 3027e1b00f7..27bb741f155 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -7843,7 +7843,7 @@ menu: - TriggerFleetSchedule unstable: - v2 - order: 5 + order: 13 - name: Update a schedule url: '#update-a-schedule' identifier: fleet-automation-update-a-schedule @@ -7856,7 +7856,7 @@ menu: - UpdateFleetSchedule unstable: - v2 - order: 3 + order: 11 - name: Get a schedule by ID url: '#get-a-schedule-by-id' identifier: fleet-automation-get-a-schedule-by-id @@ -7869,7 +7869,7 @@ menu: - GetFleetSchedule unstable: - v2 - order: 2 + order: 10 - name: Delete a schedule url: '#delete-a-schedule' identifier: fleet-automation-delete-a-schedule @@ -7882,7 +7882,7 @@ menu: - DeleteFleetSchedule unstable: - v2 - order: 4 + order: 12 - name: Create a schedule url: '#create-a-schedule' identifier: fleet-automation-create-a-schedule @@ -7895,7 +7895,7 @@ menu: - CreateFleetSchedule unstable: - v2 - order: 1 + order: 9 - name: List all schedules url: '#list-all-schedules' identifier: fleet-automation-list-all-schedules @@ -7908,7 +7908,7 @@ menu: - ListFleetSchedules unstable: - v2 - order: 0 + order: 8 - name: Cancel a deployment url: '#cancel-a-deployment' identifier: fleet-automation-cancel-a-deployment @@ -7921,7 +7921,7 @@ menu: - CancelFleetDeployment unstable: - v2 - order: 4 + order: 7 - name: Get a configuration deployment by ID url: '#get-a-configuration-deployment-by-id' identifier: fleet-automation-get-a-configuration-deployment-by-id @@ -7934,7 +7934,7 @@ menu: - GetFleetDeployment unstable: - v2 - order: 3 + order: 6 - name: Upgrade hosts url: '#upgrade-hosts' identifier: fleet-automation-upgrade-hosts @@ -7947,7 +7947,7 @@ menu: - CreateFleetDeploymentUpgrade unstable: - v2 - order: 2 + order: 5 - name: Create a configuration deployment url: '#create-a-configuration-deployment' identifier: fleet-automation-create-a-configuration-deployment @@ -7960,7 +7960,7 @@ menu: - CreateFleetDeploymentConfigure unstable: - v2 - order: 1 + order: 4 - name: List all deployments url: '#list-all-deployments' identifier: fleet-automation-list-all-deployments @@ -7973,7 +7973,33 @@ menu: - ListFleetDeployments unstable: - v2 - order: 0 + order: 3 + - name: Get detailed information about an agent + url: '#get-detailed-information-about-an-agent' + identifier: fleet-automation-get-detailed-information-about-an-agent + parent: fleet-automation + generated: true + params: + versions: + - v2 + operationids: + - GetFleetAgentInfo + unstable: + - v2 + order: 2 + - name: List all Datadog Agents + url: '#list-all-datadog-agents' + identifier: fleet-automation-list-all-datadog-agents + parent: fleet-automation + generated: true + params: + versions: + - v2 + operationids: + - ListFleetAgents + unstable: + - v2 + order: 1 - name: List all available Agent versions url: '#list-all-available-agent-versions' identifier: fleet-automation-list-all-available-agent-versions diff --git a/content/en/api/v2/fleet-automation/examples.json b/content/en/api/v2/fleet-automation/examples.json index afec797f06c..96fd270361c 100644 --- a/content/en/api/v2/fleet-automation/examples.json +++ b/content/en/api/v2/fleet-automation/examples.json @@ -62,6 +62,263 @@ "html": "" } }, + "ListFleetAgents": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "agents": [ + { + "agent_version": "7.50.0", + "api_key_name": "Production API Key", + "api_key_uuid": "a1b2c3d4-e5f6-4321-a123-123456789abc", + "cloud_provider": "aws", + "cluster_name": "string", + "datadog_agent_key": "my-agent-hostname", + "enabled_products": [], + "envs": [], + "first_seen_at": "integer", + "hostname": "my-hostname", + "ip_addresses": [], + "is_single_step_instrumentation_enabled": false, + "last_restart_at": "integer", + "os": "linux", + "otel_collector_version": "string", + "otel_collector_versions": [], + "pod_name": "string", + "remote_agent_management": "enabled", + "remote_config_status": "connected", + "services": [], + "tags": [ + { + "key": "string", + "value": "string" + } + ], + "team": "string" + } + ] + }, + "id": "done", + "type": "status" + }, + "meta": { + "total_filtered_count": 150 + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The response data containing status and agents array.

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

attributes [required]

\n
\n

object

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

agents

\n
\n

[object]

\n

Array of agents matching the query criteria.

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

agent_version

\n
\n

string

\n

The Datadog Agent version.

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

api_key_name

\n
\n

string

\n

The API key name (if available and not redacted).

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

api_key_uuid

\n
\n

string

\n

The API key UUID.

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

cloud_provider

\n
\n

string

\n

The cloud provider where the agent is running.

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

cluster_name

\n
\n

string

\n

Kubernetes cluster name (if applicable).

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

datadog_agent_key

\n
\n

string

\n

The unique agent key identifier.

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

enabled_products

\n
\n

[string]

\n

Datadog products enabled on the agent.

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

envs

\n
\n

[string]

\n

Environments the agent is reporting from.

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

first_seen_at

\n
\n

int64

\n

Timestamp when the agent was first seen.

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

hostname

\n
\n

string

\n

The hostname of the agent.

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

ip_addresses

\n
\n

[string]

\n

IP addresses of the agent.

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

is_single_step_instrumentation_enabled

\n
\n

boolean

\n

Whether single-step instrumentation is enabled.

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

last_restart_at

\n
\n

int64

\n

Timestamp of the last agent restart.

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

os

\n
\n

string

\n

The operating system.

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

otel_collector_version

\n
\n

string

\n

OpenTelemetry collector version (if applicable).

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

otel_collector_versions

\n
\n

[string]

\n

List of OpenTelemetry collector versions (if applicable).

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

pod_name

\n
\n

string

\n

Kubernetes pod name (if applicable).

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

remote_agent_management

\n
\n

string

\n

Remote agent management status.

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

remote_config_status

\n
\n

string

\n

Remote configuration status.

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

services

\n
\n

[string]

\n

Services running on the agent.

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

tags

\n
\n

[object]

\n

Tags associated with the agent.

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

key

\n
\n

string

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

value

\n
\n

string

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

team

\n
\n

string

\n

Team associated with the agent.

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

id [required]

\n
\n

string

\n

Status identifier.

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

type [required]

\n
\n

string

\n

Resource type.

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

meta

\n
\n

object

\n

Metadata for the list of agents response.

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

total_filtered_count

\n
\n

int64

\n

Total number of agents matching the filter criteria across all pages.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetFleetAgentInfo": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "agent_infos": { + "agent_version": "7.50.0", + "api_key_name": "Production API Key", + "api_key_uuid": "a1b2c3d4-e5f6-4321-a123-123456789abc", + "cloud_provider": "aws", + "cluster_name": "string", + "datadog_agent_key": "my-agent-hostname", + "enabled_products": [], + "env": [], + "first_seen_at": "integer", + "hostname": "my-hostname", + "hostname_aliases": [], + "install_method_installer_version": "1.2.3", + "install_method_tool": "chef", + "ip_addresses": [], + "is_single_step_instrumentation_enabled": false, + "last_restart_at": "integer", + "os": "linux", + "os_version": "Ubuntu 20.04", + "otel_collector_version": "string", + "otel_collector_versions": [], + "otel_collectors": [], + "pod_name": "string", + "python_version": "3.9.5", + "region": [], + "remote_agent_management": "enabled", + "remote_config_status": "connected", + "services": [], + "tags": [], + "team": "string" + }, + "configuration_files": { + "compiled_configuration": "string", + "env_configuration": "string", + "file_configuration": "string", + "parsed_configuration": "string", + "remote_configuration": "string", + "runtime_configuration": "string" + }, + "detected_integrations": [ + { + "escaped_name": "postgresql", + "prefix": "postgres" + } + ], + "integrations": { + "configuration_files": [ + { + "file_content": "string", + "file_path": "/conf.d/postgres.d/postgres.yaml", + "filename": "postgres.yaml" + } + ], + "datadog_agent_key": "string", + "error_integrations": [ + { + "data_type": "metrics", + "error_messages": [], + "init_config": "string", + "instance_config": "string", + "is_custom_check": false, + "log_config": "string", + "name": "string", + "source_index": "integer", + "source_path": "string", + "type": "postgres" + } + ], + "missing_integrations": [ + { + "escaped_name": "postgresql", + "prefix": "postgres" + } + ], + "warning_integrations": [ + { + "data_type": "metrics", + "error_messages": [], + "init_config": "string", + "instance_config": "string", + "is_custom_check": false, + "log_config": "string", + "name": "string", + "source_index": "integer", + "source_path": "string", + "type": "postgres" + } + ], + "working_integrations": [ + { + "data_type": "metrics", + "error_messages": [], + "init_config": "string", + "instance_config": "string", + "is_custom_check": false, + "log_config": "string", + "name": "string", + "source_index": "integer", + "source_path": "string", + "type": "postgres" + } + ] + } + }, + "id": "my-agent-hostname", + "type": "datadog_agent_key" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Represents detailed information about a specific Datadog Agent.

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

attributes [required]

\n
\n

object

\n

Attributes for agent information.

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

agent_infos

\n
\n

object

\n

Detailed information about a Datadog Agent.

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

agent_version

\n
\n

string

\n

The Datadog Agent version.

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

api_key_name

\n
\n

string

\n

The API key name (if available and not redacted).

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

api_key_uuid

\n
\n

string

\n

The API key UUID.

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

cloud_provider

\n
\n

string

\n

The cloud provider where the agent is running.

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

cluster_name

\n
\n

string

\n

Kubernetes cluster name (if applicable).

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

datadog_agent_key

\n
\n

string

\n

The unique agent key identifier.

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

enabled_products

\n
\n

[string]

\n

Datadog products enabled on the agent.

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

env

\n
\n

[string]

\n

Environments the agent is reporting from.

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

first_seen_at

\n
\n

int64

\n

Timestamp when the agent was first seen.

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

hostname

\n
\n

string

\n

The hostname of the agent.

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

hostname_aliases

\n
\n

[string]

\n

Alternative hostname list for the agent.

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

install_method_installer_version

\n
\n

string

\n

The version of the installer used.

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

install_method_tool

\n
\n

string

\n

The tool used to install the agent.

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

ip_addresses

\n
\n

[string]

\n

IP addresses of the agent.

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

is_single_step_instrumentation_enabled

\n
\n

boolean

\n

Whether single-step instrumentation is enabled.

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

last_restart_at

\n
\n

int64

\n

Timestamp of the last agent restart.

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

os

\n
\n

string

\n

The operating system.

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

os_version

\n
\n

string

\n

The operating system version.

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

otel_collector_version

\n
\n

string

\n

OpenTelemetry collector version (if applicable).

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

otel_collector_versions

\n
\n

[string]

\n

List of OpenTelemetry collector versions (if applicable).

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

otel_collectors

\n
\n

[object]

\n

OpenTelemetry collectors associated with the agent (if applicable).

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

pod_name

\n
\n

string

\n

Kubernetes pod name (if applicable).

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

python_version

\n
\n

string

\n

The Python version used by the agent.

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

region

\n
\n

[string]

\n

Regions where the agent is running.

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

remote_agent_management

\n
\n

string

\n

Remote agent management status.

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

remote_config_status

\n
\n

string

\n

Remote configuration status.

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

services

\n
\n

[string]

\n

Services running on the agent.

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

tags

\n
\n

[string]

\n

Tags associated with the agent.

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

team

\n
\n

string

\n

Team associated with the agent.

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

configuration_files

\n
\n

object

\n

Configuration information organized by layers.

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

compiled_configuration

\n
\n

string

\n

The final compiled configuration.

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

env_configuration

\n
\n

string

\n

Configuration from environment variables.

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

file_configuration

\n
\n

string

\n

Configuration from files.

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

parsed_configuration

\n
\n

string

\n

Parsed configuration output.

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

remote_configuration

\n
\n

string

\n

Remote configuration settings.

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

runtime_configuration

\n
\n

string

\n

Runtime configuration.

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

detected_integrations

\n
\n

[object]

\n

List of detected integrations.

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

escaped_name

\n
\n

string

\n

Escaped integration name.

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

prefix

\n
\n

string

\n

Integration prefix identifier.

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

integrations

\n
\n

object

\n

Integrations organized by their status.

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

configuration_files

\n
\n

[object]

\n

Configuration files for integrations.

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

file_content

\n
\n

string

\n

The raw content of the configuration file.

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

file_path

\n
\n

string

\n

Path to the configuration file.

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

filename

\n
\n

string

\n

Name of the configuration file.

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

datadog_agent_key

\n
\n

string

\n

The unique agent key identifier.

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

error_integrations

\n
\n

[object]

\n

Integrations with errors.

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

data_type

\n
\n

string

\n

Type of data collected (metrics, logs).

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

error_messages

\n
\n

[string]

\n

Error messages if the integration has issues.

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

init_config

\n
\n

string

\n

Initialization configuration (YAML format).

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

instance_config

\n
\n

string

\n

Instance-specific configuration (YAML format).

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

is_custom_check

\n
\n

boolean

\n

Whether this is a custom integration.

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

log_config

\n
\n

string

\n

Log collection configuration (YAML format).

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

name

\n
\n

string

\n

Name of the integration instance.

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

source_index

\n
\n

int64

\n

Index in the configuration file.

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

source_path

\n
\n

string

\n

Path to the configuration file.

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

type

\n
\n

string

\n

Integration type.

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

missing_integrations

\n
\n

[object]

\n

Detected but not configured integrations.

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

escaped_name

\n
\n

string

\n

Escaped integration name.

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

prefix

\n
\n

string

\n

Integration prefix identifier.

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

warning_integrations

\n
\n

[object]

\n

Integrations with warnings.

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

data_type

\n
\n

string

\n

Type of data collected (metrics, logs).

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

error_messages

\n
\n

[string]

\n

Error messages if the integration has issues.

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

init_config

\n
\n

string

\n

Initialization configuration (YAML format).

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

instance_config

\n
\n

string

\n

Instance-specific configuration (YAML format).

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

is_custom_check

\n
\n

boolean

\n

Whether this is a custom integration.

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

log_config

\n
\n

string

\n

Log collection configuration (YAML format).

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

name

\n
\n

string

\n

Name of the integration instance.

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

source_index

\n
\n

int64

\n

Index in the configuration file.

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

source_path

\n
\n

string

\n

Path to the configuration file.

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

type

\n
\n

string

\n

Integration type.

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

working_integrations

\n
\n

[object]

\n

Integrations that are working correctly.

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

data_type

\n
\n

string

\n

Type of data collected (metrics, logs).

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

error_messages

\n
\n

[string]

\n

Error messages if the integration has issues.

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

init_config

\n
\n

string

\n

Initialization configuration (YAML format).

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

instance_config

\n
\n

string

\n

Instance-specific configuration (YAML format).

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

is_custom_check

\n
\n

boolean

\n

Whether this is a custom integration.

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

log_config

\n
\n

string

\n

Log collection configuration (YAML format).

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

name

\n
\n

string

\n

Name of the integration instance.

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

source_index

\n
\n

int64

\n

Index in the configuration file.

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

source_path

\n
\n

string

\n

Path to the configuration file.

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

type

\n
\n

string

\n

Integration type.

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

id [required]

\n
\n

string

\n

The unique agent key identifier.

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

type [required]

\n
\n

enum

\n

The type of Agent info resource. \nAllowed enum values: datadog_agent_key

default: datadog_agent_key

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, "ListFleetDeployments": { "responses": { "200": { diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index db2a0ec3590..5cc466c2227 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -21860,6 +21860,278 @@ components: - PIPELINES_FAILED_DESCENDING - PIPELINES_DURATION_LOST_ASCENDING - PIPELINES_DURATION_LOST_DESCENDING + FleetAgentAttributes: + description: Attributes of a Datadog Agent in the list view. + properties: + agent_version: + description: The Datadog Agent version. + example: 7.50.0 + type: string + api_key_name: + description: The API key name (if available and not redacted). + example: Production API Key + type: string + api_key_uuid: + description: The API key UUID. + example: a1b2c3d4-e5f6-4321-a123-123456789abc + type: string + cloud_provider: + description: The cloud provider where the agent is running. + example: aws + type: string + cluster_name: + description: Kubernetes cluster name (if applicable). + type: string + datadog_agent_key: + description: The unique agent key identifier. + example: my-agent-hostname + type: string + enabled_products: + description: Datadog products enabled on the agent. + items: + type: string + type: array + envs: + description: Environments the agent is reporting from. + items: + type: string + type: array + first_seen_at: + description: Timestamp when the agent was first seen. + format: int64 + type: integer + hostname: + description: The hostname of the agent. + example: my-hostname + type: string + ip_addresses: + description: IP addresses of the agent. + items: + type: string + type: array + is_single_step_instrumentation_enabled: + description: Whether single-step instrumentation is enabled. + type: boolean + last_restart_at: + description: Timestamp of the last agent restart. + format: int64 + type: integer + os: + description: The operating system. + example: linux + type: string + otel_collector_version: + description: OpenTelemetry collector version (if applicable). + type: string + otel_collector_versions: + description: List of OpenTelemetry collector versions (if applicable). + items: + type: string + type: array + pod_name: + description: Kubernetes pod name (if applicable). + type: string + remote_agent_management: + description: Remote agent management status. + example: enabled + type: string + remote_config_status: + description: Remote configuration status. + example: connected + type: string + services: + description: Services running on the agent. + items: + type: string + type: array + tags: + description: Tags associated with the agent. + items: + $ref: '#/components/schemas/FleetAgentAttributesTagsItems' + type: array + team: + description: Team associated with the agent. + type: string + type: object + FleetAgentAttributesTagsItems: + properties: + key: + type: string + value: + type: string + type: object + FleetAgentInfo: + description: Represents detailed information about a specific Datadog Agent. + properties: + attributes: + $ref: '#/components/schemas/FleetAgentInfoAttributes' + id: + description: The unique agent key identifier. + example: my-agent-hostname + type: string + type: + $ref: '#/components/schemas/FleetAgentInfoResourceType' + required: + - id + - type + - attributes + type: object + FleetAgentInfoAttributes: + description: Attributes for agent information. + properties: + agent_infos: + $ref: '#/components/schemas/FleetAgentInfoDetails' + configuration_files: + $ref: '#/components/schemas/FleetConfigurationLayer' + detected_integrations: + description: List of detected integrations. + items: + $ref: '#/components/schemas/FleetDetectedIntegration' + type: array + integrations: + $ref: '#/components/schemas/FleetIntegrationsByStatus' + type: object + FleetAgentInfoDetails: + description: Detailed information about a Datadog Agent. + properties: + agent_version: + description: The Datadog Agent version. + example: 7.50.0 + type: string + api_key_name: + description: The API key name (if available and not redacted). + example: Production API Key + type: string + api_key_uuid: + description: The API key UUID. + example: a1b2c3d4-e5f6-4321-a123-123456789abc + type: string + cloud_provider: + description: The cloud provider where the agent is running. + example: aws + type: string + cluster_name: + description: Kubernetes cluster name (if applicable). + type: string + datadog_agent_key: + description: The unique agent key identifier. + example: my-agent-hostname + type: string + enabled_products: + description: Datadog products enabled on the agent. + items: + type: string + type: array + env: + description: Environments the agent is reporting from. + items: + type: string + type: array + first_seen_at: + description: Timestamp when the agent was first seen. + format: int64 + type: integer + hostname: + description: The hostname of the agent. + example: my-hostname + type: string + hostname_aliases: + description: Alternative hostname list for the agent. + items: + type: string + type: array + install_method_installer_version: + description: The version of the installer used. + example: 1.2.3 + type: string + install_method_tool: + description: The tool used to install the agent. + example: chef + type: string + ip_addresses: + description: IP addresses of the agent. + items: + type: string + type: array + is_single_step_instrumentation_enabled: + description: Whether single-step instrumentation is enabled. + type: boolean + last_restart_at: + description: Timestamp of the last agent restart. + format: int64 + type: integer + os: + description: The operating system. + example: linux + type: string + os_version: + description: The operating system version. + example: Ubuntu 20.04 + type: string + otel_collector_version: + description: OpenTelemetry collector version (if applicable). + type: string + otel_collector_versions: + description: List of OpenTelemetry collector versions (if applicable). + items: + type: string + type: array + otel_collectors: + description: OpenTelemetry collectors associated with the agent (if applicable). + items: + $ref: '#/components/schemas/FleetOtelCollector' + type: array + pod_name: + description: Kubernetes pod name (if applicable). + type: string + python_version: + description: The Python version used by the agent. + example: 3.9.5 + type: string + region: + description: Regions where the agent is running. + items: + type: string + type: array + remote_agent_management: + description: Remote agent management status. + example: enabled + type: string + remote_config_status: + description: Remote configuration status. + example: connected + type: string + services: + description: Services running on the agent. + items: + type: string + type: array + tags: + description: Tags associated with the agent. + items: + type: string + type: array + team: + description: Team associated with the agent. + type: string + type: object + FleetAgentInfoResourceType: + default: datadog_agent_key + description: The type of Agent info resource. + enum: + - datadog_agent_key + example: datadog_agent_key + type: string + x-enum-varnames: + - DATADOG_AGENT_KEY + FleetAgentInfoResponse: + description: Response containing detailed information about a specific agent. + properties: + data: + $ref: '#/components/schemas/FleetAgentInfo' + required: + - data + type: object FleetAgentVersion: description: Represents an available Datadog Agent version. properties: @@ -21902,6 +22174,89 @@ components: required: - data type: object + FleetAgentsResponse: + description: Response containing a paginated list of Datadog Agents. + properties: + data: + $ref: '#/components/schemas/FleetAgentsResponseData' + meta: + $ref: '#/components/schemas/FleetAgentsResponseMeta' + required: + - data + type: object + FleetAgentsResponseData: + description: The response data containing status and agents array. + properties: + attributes: + $ref: '#/components/schemas/FleetAgentsResponseDataAttributes' + id: + description: Status identifier. + example: done + type: string + type: + description: Resource type. + example: status + type: string + required: + - id + - type + - attributes + type: object + FleetAgentsResponseDataAttributes: + properties: + agents: + description: Array of agents matching the query criteria. + items: + $ref: '#/components/schemas/FleetAgentAttributes' + type: array + type: object + FleetAgentsResponseMeta: + description: Metadata for the list of agents response. + properties: + total_filtered_count: + description: Total number of agents matching the filter criteria across + all pages. + example: 150 + format: int64 + type: integer + type: object + FleetConfigurationFile: + description: A configuration file for an integration. + properties: + file_content: + description: The raw content of the configuration file. + type: string + file_path: + description: Path to the configuration file. + example: /conf.d/postgres.d/postgres.yaml + type: string + filename: + description: Name of the configuration file. + example: postgres.yaml + type: string + type: object + FleetConfigurationLayer: + description: Configuration information organized by layers. + properties: + compiled_configuration: + description: The final compiled configuration. + type: string + env_configuration: + description: Configuration from environment variables. + type: string + file_configuration: + description: Configuration from files. + type: string + parsed_configuration: + description: Parsed configuration output. + type: string + remote_configuration: + description: Remote configuration settings. + type: string + runtime_configuration: + description: Runtime configuration. + type: string + type: object FleetDeployment: description: A deployment that defines automated configuration changes for a fleet of hosts. @@ -22225,6 +22580,93 @@ components: page: $ref: '#/components/schemas/FleetDeploymentsPage' type: object + FleetDetectedIntegration: + description: An integration detected on the agent but not necessarily configured. + properties: + escaped_name: + description: Escaped integration name. + example: postgresql + type: string + prefix: + description: Integration prefix identifier. + example: postgres + type: string + type: object + FleetIntegrationDetails: + description: Detailed information about a single integration. + properties: + data_type: + description: Type of data collected (metrics, logs). + example: metrics + type: string + error_messages: + description: Error messages if the integration has issues. + items: + type: string + type: array + init_config: + description: Initialization configuration (YAML format). + type: string + instance_config: + description: Instance-specific configuration (YAML format). + type: string + is_custom_check: + description: Whether this is a custom integration. + type: boolean + log_config: + description: Log collection configuration (YAML format). + type: string + name: + description: Name of the integration instance. + type: string + source_index: + description: Index in the configuration file. + format: int64 + type: integer + source_path: + description: Path to the configuration file. + type: string + type: + description: Integration type. + example: postgres + type: string + type: object + FleetIntegrationsByStatus: + description: Integrations organized by their status. + properties: + configuration_files: + description: Configuration files for integrations. + items: + $ref: '#/components/schemas/FleetConfigurationFile' + type: array + datadog_agent_key: + description: The unique agent key identifier. + type: string + error_integrations: + description: Integrations with errors. + items: + $ref: '#/components/schemas/FleetIntegrationDetails' + type: array + missing_integrations: + description: Detected but not configured integrations. + items: + $ref: '#/components/schemas/FleetDetectedIntegration' + type: array + warning_integrations: + description: Integrations with warnings. + items: + $ref: '#/components/schemas/FleetIntegrationDetails' + type: array + working_integrations: + description: Integrations that are working correctly. + items: + $ref: '#/components/schemas/FleetIntegrationDetails' + type: array + type: object + FleetOtelCollector: + additionalProperties: {} + description: OpenTelemetry collector information. + type: object FleetSchedule: description: A schedule that automatically creates deployments based on a recurrence rule. @@ -57720,7 +58162,7 @@ info: version: '1.0' openapi: 3.0.0 paths: - /api/unstable/fleet/agents: + /api/unstable/fleet/agent_versions: get: description: 'Retrieve a list of all available Datadog Agent versions. @@ -57764,6 +58206,144 @@ paths: x-unstable: 'This endpoint is in Preview and may introduce breaking changes. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + /api/unstable/fleet/agents: + get: + description: 'Retrieve a paginated list of all Datadog Agents. + + This endpoint returns a paginated list of all Datadog Agents with support + for pagination, sorting, and filtering. + + Use the `page_number` and `page_size` query parameters to paginate through + results.' + operationId: ListFleetAgents + parameters: + - description: Page number for pagination (must be greater than 0). + in: query + name: page_number + required: false + schema: + format: int64 + minimum: 1 + type: integer + - description: Number of results per page (must be greater than 0 and less than + or equal to 100). + in: query + name: page_size + required: false + schema: + default: 10 + format: int64 + maximum: 100 + minimum: 1 + type: integer + - description: Attribute to sort by. + in: query + name: sort_attribute + required: false + schema: + type: string + - description: Sort order (true for descending, false for ascending). + in: query + name: sort_descending + required: false + schema: + type: boolean + - description: Comma-separated list of tags to filter agents. + in: query + name: tags + required: false + schema: + type: string + - description: Filter string for narrowing down agent results. + example: hostname:my-hostname OR env:dev + in: query + name: filter + required: false + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FleetAgentsResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: List all Datadog Agents + tags: + - Fleet Automation + x-menu-order: 1 + x-permission: + operator: AND + permissions: + - hosts_read + x-unstable: 'This endpoint is in Preview and may introduce breaking changes. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' + /api/unstable/fleet/agents/{agent_key}: + get: + description: 'Retrieve detailed information about a specific Datadog Agent. + + This endpoint returns comprehensive information about an agent including: + + - Agent details and metadata + + - Configured integrations organized by status (working, warning, error, missing) + + - Detected integrations + + - Configuration files and layers' + operationId: GetFleetAgentInfo + parameters: + - description: The unique identifier (agent key) for the Datadog Agent. + in: path + name: agent_key + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/FleetAgentInfoResponse' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '401': + $ref: '#/components/responses/UnauthorizedResponse' + '403': + $ref: '#/components/responses/ForbiddenResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Get detailed information about an agent + tags: + - Fleet Automation + x-menu-order: 2 + x-permission: + operator: AND + permissions: + - hosts_read + x-unstable: 'This endpoint is in Preview and may introduce breaking changes. + + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' /api/unstable/fleet/deployments: get: description: 'Retrieve a list of all deployments for fleet automation. @@ -57810,7 +58390,7 @@ paths: summary: List all deployments tags: - Fleet Automation - x-menu-order: 0 + x-menu-order: 3 x-permission: operator: AND permissions: @@ -57858,6 +58438,77 @@ paths: type: file filter_query: env:prod type: deployment + comprehensive_configuration: + summary: Comprehensive example with multiple configuration file types + value: + data: + attributes: + config_operations: + - file_op: merge-patch + file_path: /datadog.yaml + patch: + apm_config: + apm_dd_url: https://trace.agent.datadoghq.com + enabled: true + log_level: info + logs_enabled: true + process_config: + enabled: true + - file_op: merge-patch + file_path: /security-agent.yaml + patch: + runtime_security_config: + enabled: true + fim_enabled: true + - file_op: merge-patch + file_path: /system-probe.yaml + patch: + network_config: + enabled: true + service_monitoring_config: + enabled: true + - file_op: merge-patch + file_path: /application_monitoring.yaml + patch: + enabled: true + server: + host: 0.0.0.0 + port: 8126 + - file_op: merge-patch + file_path: /conf.d/logs.d/custom-app.yaml + patch: + logs: + - path: /var/log/custom-app/*.log + service: custom-app + source: custom + type: file + - file_op: merge-patch + file_path: /conf.d/docker.d/docker-logs.yaml + patch: + logs: + - service: docker + source: docker + type: docker + - file_op: merge-patch + file_path: /conf.d/snmp.d/network-devices.yaml + patch: + init_config: + loader: core + instances: + - community_string: public + ip_address: 192.168.1.1 + - file_op: merge-patch + file_path: /conf.d/postgres.d/conf.yaml + patch: + instances: + - dbname: postgres + host: localhost + port: 5432 + username: datadog + - file_op: delete + file_path: /conf.d/deprecated-integration.yaml + filter_query: env:prod AND datacenter:us-east-1 + type: deployment delete_config_file: summary: Delete a configuration file value: @@ -57920,7 +58571,7 @@ paths: summary: Create a configuration deployment tags: - Fleet Automation - x-menu-order: 1 + x-menu-order: 4 x-permission: operator: AND permissions: @@ -58002,7 +58653,7 @@ paths: summary: Upgrade hosts tags: - Fleet Automation - x-menu-order: 2 + x-menu-order: 5 x-permission: operator: AND permissions: @@ -58080,7 +58731,7 @@ paths: summary: Get a configuration deployment by ID tags: - Fleet Automation - x-menu-order: 3 + x-menu-order: 6 x-permission: operator: AND permissions: @@ -58135,7 +58786,7 @@ paths: summary: Cancel a deployment tags: - Fleet Automation - x-menu-order: 4 + x-menu-order: 7 x-permission: operator: AND permissions: @@ -58177,7 +58828,7 @@ paths: summary: List all schedules tags: - Fleet Automation - x-menu-order: 0 + x-menu-order: 8 x-permission: operator: AND permissions: @@ -58269,7 +58920,7 @@ paths: summary: Create a schedule tags: - Fleet Automation - x-menu-order: 1 + x-menu-order: 9 x-permission: operator: AND permissions: @@ -58322,7 +58973,7 @@ paths: summary: Delete a schedule tags: - Fleet Automation - x-menu-order: 4 + x-menu-order: 12 x-permission: operator: AND permissions: @@ -58378,7 +59029,7 @@ paths: summary: Get a schedule by ID tags: - Fleet Automation - x-menu-order: 2 + x-menu-order: 10 x-permission: operator: AND permissions: @@ -58475,7 +59126,7 @@ paths: summary: Update a schedule tags: - Fleet Automation - x-menu-order: 3 + x-menu-order: 11 x-permission: operator: AND permissions: @@ -58548,7 +59199,7 @@ paths: summary: Trigger a schedule deployment tags: - Fleet Automation - x-menu-order: 5 + x-menu-order: 13 x-permission: operator: AND permissions: diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index cb149b9af48..8beba773ccc 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -3,6 +3,14 @@ "description": "Retrieve a list of all available Datadog Agent versions.\n\nThis endpoint returns the available Agent versions that can be deployed to your fleet.\nThese versions are used when creating deployments or configuring schedules for\nautomated Agent upgrades.", "summary": "List all available Agent versions" }, + "ListFleetAgents": { + "description": "Retrieve a paginated list of all Datadog Agents.\nThis endpoint returns a paginated list of all Datadog Agents with support for pagination, sorting, and filtering.\nUse the `page_number` and `page_size` query parameters to paginate through results.", + "summary": "List all Datadog Agents" + }, + "GetFleetAgentInfo": { + "description": "Retrieve detailed information about a specific Datadog Agent.\nThis endpoint returns comprehensive information about an agent including:\n- Agent details and metadata\n- Configured integrations organized by status (working, warning, error, missing)\n- Detected integrations\n- Configuration files and layers", + "summary": "Get detailed information about an agent" + }, "ListFleetDeployments": { "description": "Retrieve a list of all deployments for fleet automation.\nUse the `page_size` and `page_offset` parameters to paginate results.", "summary": "List all deployments"