Get remote synced integrations status by outputId Generally available; added in 9.1.0

GET /api/fleet/remote_synced_integrations/{outputId}/remote_status
Api key auth Basic auth

Spaces method and path for this operation:

get /s/{space_id}/api/fleet/remote_synced_integrations/{outputId}/remote_status

Refer to Spaces for more information.

Get the synchronization status of remote integrations for a specific output by its ID.

[Required authorization] Route required privileges: fleet-settings-read AND integrations-read.

Path parameters

  • outputId string Required

    The ID of the output

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • custom_assets object
      Hide custom_assets attribute Show custom_assets attribute object
      • * object Additional properties

        Additional properties are NOT allowed.

        Hide * attributes Show * attributes object
        • error string
        • is_deleted boolean
        • name string Required
        • package_name string Required
        • package_version string Required
        • sync_status string Required

          Values are completed, synchronizing, failed, or warning.

        • type string Required
        • warning object

          Additional properties are NOT allowed.

          Hide warning attributes Show warning attributes object
          • message string
          • title string Required
    • error string
    • integrations array[object] Required

      Not more than 10000 elements.

      Hide integrations attributes Show integrations attributes object
      • error string
      • id string
      • install_status object Required

        Additional properties are NOT allowed.

        Hide install_status attributes Show install_status attributes object
        • main string Required
        • remote string
      • package_name string
      • package_version string
      • sync_status string Required

        Values are completed, synchronizing, failed, or warning.

      • updated_at string
      • warning object

        Additional properties are NOT allowed.

        Hide warning attributes Show warning attributes object
        • message string
        • title string Required
    • warning object

      Additional properties are NOT allowed.

      Hide warning attributes Show warning attributes object
      • message string
      • title string Required
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • attributes Required
    • error string
    • errorType string
    • message string Required
    • statusCode number
GET /api/fleet/remote_synced_integrations/{outputId}/remote_status 
curl \
 --request GET 'https://localhost:5601/api/fleet/remote_synced_integrations/{outputId}/remote_status' \
 --header "Authorization: $API_KEY"
Response examples (200)
Synchronization status of remote integrations for a specific output 
{
  "integrations": [
    {
      "id": "nginx-remote",
      "install_status": {
        "main": "installed",
        "remote": "installed"
      },
      "package_name": "nginx",
      "package_version": "1.20.0",
      "sync_status": "COMPLETED",
      "updated_at": "2024-01-01T00:00:00.000Z"
    }
  ]
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}