Create cloud connector

Base URL: https://{kibana_url}

POST /api/fleet/cloud_connectors

Create a new Fleet cloud connector.

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

Bad Request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Create a new AWS cloud connector

Console Kibana Dev Tools

POST kbn:/api/fleet/cloud_connectors
{
  "accountType": "single-account",
  "cloudProvider": "aws",
  "iac_blueprint_id": "federated-identity",
  "iac_blueprint_version": "1.0.0",
  "iac_deployment_id": "arn:aws:cloudformation:us-east-1:123456789012:stack/elastic-aws-connector/abc",
  "iac_key": "sha256:661cb7def1c7101f",
  "name": "My AWS connector",
  "vars": {}
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/cloud_connectors" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "accountType": "single-account",
    "cloudProvider": "aws",
    "iac_blueprint_id": "federated-identity",
    "iac_blueprint_version": "1.0.0",
    "iac_deployment_id": "arn:aws:cloudformation:us-east-1:123456789012:stack/elastic-aws-connector/abc",
    "iac_key": "sha256:661cb7def1c7101f",
    "name": "My AWS connector",
    "vars": {}
  }'

Generated from the API spec

Response

The created Fleet cloud connector

{
  "item": {
    "accountType": "single-account",
    "cloudProvider": "aws",
    "created_at": "2024-01-15T10:00:00.000Z",
    "iac_blueprint_id": "federated-identity",
    "iac_blueprint_version": "1.0.0",
    "iac_deployment_id": "arn:aws:cloudformation:us-east-1:123456789012:stack/elastic-aws-connector/abc",
    "iac_key": "sha256:661cb7def1c7101f",
    "iac_upgrade_checked_at": "2024-01-15T10:00:00.000Z",
    "iac_upgrade_status": "up_to_date",
    "id": "cloud-connector-id-2",
    "name": "My AWS connector",
    "packagePolicyCount": 0,
    "updated_at": "2024-01-15T10:00:00.000Z",
    "vars": {}
  }
}

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

Required authorization

Authentication

Header parameters

Request body { }

Responses

Request body