Type to search.

Get cloud onboarding instances

Base URL
https://{kibana_url}
  • GET /api/fleet/cloud_onboarding_deployments
  • GET /s/{space_id}/api/fleet/cloud_onboarding_deployments
Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Planned We plan to add this functionality in a future Elastic Stack update. Subject to changes. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

List cloud onboarding instances, newest first. Optionally filter by package name or provider.

Required privileges

Privileges fleet-agent-policies-read or integrations-read

Path parameters

space_id string optional

An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Query parameters

packageName string · min length: 1 · max length: 255

Only list deployment instances that cover this package.

provider enum

Cloud provider.

Values: aws azure gcp
page number · min: 1 · max: 1000 · default: 1

The page of deployment instances to return, starting at 1.

perPage number · min: 1 · max: 100 · default: 20

The number of deployment instances per page.

Responses

Successful response

application/json
items object[] · max items: 100 required
agentCount number · min: 0

Number of agents enrolled in the deployment instance agent policies. Only agent policies in the current space are counted. Omitted without permission to read agents.

agentPolicyIds string[] · max items: 1000

Agent policy IDs for agent_based deployments. Single-element for new-policy deploys; multiple for existing-policy deploys targeting several policies.

apiKeyId string

Elasticsearch API key ID for push mechanisms (ecf). Set by the backend; used for key rotation/revocation.

attemptCount number · min: 1 required

Number of deployment attempts, including the current one.

authMethod enum

Authentication method. Allowed values depend on the delivery mechanism:

  • managed_integration: identity_federation | static_keys
  • agent_based: static_keys (direct_access_keys) | temporary_keys | shared_credentials | assume_role
Values: identity_federation static_keys temporary_keys shared_credentials assume_role
connectorId string

ID of the fleet-cloud-connector this deployment belongs to. Absent for static-keys deployments.

dataFormat enum

Data format: ecs or otel.

Values: ecs otel
dedicatedNamespaceTemplates boolean The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Planned We plan to add this functionality in a future Elastic Stack update. Subject to changes. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Whether the global namespace uses dedicated index templates. Applied to the installed packages after a deployment. Absent means off.

deploymentId string

Opaque deployment identifier; for AWS, the CFN stack ARN.

deploymentName string

Opaque deployment name; for AWS, the CFN stack name.

description string

Integration description from the Service settings step.

globalRegion string

Global AWS region from the Service Settings step.

id string required
integrationName string

Integration name as entered in the Service settings step, before any per-package suffix is applied.

mechanisms enum[] · max items: 10 required
Values: managed_integration ecf agent_based
namespace string

Global data stream namespace from the Service settings step. When omitted, an agent-based deployment inherits the agent policy namespace, other deployment methods use the default namespace.

packageNames string[] · max items: 100

Names of the integration packages this deployment covers (e.g. aws, aws_bedrock). Used to list the deployments of a package.

packagePolicyIds string[] · max items: 1000

Integration policy IDs created for this deployment (managed_integration and agent_based).

packages object[] · max items: 100 required

Packages of the deployment instance integration policies with their deployed versions. Empty for ECF-only deployment instances.

name string required

Name of the integration package, for example aws.

title string required

Display title of the integration package, for example AWS.

version string required

Package version the deployment instance policies run.

policyIdsByInstance map string to string

instanceId → policyId mapping persisted after deploy. Hydrated into the wizard on resume to enable cleanup of stale policies when services are removed.

<string> string · max length: 255
policySettings map string to string The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Planned We plan to add this functionality in a future Elastic Stack update. Subject to changes. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Integration policy settings from the Service settings step that apply to every integration policy of the deployment, keyed by integration policy field (for example output_id).

<string> string · max length: 10000 · default: null
provider enum required

Cloud provider.

Values: aws azure gcp
serviceNames map string to string

Display name of each service as shown in the onboarding flow, by service ID.

<string> string · max length: 256
services string[] · max items: 1000 required

Service IDs covered by this deployment.

servicesByMethod object required

Service IDs by the delivery mechanism that deploys them.

agent_based string[] · max items: 1000
ecf string[] · max items: 1000
managed_integration string[] · max items: 1000
serviceVars map string to string to object

Per-service config keyed by instance ID. Each value is the ServiceVars object from the Service Settings step.

status enum required

Deployment status.

Values: pending deploying succeeded failed
statusMessage string

Error context when status is failed.

updatedAt string

ISO timestamp of the last write.

updatedBy string

Username of the user who last wrote the deployment.

page number required
perPage number required
total number required