Create cloud connector Experimental; added in 9.2.0

POST /api/fleet/cloud_connectors
Api key auth Basic auth

Spaces method and path for this operation:

post /s/{space_id}/api/fleet/cloud_connectors

Refer to Spaces for more information.

Create a new Fleet cloud connector.

[Required authorization] Route required privileges: fleet-agent-policies-all OR integrations-all.

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

application/json

Body

  • accountType string

    The account type: single-account (single account/subscription) or organization-account (organization-wide).

    Values are single-account or organization-account.

  • cloudProvider string Required

    The cloud provider type: aws, azure, or gcp.

    Values are aws, azure, or gcp.

  • iac_blueprint_id string | null Experimental; added in 9.6.0

    Identifier of the template source last used for this connector. Set to null to remove it.

    Minimum length is 1, maximum length is 255.

  • iac_blueprint_version string | null Experimental; added in 9.6.0

    Version of the template source last used for this connector. Set to null to remove it.

    Minimum length is 1, maximum length is 64.

  • iac_deployment_id string Experimental; added in 9.6.0

    ARN of the last CloudFormation stack deployed for this connector (arn:<partition>:cloudformation:<region>:<account>:stack/<name>/<id>).

    Minimum length is 1, maximum length is 2048.

  • iac_key string | null Experimental; added in 9.6.0

    Checksum of the CloudFormation template last saved on this connector. Set to null to remove it.

    Minimum length is 1, maximum length is 512.

  • name string Required

    The name of the cloud connector.

    Minimum length is 1, maximum length is 255.

  • vars object Required

Responses

  • 200 application/json

    Successful response

    Hide response attribute Show response attribute object
    • item object Required

      Additional properties are NOT allowed.

      Hide item attributes Show item attributes object
      • accountType string
      • cloudProvider string Required
      • created_at string Required
      • iac_blueprint_id string | null Experimental; added in 9.6.0

        Identifier of the template source last used for this connector. Set to null to remove it.

        Minimum length is 1, maximum length is 255.

      • iac_blueprint_version string | null Experimental; added in 9.6.0

        Version of the template source last used for this connector. Set to null to remove it.

        Minimum length is 1, maximum length is 64.

      • iac_deployment_id string Experimental; added in 9.6.0

        ARN of the last CloudFormation stack deployed for this connector (arn:<partition>:cloudformation:<region>:<account>:stack/<name>/<id>).

        Minimum length is 1, maximum length is 2048.

      • iac_key string | null Experimental; added in 9.6.0

        Checksum of the CloudFormation template last saved on this connector. Set to null to remove it.

        Minimum length is 1, maximum length is 512.

      • iac_upgrade_checked_at string Experimental; added in 9.6.0

        When this connector was last checked for a CloudFormation template upgrade.

      • iac_upgrade_status string Experimental; added in 9.6.0

        Whether a newer CloudFormation template is available for this connector.

        Values are up_to_date or upgrade_available.

      • id string Required
      • name string Required
      • namespace string
      • packagePolicyCount number Required
      • updated_at string Required
      • vars object Required
      • verification_failed_at string
      • verification_started_at string
      • verification_status string
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • attributes Required
    • error string
    • errorType string
    • message string Required
    • statusCode number
POST /api/fleet/cloud_connectors 
curl \
 --request POST 'https://localhost:5601/api/fleet/cloud_connectors' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{
  "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": {}
}'
Request example
Create a new AWS cloud connector 
{
  "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": {}
}
Response examples (200)
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": {}
  }
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}