Delete cloud onboarding deployment

Base URL: https://{kibana_url}

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

Auth

Delete a cloud onboarding deployment 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 deployment.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Responses

Successful response

application/json

id string required

Bad Request

application/json

Not Found

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

DELETE kbn:/api/fleet/cloud_onboarding_deployments/ID

Generated from the API spec

curl Shell

curl -X DELETE "${KIBANA_URL}/api/fleet/cloud_onboarding_deployments/${ID}" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

The cloud onboarding deployment was successfully deleted

{
  "id": "onboarding-deployment-id-1"
}

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