---
type: api
title: Get cloud onboarding deployment instances
description: **Spaces method and path for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4641/api/doc/kibana/operation/operation-get-fleet-cloud-onboarding-deployments
resource: https://www.elastic.co/elastic/docs-builder/docs/4641/api/doc/kibana/operation/operation-get-fleet-cloud-onboarding-deployments
products:
  - Kibana
---

# Get cloud onboarding deployment instances

Authentication: required

Availability: Planned

- Server: `https://{kibana_url}`

## Paths

- `GET` `/api/fleet/cloud_onboarding_deployments`
- `GET` `/s/{space_id}/api/fleet/cloud_onboarding_deployments`

#### 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](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

## Description

List cloud onboarding deployment instances, newest first. Optionally filter by package name or provider.

## Required authorization

- Privileges: `fleet-agent-policies-read` or `integrations-read`

## Query string parameters

- `packageName` (string · min length: 1 · max length: 255) — optional
  Only list deployment instances that cover this package.
- `provider` (enum) — optional
  Cloud provider.
  Values: `aws`, `azure`, `gcp`
- `page` (number · min: 1 · max: 1000 · default: 1) — optional
  The page of deployment instances to return, starting at 1.
- `perPage` (number · min: 1 · max: 100 · default: 20) — optional
  The number of deployment instances per page.

## Responses

#### `200`

Successful response

`application/json`

- `items` (object[] · max items: 100)
  - `agentCount` (number · min: 0)
    Number of agents enrolled in the deployment instance agent policies. Only agent policies in the current space are counted. Omitted without permission to read agents.
  - `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)
    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`
  - `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.
  - `ecfStacks` (object[] · max items: 10)
    ECF CloudFormation stacks launched as part of this deployment. Written by the wizard after the user clicks Launch.
    - `family` (enum)
      ECF template family.
      Values: `unified`, `otel`, `crowdstrike`
    - `serviceConfigs` (object[] · max items: 1000)
      Stack-relevant settings (bucket and log group ARNs) per service when the stack was last launched or updated.
      - `bucketArns` (string[] · max items: 1000)
      - `logGroupArns` (string[] · max items: 1000)
      - `serviceId` (string · min length: 1 · max length: 128)
    - `serviceIds` (string[] · max items: 1000)
      Service IDs active when the stack was last launched or updated.
    - `stackArn` (string · min length: 1 · max length: 2048)
      CloudFormation stack ARN pasted by the user post-launch.
    - `stackName` (string · min length: 1 · max length: 128)
      CloudFormation stack name (128-char AWS limit).
    - `templateVersion` (string · min length: 1 · max length: 32)
      ECF semantic version resolved at launch time, e.g. "1.10.0".
  - `globalRegion` (string)
    Global AWS region from the Service Settings step.
  - `id` (string)
  - `instances` (object[] · max items: 1000)
    Service instances, including duplicates, from the last deployment. Used to restore the service list when an onboarding is resumed.
    - `instanceId` (string · min length: 1 · max length: 255)
      Instance ID: the service ID for an original, `<serviceId>__dup-<n>` for a duplicate.
    - `isDuplicate` (boolean)
      Whether the instance is a duplicate of another service.
    - `name` (string · max length: 255)
      Display name of the instance. Duplicates use the custom name entered when the instance was duplicated.
    - `serviceId` (string · min length: 1 · max length: 255)
      ID of the service this instance belongs to.
  - `integrationName` (string)
    Integration name as entered in the Service settings step, before any per-package suffix is applied.
  - `mechanisms` (enum[] · max items: 10)
    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)
    Package policy IDs created for this deployment (managed_integration and agent_based).
  - `packages` (object[] · max items: 100)
    Packages of the deployment instance package policies with their deployed versions. Empty for ECF-only deployment instances.
    - `name` (string)
      Name of the integration package, for example `aws`.
    - `title` (string)
      Display title of the integration package, for example `AWS`.
    - `version` (string)
      Package version the deployment instance policies run.
  - `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.
    Map values (string · max length: 255)
  - `provider` (enum)
    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.
    Map values (string · max length: 256)
  - `services` (string[] · max items: 1000)
    Service IDs covered by this deployment.
  - `servicesByMethod` (object)
    Service IDs by the delivery mechanism that deploys them.
    - `agent_based` (string[] · max items: 1000)
    - `ecf` (string[] · max items: 1000)
    - `managed_integration` (string[] · max items: 1000)
  - `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)
    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.
- `page` (number)
- `perPage` (number)
- `total` (number)
#### `400`

Bad Request

`application/json`

- `attributes` (object)
- `error` (string)
- `errorType` (string)
- `message` (string)
- `statusCode` (number)
## Code examples

#### Console

```console
GET kbn:/api/fleet/cloud_onboarding_deployments
```

#### curl

```curl
curl -X GET "${KIBANA_URL}/api/fleet/cloud_onboarding_deployments" \
  -H "Authorization: ApiKey ${API_KEY}"
```

## Response examples

#### Get cloud onboarding deployments

`application/json`

Page of cloud onboarding deployment instances that cover the aws package

```json
{
  "items": [
    {
      "agentCount": 1,
      "attemptCount": 1,
      "connectorId": "cloud-connector-id-1",
      "id": "onboarding-deployment-id-1",
      "integrationName": "aws-production",
      "mechanisms": [
        "managed_integration",
        "ecf"
      ],
      "packageNames": [
        "aws"
      ],
      "packagePolicyIds": [
        "package-policy-id-1"
      ],
      "packages": [
        {
          "name": "aws",
          "title": "AWS",
          "version": "8.11.0"
        }
      ],
      "provider": "aws",
      "services": [
        "cloudtrail",
        "vpcflow"
      ],
      "servicesByMethod": {
        "ecf": [
          "vpcflow"
        ],
        "managed_integration": [
          "cloudtrail"
        ]
      },
      "status": "succeeded",
      "updatedAt": "2026-10-20T10:15:00.000Z",
      "updatedBy": "elastic"
    }
  ],
  "page": 1,
  "perPage": 20,
  "total": 1
}
```

#### Generic error response

`application/json`

Example of a generic error response

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