CRcriblio
distributed

Get a summary of the deployment for a Cribl product

Changed on

Get a summary of the deployment for the specified Cribl product (Stream or Edge).<br/><br/>The summary includes a count of Worker Groups or Edge Fleets and resources such as Pipelines, Routes, Sources, and Destinations. For Distributed deployments, the summary also includes a count and statistics for Worker or Edge Nodes.

get/products/{product}/summary

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

product'stream' | 'edge' required

Name of the Cribl product to get the summary for.

Query parameters

offsetinteger

Pagination offset

limitinteger

Maximum number of items to return

Response

List of DistributedSummary 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

  • e9bef570d106Revision changes
    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • 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

  • 484cda0ad459Revision changes
    • breaking

      the response property // became optional for the status