sources

List the status of all Sources within a Pack

Changed on

List status information and optional metrics for all configured Sources in the Worker Group or Edge Fleet within the specified Pack.

get/p/{pack}/system/status/inputs

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: https://login.cribl.cloud/oauth/token

Path parameters

packstring required

The <code>id</code> of the Pack.

Query parameters

metricsboolean

Set to <code>true</code> to include metrics for each Source. Otherwise, <code>false</code> (default).

typeboolean

Set to <code>true</code> to prefix the Source <code>id</code> with the Source type. Otherwise, <code>false</code> (default).

offsetinteger

Starting point from which to retrieve results for this request. Use with <code>limit</code> to paginate the response into manageable batches.

limitinteger

Maximum number of items to return in the response for this request. Use with <code>offset</code> to paginate the response into manageable batches.

Response

List of Source status objects.

countinteger required

Number of items returned in the items array.

offsetinteger

Pagination offset. Returned when offset/limit query parameters are provided.

limitinteger

Pagination limit. Returned when offset/limit query parameters are provided.

totalCountinteger

Total number of items available. Returned when offset/limit query parameters are provided.

Changes

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the non-success response with the status