Get cloud onboarding deployment

Base URL: https://{kibana_url}

GET /api/fleet/cloud_onboarding_deployments/{id}

Get a cloud onboarding deployment by 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

item object required

Bad Request

application/json

Not Found

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/cloud_onboarding_deployments/ID

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

A cloud onboarding deployment that has succeeded

{
  "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"
    ],
    "serviceVars": {
      "cloudtrail": [
        {
          "regions": [
            "us-east-1"
          ],
          "s3_bucket_arn": "arn:aws:s3:::my-cloudtrail-bucket"
        }
      ],
      "cloudwatch_metrics": [
        {
          "namespace": "AWS/EC2",
          "regions": [
            "us-east-1",
            "eu-west-1"
          ]
        }
      ]
    },
    "status": "succeeded"
  }
}

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