Sign in

v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-011189403.1 MB
groups

Update a Worker Group, Outpost Group, or Edge Fleet

Update the specified Worker Group, Outpost Group, or Edge Fleet.<br/><br/>Provide a complete representation of the Group or Fleet that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Group or Fleet.<br/><br/>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Group or Fleet might not function as expected.<br/><br/>Warning: Do not change the values for the following parameters in the body of PATCH requests. The request body must include the values as they appear in the <code>GET /products/{product}/groups/{id}</code> response.<br/> - <code>configVersion</code><br/> - <code>deployingWorkerCount</code><br/> - <code>incompatibleWorkerCount</code><br/> - <code>workerCount</code><br/> - <code>lookupDeployments</code>.

patch/products/{product}/groups/{id}

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

Request body

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.

configVersionstring

Commit hash of the deployed configuration version for the Worker Group, Outpost Group, or Edge Fleet. Automatically populated and returned in responses.<br/><br/> Warning: Do not change the value of <code>configVersion</code> in the body of PATCH requests. The PATCH request body must include the value as it appears in the <code>GET /products/{product}/groups/{id}</code> response.

deployingWorkerCountinteger

Number of Workers or Nodes that are currently deploying the latest configuration version.<br/><br/> Warning: Do not change the value of <code>deployingWorkerCount</code> in the body of PATCH requests. The PATCH request body must include the value as it appears in the <code>GET /products/{product}/groups/{id}</code> response.

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.

incompatibleWorkerCountinteger

Number of Workers or Nodes running a Cribl version that is incompatible with the current upgrade target.<br/><br/> Warning: Do not change the value of <code>incompatibleWorkerCount</code> in the body of PATCH requests. The PATCH request body must include the value as it appears in the <code>GET /products/{product}/groups/{id}</code> response.

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.

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.

workerCountinteger

Number of Workers or Nodes currently in the Worker Group, Outpost Group, or Edge Fleet. The value is automatically populated and does not scale Cribl.Cloud Worker Groups. Use <code>estimatedIngestRate</code> to scale Cribl.Cloud Worker Groups. <br/><br/> Warning: Do not change the value of <code>workerCount</code> in the body of PATCH requests. The PATCH request body must include the value as it appears in the <code>GET /products/{product}/groups/{id}</code> response.

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 updated ConfigGroup object in a single-item list.

countinteger required

number of items present in the items array

Example response

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