---
title: "Update a Worker Group, Outpost Group, or Edge Fleet"
method: PATCH
path: "/products/{product}/groups/{id}"
tags: ["groups"]
---

# Update a Worker Group, Outpost Group, or Edge Fleet

`PATCH /products/{product}/groups/{id}`

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

## Path parameters

- `product` 'stream' | 'edge' | 'outpost', required
- `id` string, required

## Request body

- ConfigGroup — Configuration settings and dynamic status for a Worker Group, Outpost Group, or Edge Fleet.
  - `cloud` ConfigGroupCloud
    - `provider` 'aws' | 'azure' | 'null', nullable, required
    - `region` string, required — Cloud region where the Worker Group is deployed.
  - `collectorsHaEnabled` boolean — 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.
  - `configVersion` string — 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.
  - `deployingWorkerCount` integer — 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.
  - `description` string — Brief description of the Worker Group, Outpost Group, or Edge Fleet.
  - `estimatedIngestRate` 1024 | 2048 | 3072 | 4096 | 5120 | 7168 | 10240 | 13312 | 15360 — Estimated ingest rate for a Cribl.Cloud Worker Group, in GB/sec.
  - `git` object — Git status of the Worker Group, Outpost Group, or Edge Fleet configuration. Automatically populated and returned in responses.
    - `commit` string — Commit hash of the currently committed configuration version.
    - `localChanges` integer — Number of local configuration changes not yet committed.
    - `log` Commit[] — List of recent configuration commits.
      - `author_email` string — Email address of the commit author.
      - `author_name` string — Name of the commit author.
      - `date` string, required — Date and time of the commit.
      - `hash` string, required — Full commit hash.
      - `message` string, required — Commit message.
      - `short` string, required — Abbreviated commit hash.
  - `id` string, required — Unique identifier.
  - `incompatibleWorkerCount` integer — 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.
  - `inherits` string — 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.
  - `isFleet` boolean — Indicates whether this is an Edge Fleet. Deprecated. Use to identify Edge Fleets.
  - `isSearch` boolean — Indicates whether this is an internal Search Group. Deprecated. Use to identify Search Groups.
  - `lookupDeployments` ConfigGroupLookups[] — Lookup deployment status per Worker or Node context.<br/><br/> **Warning**: Do not change the value of <code>lookupDeployments</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.
    - `context` string, required — The Worker or Node context for the lookup deployment.
    - `lookups` object[], required — List of lookup files deployed to this context.
      - `deployedVersion` string — Version of the lookup file currently deployed on the Worker or Node.
      - `file` string, required — File name of the deployed lookup.
      - `version` string — Version of the lookup file currently staged for deployment.
  - `maxWorkerAge` string — 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>.
  - `name` string — Name of the Worker Group, Outpost Group, or Edge Fleet.
  - `onPrem` boolean — 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.
  - `provisioned` boolean — If <code>true</code>, the Cribl.Cloud Worker Group has active Workers provisioned. Applies only to Cribl.Cloud Worker Groups.
  - `streamtags` string[] — 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.
  - `tags` string — 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.
  - `upgradeVersion` string — Target software upgrade version. Applies only to Outpost Groups and Edge Fleets.
  - `workerCount` integer — 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.
  - `workerRemoteAccess` boolean — If <code>true</code>, the Leader allows remote access (teleporting) into the Workers or Nodes of the Worker Group, Outpost Group, or Edge Fleet.

## Response `200`

The updated ConfigGroup object in a single-item list.

- CountedConfigGroup
  - `count` integer, required — number of items present in the items array
  - `items` ConfigGroup[], required — List of items in this response.
    - `cloud` ConfigGroupCloud
      - `provider` 'aws' | 'azure' | 'null', nullable, required
      - `region` string, required — Cloud region where the Worker Group is deployed.
    - `collectorsHaEnabled` boolean — 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.
    - `configVersion` string — 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.
    - `deployingWorkerCount` integer — 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.
    - `description` string — Brief description of the Worker Group, Outpost Group, or Edge Fleet.
    - `estimatedIngestRate` 1024 | 2048 | 3072 | 4096 | 5120 | 7168 | 10240 | 13312 | 15360 — Estimated ingest rate for a Cribl.Cloud Worker Group, in GB/sec.
    - `git` object — Git status of the Worker Group, Outpost Group, or Edge Fleet configuration. Automatically populated and returned in responses.
      - `commit` string — Commit hash of the currently committed configuration version.
      - `localChanges` integer — Number of local configuration changes not yet committed.
      - `log` Commit[] — List of recent configuration commits.
        - `author_email` string — Email address of the commit author.
        - `author_name` string — Name of the commit author.
        - `date` string, required — Date and time of the commit.
        - `hash` string, required — Full commit hash.
        - `message` string, required — Commit message.
        - `short` string, required — Abbreviated commit hash.
    - `id` string, required — Unique identifier.
    - `incompatibleWorkerCount` integer — 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.
    - `inherits` string — 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.
    - `isFleet` boolean — Indicates whether this is an Edge Fleet. Deprecated. Use to identify Edge Fleets.
    - `isSearch` boolean — Indicates whether this is an internal Search Group. Deprecated. Use to identify Search Groups.
    - `lookupDeployments` ConfigGroupLookups[] — Lookup deployment status per Worker or Node context.<br/><br/> **Warning**: Do not change the value of <code>lookupDeployments</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.
      - `context` string, required — The Worker or Node context for the lookup deployment.
      - `lookups` object[], required — List of lookup files deployed to this context.
        - `deployedVersion` string — Version of the lookup file currently deployed on the Worker or Node.
        - `file` string, required — File name of the deployed lookup.
        - `version` string — Version of the lookup file currently staged for deployment.
    - `maxWorkerAge` string — 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>.
    - `name` string — Name of the Worker Group, Outpost Group, or Edge Fleet.
    - `onPrem` boolean — 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.
    - `provisioned` boolean — If <code>true</code>, the Cribl.Cloud Worker Group has active Workers provisioned. Applies only to Cribl.Cloud Worker Groups.
    - `streamtags` string[] — 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.
    - `tags` string — 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.
    - `upgradeVersion` string — Target software upgrade version. Applies only to Outpost Groups and Edge Fleets.
    - `workerCount` integer — 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.
    - `workerRemoteAccess` boolean — If <code>true</code>, the Leader allows remote access (teleporting) into the Workers or Nodes of the Worker Group, Outpost Group, or Edge Fleet.

## Other responses

- `400` — Failed validation or malformed input — Invalid update payload, including read-only field mutations or invalid cloud/on-prem configuration.
- `401` — Authentication failed (missing or invalid credentials or Bearer token).
- `500` — Unexpected server error.

---

[API](https://skmtc.dev/criblio/apis/cribl-api-reference.md) · [All operations](https://skmtc.dev/criblio/apis/cribl-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/criblio/cribl-api-reference/revisions/56cb25079271/schema)