Query parameters

• perPage integer

  The number of items to return

  Default value is 20.

• page integer

  Default value is 1.

• kuery string
• showInactive boolean
• showUpgradeable boolean
• sortField string Deprecated
• sortOrder string

  Values are asc or desc.

• withMetrics boolean

  Return agent metrics, false by default

• getStatusSummary boolean

Responses

• 200 application/json; Elastic-Api-Version=2023-10-31

  OK

  Hide response attributes Show response attributes object

  • items array[object] Required
    Hide items attributes Show items attributes object

    • access_api_key string
    • access_api_key_id string
    • active boolean Required
    • components array[object]
      Hide components attributes Show components attributes object

      • id string
      • message string
      • status string

        Values are starting, configuring, healthy, degraded, failed, stopping, or stopped.

      • type string
      • units array[object]
        Hide units attributes Show units attributes object

        • id string
        • message string
        • payload object
        • status string

          Values are starting, configuring, healthy, degraded, failed, stopping, or stopped.

        • type string

          Values are input or output.

    • default_api_key string
    • default_api_key_id string
    • enrolled_at string Required
    • id string Required
    • last_checkin string
    • local_metadata object
    • metrics object
      Hide metrics attributes Show metrics attributes object

      • cpu_avg number

        Average agent CPU usage during the last 5 minutes, number between 0-1

      • memory_size_byte_avg number

        Average agent memory consumption during the last 5 minutes

    • policy_id string
    • policy_revision number
    • status string Required

      Values are offline, error, online, inactive, or warning.

    • type string Required

      Values are PERMANENT, EPHEMERAL, or TEMPORARY.

    • unenrolled_at string
    • unenrollment_started_at string
    • user_provided_metadata object
  • list array[object] Deprecated
    Hide list attributes Show list attributes object

    • access_api_key string
    • access_api_key_id string
    • active boolean Required
    • components array[object]
      Hide components attributes Show components attributes object

      • id string
      • message string
      • status string

        Values are starting, configuring, healthy, degraded, failed, stopping, or stopped.

      • type string
      • units array[object]
        Hide units attributes Show units attributes object

        • id string
        • message string
        • payload object
        • status string

          Values are starting, configuring, healthy, degraded, failed, stopping, or stopped.

        • type string

          Values are input or output.

    • default_api_key string
    • default_api_key_id string
    • enrolled_at string Required
    • id string Required
    • last_checkin string
    • local_metadata object
    • metrics object
      Hide metrics attributes Show metrics attributes object

      • cpu_avg number

        Average agent CPU usage during the last 5 minutes, number between 0-1

      • memory_size_byte_avg number

        Average agent memory consumption during the last 5 minutes

    • policy_id string
    • policy_revision number
    • status string Required

      Values are offline, error, online, inactive, or warning.

    • type string Required

      Values are PERMANENT, EPHEMERAL, or TEMPORARY.

    • unenrolled_at string
    • unenrollment_started_at string
    • user_provided_metadata object
  • page number Required
  • perPage number Required
  • statusSummary object
    Hide statusSummary attributes Show statusSummary attributes object

    • degraded' number
    • enrolling number
    • error number
    • inactive number
    • offline number
    • online number
    • unenrolled number
    • unenrolling number
    • updating number
  • total number Required
• 400 application/json; Elastic-Api-Version=2023-10-31

  Generic Error

  Hide response attributes Show response attributes object

  • error string
  • message string
  • statusCode number