Sign in
Fleet cloud onboarding deployments

Update cloud onboarding deployment

Spaces method and path for this operation:

<div><span class="operation-verb put">put</span>&nbsp;<span class="operation-path">/s/{space_id}/api/fleet/cloud_onboarding_deployments/{id}</span></div>

Refer to Spaces for more information.

Update a cloud onboarding deployment by ID.<br/><br/>[Required authorization] Route required privileges: fleet-agent-policies-all OR integrations-all.

put/api/fleet/cloud_onboarding_deployments/{id}

Path parameters

idstring required

The saved object ID of the cloud onboarding deployment.

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

agentPolicyIdstring
apiKeyIdstring
attemptCountnumber

Incremented by callers performing a retry.

authMethod'identity_federation' | 'static_keys' | 'null' nullable
connectorIdstring nullable
deploymentIdstring

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

deploymentNamestring
mechanismsstring[]

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

packagePolicyIdsstring[]
policyIdsByInstanceobject
servicesstring[]

Updated service list. Replaces the stored services array.

serviceVarsobject

Per-service config keyed by instance ID.

status'pending' | 'deploying' | 'succeeded' | 'failed'

Deployment status.

statusMessagestring

Error context; set when transitioning to failed.

Response

Successful response

Changes

Changed in 1 of the 176 revisions of this API.1

Of the 176 revisions, 20 have no diff computed.