---
type: api
title: Get cloud onboarding deployments by connector ID
description: List all cloud onboarding deployments for a given connector ID.<br/><br/>[Required authorization] Route required privileges: fleet-agent-policies-read OR integrations-read.
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/v0/operation/operation-get-fleet-cloud-onboarding-deployments-connector-connectorid
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/v0/operation/operation-get-fleet-cloud-onboarding-deployments-connector-connectorid
products:
  - Kibana
---

# Get cloud onboarding deployments by connector ID

Availability: 9.5+

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

## Paths

- `GET` `/api/fleet/cloud_onboarding_deployments/connector/{connectorId}`

- [Api key auth](/elastic/docs-builder/docs/4371/api/doc/kibana/v0/authentication#apikeyauth)
- [Basic auth](/elastic/docs-builder/docs/4371/api/doc/kibana/v0/authentication#basicauth)

#### Path Parameters

- `connectorId` (string · min: 1)
  The fleet-cloud-connector ID to list deployments for.

## Description

List all cloud onboarding deployments for a given connector ID.<br/><br/>[Required authorization] Route required privileges: fleet-agent-policies-read OR integrations-read.

## Responses

#### `200`

Successful response

`application/json`

- `items` ([] object · max: 100)
  - `agentPolicyId` (string)
    Agent policy ID created for agent-based deployments. Present only when agent_based is in mechanisms.
  - `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 for managed integrations.
    Values: `identity_federation`, `static_keys`
  - `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.
  - `ecfStacks` ([] object · max: 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`
    - `stackName` (string · min: 1 · max: 128)
      CloudFormation stack name (128-char AWS limit).
    - `templateVersion` (string · min: 1 · max: 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)
  - `mechanisms` ([] enum  · max: 10)
    Values: `managed_integration`, `ecf`, `agent_based`
  - `packagePolicyIds` ([] string · max: 100)
    Package policy IDs created for managed_integration services.
  - `provider` (enum)
    Cloud provider.
    Values: `aws`, `azure`, `gcp`
  - `services` ([] string · max: 1000)
    Service IDs covered by this deployment.
  - `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.
#### `400`

Bad Request

`application/json`

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

#### Console

```console
GET /api/fleet/cloud_onboarding_deployments/connector/{connectorId}
```

#### curl

```curl
curl -X GET "https://{kibana_url}/api/fleet/cloud_onboarding_deployments/connector/{connectorId}"
```

## Response Examples

#### Get cloud onboarding deployments by connector id

List of cloud onboarding deployments for a connector

```json
{
  "items": [
    {
      "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"
      ],
      "status": "succeeded"
    },
    {
      "attemptCount": 1,
      "connectorId": "cloud-connector-id-1",
      "id": "onboarding-deployment-id-2",
      "mechanisms": [
        "managed_integration",
        "ecf"
      ],
      "provider": "aws",
      "services": [
        "cloudfront_logs"
      ],
      "serviceVars": {
        "cloudfront_logs": {
          "regions": [
            "us-east-1"
          ],
          "s3_bucket_arn": "arn:aws:s3:::my-cloudfront-logs-bucket"
        }
      },
      "status": "deploying"
    }
  ]
}
```

#### Generic error response

Example of a generic error response

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