Get cloud onboarding deployments by connector ID

Base URL: https://{kibana_url}

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

List all cloud onboarding deployments for a given connector ID.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Responses

Successful response

application/json

items object[] · max items: 100 required

Bad Request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/cloud_onboarding_deployments/connector/CONNECTOR_ID

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

List of cloud onboarding deployments for a connector

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

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