Update cloud onboarding deployment

Base URL: https://{kibana_url}

PUT /api/fleet/cloud_onboarding_deployments/{id}
PUT /s/{space_id}/api/fleet/cloud_onboarding_deployments/{id}

Refer to Spaces for more information.

Update a cloud onboarding deployment by ID.

Required authorization

Authentication

Path parameters

Header parameters

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
deploymentId string · max length: 2048: CFN stack ARN (or equivalent); provided by the client after manual deployment.
deploymentName string · max length: 255
ecfStacks object[] · max items: 10: ECF CloudFormation stacks to record for this deployment.
mechanisms enum[] · max items: 10: Delivery mechanisms active in this deployment. Replaces the stored mechanisms array.; Values: managed_integration ecf agent_based
packagePolicyIds string[] · max items: 1000: Package policy IDs created for this deployment (managed_integration and agent_based).
policyIdsByInstance map string to string
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

Bad Request

application/json

Not Found

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Update a cloud onboarding deployment after the CFN stack has been submitted

Console Kibana Dev Tools

PUT kbn:/api/fleet/cloud_onboarding_deployments/ID
{
  "deploymentId": "arn:aws:cloudformation:us-east-1:123456789012:stack/elastic-aws-onboarding/aaa-bbb-ccc",
  "deploymentName": "elastic-aws-onboarding",
  "status": "deploying"
}

Generated from the API spec

curl Shell

curl -X PUT "${KIBANA_URL}/api/fleet/cloud_onboarding_deployments/${ID}" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "deploymentId": "arn:aws:cloudformation:us-east-1:123456789012:stack/elastic-aws-onboarding/aaa-bbb-ccc",
    "deploymentName": "elastic-aws-onboarding",
    "status": "deploying"
  }'

Generated from the API spec

Response

The updated cloud onboarding deployment

{
  "item": {
    "agentPolicyIds": [
      "agent-policy-id-1"
    ],
    "attemptCount": 1,
    "connectorId": "cloud-connector-id-1",
    "deploymentId": "arn:aws:cloudformation:us-east-1:123456789012:stack/elastic-aws-onboarding/aaa-bbb-ccc",
    "deploymentName": "elastic-aws-onboarding",
    "id": "onboarding-deployment-id-1",
    "mechanisms": [
      "managed_integration"
    ],
    "packagePolicyIds": [
      "package-policy-id-1"
    ],
    "provider": "aws",
    "services": [
      "cloudwatch_metrics",
      "cloudtrail"
    ],
    "status": "deploying"
  }
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}

{
  "error": "Not Found",
  "message": "Saved object [fleet-cloud-onboarding-deployment/unknown-id] not found",
  "statusCode": 404
}

Required authorization

Authentication

Path parameters

Header parameters

Request body { }

Responses

Request body