Get cloud connector usage (package policies using the connector) Technical Preview; added in 9.2.0

GET /api/fleet/cloud_connectors/{cloudConnectorId}/usage
Api key auth Basic auth

Spaces method and path for this operation:

get /s/{space_id}/api/fleet/cloud_connectors/{cloudConnectorId}/usage

Refer to Spaces for more information.

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

Path parameters

  • cloudConnectorId string Required

    The unique identifier of the cloud connector.

Query parameters

  • page number

    The page number for pagination.

    Minimum value is 1.

  • perPage number

    The number of items per page.

    Minimum value is 1.

Responses

  • 200 application/json

    OK: A successful request.

    Hide response attributes Show response attributes object
    • items array[object] Required
      Hide items attributes Show items attributes object
      • created_at string Required
      • id string Required
      • name string Required
      • package object

        Additional properties are NOT allowed.

        Hide package attributes Show package attributes object
        • name string Required
        • title string Required
        • version string Required
      • policy_ids array[string] Required
      • updated_at string Required
    • page number Required
    • perPage number Required
    • total number Required
  • 400 application/json

    A bad request.

    Hide response attributes Show response attributes object
    • error string
    • errorType string
    • message string Required
    • statusCode number
GET /api/fleet/cloud_connectors/{cloudConnectorId}/usage 
curl \
 --request GET 'https://localhost:5601/api/fleet/cloud_connectors/{cloudConnectorId}/usage' \
 --header "Authorization: $API_KEY"
Response examples (200)
Example response showing package policies using the cloud connector 
{
  "page": 1,
  "items": [
    {
      "id": "package-policy-1",
      "name": "CSPM AWS Policy",
      "package": {
        "name": "cloud_security_posture",
        "title": "Cloud Security Posture Management",
        "version": "3.1.1"
      },
      "created_at": "2025-01-16T09:00:00.000Z",
      "policy_ids": [
        "policy-id-123",
        "policy-id-456"
      ],
      "updated_at": "2025-01-16T09:00:00.000Z"
    }
  ],
  "total": 2,
  "perPage": 20
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "Cloud connector not found",
  "statusCode": 400
}