Update cloud onboarding deployment

Server: https://{kibana_url}

PUT /api/fleet/cloud_onboarding_deployments/{id}

Update a cloud onboarding deployment by ID.

[Required authorization] Route required privileges: fleet-agent-policies-all OR integrations-all.

Path Parameters

id string · max: 255 required: The saved object ID of the cloud onboarding deployment.

Request

Responses

Successful response

application/json

Bad Request

application/json

Not Found

application/json

Examples

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

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT /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"
}

curl Shell

curl -X PUT "https://{kibana_url}/api/fleet/cloud_onboarding_deployments/{id}" \
  -H "kbn-xsrf: true" \
  -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"
}'

Response

{
  "item": {
    "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
}

Path Parameters

Request { agentPolicyId , apiKeyId , attemptCount , deploymentId , deploymentName , ecfStacks , packagePolicyIds , serviceVars , status , statusMessage , }

Responses

Request