CRcriblio
groups

Create a Worker Group, Outpost Group, or Edge Fleet

Changed on

Create a new Worker Group, Outpost Group, or Edge Fleet for the specified Cribl product.

post/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 add the Worker Group, Outpost Group, or Edge Fleet to.

Request body

__srcGroupstring

Fleet or group id this entity was inherited from when served by a Config Helper for a child fleet. Present when inherited from parent, including when the child has a local overlay. Omitted when the entity is local and not inherited. Display-only; never persisted.

__srcOverriddenboolean

If true, the child fleet has a local overlay on an inherited entity. Omitted when inherited and unmodified, or when local and not inherited. Display-only; never persisted.

collectorsHaEnabledboolean

Keeps Collector jobs running if the Leader Node fails. Applies only to Stream Worker Groups. Always <code>true</code> for Cribl.Cloud groups; defaults to <code>false</code> for on-prem groups. to Stream Worker Groups. Always <code>true</code> for Cribl.Cloud groups; defaults to <code>false</code> for on-prem groups.

descriptionstring

Brief description of the Worker Group, Outpost Group, or Edge Fleet.

estimatedIngestRate1024 | 2048 | 3072 | 4096 | 5120 | 7168 | 10240 | 13312 | 15360

Estimated ingest rate for a Cribl.Cloud Worker Group, in GB/sec.

idstring required

Unique identifier.

inheritsstring

The <code>id</code> of the parent Edge Fleet. If provided, this Fleet inherits configuration from the specified parent Fleet. Applies only to Edge Fleets.

isFleetboolean

Indicates whether this is an Edge Fleet. Deprecated. Use to identify Edge Fleets.

isSearchboolean

Indicates whether this is an internal Search Group. Deprecated. Use to identify Search Groups.

maxWorkerAgestring

Maximum duration a Worker or Node can remain disconnected before the Leader removes it. The value is a numeral with units, such as <code>8h</code>, <code>5d</code>, <code>1w</code>.

namestring

Name of the Worker Group, Outpost Group, or Edge Fleet.

onPremboolean

If <code>true</code>, the Worker Group, Outpost Group, or Edge Fleet uses customer-hosted (on-prem) workers. If <code>false</code>, the Worker Group, Outpost Group, or Edge Fleet is managed in Cribl.Cloud.

provisionedboolean

If <code>true</code>, the Cribl.Cloud Worker Group has active Workers provisioned. Applies only to Cribl.Cloud Worker Groups.

sourceGroupIdstring

The <code>id</code> of an existing Worker Group, Outpost Group, or Edge Fleet to copy configuration from when creating a new Group or Fleet.

streamtagsstring[]

Metadata tags attached to the Worker Group, Outpost Group, or Edge Fleet for categorization, filtering, and tag-based routing and policy application. Useful for organizing Groups and Fleets and enabling tag-driven workflows in Cribl.

tagsstring

Legacy system-level tags associated with the Worker Group, Outpost Group, or Edge Fleet. Use <code>streamtags</code> instead.

type'edge' | 'lake_access' | 'local_search' | 'outpost' | 'search' | 'stream'

Explicit type of the Worker Group, Outpost Group, or Edge Fleet.

upgradeVersionstring

Target software upgrade version. Applies only to Outpost Groups and Edge Fleets.

workerRemoteAccessboolean

If <code>true</code>, the Leader allows remote access (teleporting) into the Workers or Nodes of the Worker Group, Outpost Group, or Edge Fleet.

Example request

{
  "estimatedIngestRate": 4096
}

Response

The created 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 new optional request property

    • info

      added the new optional request property

    • 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