CRcriblio
groups

Get a Worker Group, Outpost Group, or Edge Fleet

Changed on

Get the specified Worker Group, Outpost Group, or Edge Fleet.

get/products/{product}/groups/{id}

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.

idstring required

The <code>id</code> of the Worker Group, Outpost Group, or Edge Fleet to get.

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>.

Response

The requested ConfigGroup object in a single-item list.

countinteger required

Number of items returned in the items array.

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