Type to search.

Update cloud onboarding instance

Base URL
https://{kibana_url}
  • PUT /api/fleet/cloud_onboarding_deployments/{id}
  • PUT /s/{space_id}/api/fleet/cloud_onboarding_deployments/{id}
Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Experimental This functionality is experimental and is not ready for production usage. Experimental features may change or be removed at any time. Elastic will work to fix any issues, but experimental features are not subject to the support SLA of official GA features. Specific Support terms apply. 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.

Update a cloud onboarding instance by ID.

Required privileges

Privileges fleet-agent-policies-all or integrations-all

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.

id string · max length: 255 required

The saved object ID of the cloud onboarding instance.

Header parameters

kbn-xsrf string required

A required header to protect against CSRF attacks

Request body

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 · max length: 255
attemptCount number · min: 1

Incremented by callers performing a retry.

authMethod enum nullable

Authentication method. Refreshed on each successful deploy so a credential-method change between deploys is reflected on resume.

Values: identity_federation static_keys temporary_keys shared_credentials assume_role null
connectorId string · max length: 255 nullable
dedicatedNamespaceTemplates boolean The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Experimental This functionality is experimental and is not ready for production usage. Experimental features may change or be removed at any time. Elastic will work to fix any issues, but experimental features are not subject to the support SLA of official GA features. Specific Support terms apply. 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. Omit it to keep the stored value. Applied to the installed packages after a deployment.

deploymentId string · max length: 2048

CFN stack ARN (or equivalent); provided by the client after manual deployment.

deploymentName string · max length: 255
description string · max length: 2048 nullable

Integration description from the Service settings step. Send null to clear it.

integrationName string · max length: 160

Integration name used by the last deploy, before any per-package suffix. Refreshed on each deploy because an unedited default name follows the service selection.

mechanisms enum[] · max items: 10

Delivery mechanisms active in this deployment. Replaces the stored mechanisms array.

Values: managed_integration ecf agent_based
namespace string · max length: 100 nullable

Global data stream namespace from the Service settings step. Omit it to keep the stored value, or send null to clear it. When none is set, 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. Refreshed with the service set.

packagePolicyIds string[] · max items: 1000

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

policyIdsByInstance map string to string
<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 Experimental This functionality is experimental and is not ready for production usage. Experimental features may change or be removed at any time. Elastic will work to fix any issues, but experimental features are not subject to the support SLA of official GA features. Specific Support terms apply. 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 that apply to every integration policy of the deployment, keyed by integration policy field (for example output_id). Replaces the stored settings; omit it to keep them.

<string> string · max length: 10000 · default: null
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[] · min items: 1 · max items: 1000

Current service set for this deployment. Refreshed on each successful deploy so resume after an incremental service addition restores all deployed services.

serviceVars map string to string to object

Per-service config keyed by instance ID.

status enum

Deployment status.

Values: pending deploying succeeded failed
statusMessage string · max length: 1000

Error context; set when transitioning to failed.

Responses

Successful response

application/json
item object required
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 Experimental This functionality is experimental and is not ready for production usage. Experimental features may change or be removed at any time. Elastic will work to fix any issues, but experimental features are not subject to the support SLA of official GA features. Specific Support terms apply. 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).

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 Experimental This functionality is experimental and is not ready for production usage. Experimental features may change or be removed at any time. Elastic will work to fix any issues, but experimental features are not subject to the support SLA of official GA features. Specific Support terms apply. 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.

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.