Create cloud onboarding deployment

Base URL: https://{kibana_url}

POST /api/fleet/cloud_onboarding_deployments

Create a new Fleet cloud onboarding deployment.

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>

Header parameters

Request body

Responses

Successful response

application/json

item object required

Bad Request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Create a new AWS cloud onboarding deployment using an Elastic Agent (agent-based)

Console Kibana Dev Tools

POST kbn:/api/fleet/cloud_onboarding_deployments
{
  "connectorId": "cloud-connector-id-1",
  "mechanisms": [
    "agent_based"
  ],
  "provider": "aws",
  "services": [
    "cloudwatch_metrics"
  ],
  "serviceVars": {
    "cloudwatch_metrics": {
      "namespace": "AWS/EC2",
      "regions": [
        "us-east-1"
      ]
    }
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/cloud_onboarding_deployments" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "connectorId": "cloud-connector-id-1",
    "mechanisms": [
      "agent_based"
    ],
    "provider": "aws",
    "services": [
      "cloudwatch_metrics"
    ],
    "serviceVars": {
      "cloudwatch_metrics": {
        "namespace": "AWS/EC2",
        "regions": [
          "us-east-1"
        ]
      }
    }
  }'

Generated from the API spec

Response

Agent-based deployment — agentPolicyId set after the agent policy is selected or created

{
  "item": {
    "agentPolicyId": "agent-policy-id-1",
    "attemptCount": 1,
    "connectorId": "cloud-connector-id-1",
    "id": "onboarding-deployment-id-2",
    "mechanisms": [
      "agent_based"
    ],
    "provider": "aws",
    "services": [
      "cloudwatch_metrics"
    ],
    "serviceVars": {
      "cloudwatch_metrics": {
        "namespace": "AWS/EC2",
        "regions": [
          "us-east-1"
        ]
      }
    },
    "status": "pending"
  }
}

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

Request Console 1 / 2 languages

Create a new AWS cloud onboarding deployment using Elastic Cloud Forwarder (ECF)

Console Kibana Dev Tools

POST kbn:/api/fleet/cloud_onboarding_deployments
{
  "connectorId": "cloud-connector-id-1",
  "mechanisms": [
    "ecf"
  ],
  "provider": "aws",
  "services": [
    "cloudfront_logs"
  ],
  "serviceVars": {
    "cloudfront_logs": {
      "regions": [
        "us-east-1"
      ],
      "s3_bucket_arn": "arn:aws:s3:::my-cloudfront-bucket"
    }
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/cloud_onboarding_deployments" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "connectorId": "cloud-connector-id-1",
    "mechanisms": [
      "ecf"
    ],
    "provider": "aws",
    "services": [
      "cloudfront_logs"
    ],
    "serviceVars": {
      "cloudfront_logs": {
        "regions": [
          "us-east-1"
        ],
        "s3_bucket_arn": "arn:aws:s3:::my-cloudfront-bucket"
      }
    }
  }'

Generated from the API spec

Response

Agent-based deployment — agentPolicyId set after the agent policy is selected or created

{
  "item": {
    "agentPolicyId": "agent-policy-id-1",
    "attemptCount": 1,
    "connectorId": "cloud-connector-id-1",
    "id": "onboarding-deployment-id-2",
    "mechanisms": [
      "agent_based"
    ],
    "provider": "aws",
    "services": [
      "cloudwatch_metrics"
    ],
    "serviceVars": {
      "cloudwatch_metrics": {
        "namespace": "AWS/EC2",
        "regions": [
          "us-east-1"
        ]
      }
    },
    "status": "pending"
  }
}

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

Request Console 1 / 2 languages

Create a new AWS cloud onboarding deployment using identity federation (managed integration)

Console Kibana Dev Tools

POST kbn:/api/fleet/cloud_onboarding_deployments
{
  "connectorId": "cloud-connector-id-1",
  "mechanisms": [
    "managed_integration"
  ],
  "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"
      ]
    }
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/cloud_onboarding_deployments" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "connectorId": "cloud-connector-id-1",
    "mechanisms": [
      "managed_integration"
    ],
    "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"
        ]
      }
    }
  }'

Generated from the API spec

Response

Agent-based deployment — agentPolicyId set after the agent policy is selected or created

{
  "item": {
    "agentPolicyId": "agent-policy-id-1",
    "attemptCount": 1,
    "connectorId": "cloud-connector-id-1",
    "id": "onboarding-deployment-id-2",
    "mechanisms": [
      "agent_based"
    ],
    "provider": "aws",
    "services": [
      "cloudwatch_metrics"
    ],
    "serviceVars": {
      "cloudwatch_metrics": {
        "namespace": "AWS/EC2",
        "regions": [
          "us-east-1"
        ]
      }
    },
    "status": "pending"
  }
}

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

Required authorization

Authentication

Header parameters

Request body { }

Responses

Request body