CRcriblio
groups

List all Worker Groups, Outpost Groups, or Edge Fleets

Changed on

Get a list of all Worker Groups, Outpost Groups, or Edge Fleets for the specified Cribl product.

get/products/{product}/groups

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' | 'outpost' required

Name of the Cribl product to get the Worker Groups, Outpost Groups, or Edge Fleets for.

Query parameters

fieldsstring

Comma-separated list of additional properties to include in the response. Available values are <code>git.commit</code>, <code>git.localChanges</code>, and <code>git.log</code>.

limitinteger

Maximum number of Worker Groups, Outpost Groups, or Edge Fleets to return in the response for this request. Use with <code>offset</code> to paginate the response into manageable batches.

offsetinteger

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

Response

List of ConfigGroup 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.

Example response

{
  "items": [
    {
      "estimatedIngestRate": 4096
    }
  ]
}

Changes

  • fd542bb248a2Revision changes
    • info

      added the optional property ///// to the response with the status

  • 3816b6fddba1Revision changes
    • 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