Skip to content

Bridge Worker

BridgeWorker represents a bridge worker in ConfigHub. A bridge worker is a worker program that connects ConfigHub to external systems and targets. It acts as a bridge between ConfigHub and the infrastructure where configurations need to be applied. Bridge workers are responsible for executing configuration changes on remote targets and reporting status back to ConfigHub. When starting a bridge worker program, both the BridgeWorkerID and Secret are required for authentication with the ConfigHub server. These credentials allow the bridge worker to establish a secure connection and receive configuration actions.

Operations

Method Endpoint Description
GET /bridge_worker List all BridgeWorker across spaces
GET /space/{space_id}/bridge_worker List BridgeWorkers
GET /space/{space_id}/bridge_worker/{bridge_worker_id}/function List available functions supported by a specific bridge worker
GET /bridge_worker/{bridge_worker_id}/me Gets the current BridgeWorker from context
GET /space/{space_id}/bridge_worker/{bridge_worker_id} Get BridgeWorker
POST /bridge_worker/{bridge_worker_id}/action_result Create action result
POST /bridge_worker/{bridge_worker_id}/stream Stream events to bridge worker
POST /space/{space_id}/bridge_worker Create BridgeWorker
PATCH /bridge_worker Bulk patch multiple bridge workers
PATCH /space/{space_id}/bridge_worker/{bridge_worker_id} Patch BridgeWorker
PUT /space/{space_id}/bridge_worker/{bridge_worker_id} Update BridgeWorker
DELETE /bridge_worker Bulk delete multiple bridge workers
DELETE /space/{space_id}/bridge_worker/{bridge_worker_id} Delete BridgeWorker

List all BridgeWorker across spaces

GET /bridge_worker

List all BridgeWorker across spaces

Operation ID: ListAllBridgeWorkers

Parameters

Query Parameters

Parameter Type Required Description
where string The specified string is an expression for the purpose of filtering the list of BridgeWorkers returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, !~~ for NOT LIKE. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(ApprovedBy) > 0. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on BridgeWorker: BridgeWorkerID, CreatedAt, DisplayName, Labels, OrganizationID, Slug, SpaceID, UpdatedAt, UserID. The whole string must be query-encoded.
contains string Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for BridgeWorker include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include string Include clause for expanding related entities in the response for BridgeWorker. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for BridgeWorker are OrganizationID, SpaceID. The whole string must be query-encoded.
select string Select clause for specifying which fields to include in the response for BridgeWorker. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. If not specified, all fields are returned. Entity and parent IDs (like OrganizationID, SpaceID, BridgeWorkerID) and Slug are always returned regardless of the select parameter. Fields used in where and contains filters are also automatically included. Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. The whole string must be query-encoded.
summary boolean Include summary information in the response

Responses

Status Description Content-Type Schema
200 OK application/json Array of ExtendedBridgeWorker
default application/json Array of ExtendedBridgeWorker

List BridgeWorkers

GET /space/{space_id}/bridge_worker

List BridgeWorkers

Operation ID: ListBridgeWorkers

Parameters

Path Parameters

Parameter Type Required Description
space_id string ✓ Unique identifier for a space_id

Query Parameters

Parameter Type Required Description
where string The specified string is an expression for the purpose of filtering the list of BridgeWorkers returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, !~~ for NOT LIKE. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(ApprovedBy) > 0. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on BridgeWorker: BridgeWorkerID, CreatedAt, DisplayName, Labels, OrganizationID, Slug, SpaceID, UpdatedAt, UserID. The whole string must be query-encoded.
filter string UUID of a Filter entity to apply to the BridgeWorker list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (BridgeWorker). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains string Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for BridgeWorker include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include string Include clause for expanding related entities in the response for BridgeWorker. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for BridgeWorker are OrganizationID, SpaceID. The whole string must be query-encoded.
select string Select clause for specifying which fields to include in the response for BridgeWorker. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. If not specified, all fields are returned. Entity and parent IDs (like OrganizationID, SpaceID, BridgeWorkerID) and Slug are always returned regardless of the select parameter. Fields used in where and contains filters are also automatically included. Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. The whole string must be query-encoded.

Responses

Status Description Content-Type Schema
200 OK application/json Array of ExtendedBridgeWorker
400 BridgeWorker request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 BridgeWorker not found. application/json StandardErrorResponse
500 Something went wrong while processing BridgeWorker. application/json StandardErrorResponse
default application/json Array of ExtendedBridgeWorker

List available functions supported by a specific bridge worker

GET /space/{space_id}/bridge_worker/{bridge_worker_id}/function

List available functions supported by a specific bridge worker

Operation ID: ListBridgeWorkerFunctions

Parameters

Path Parameters

Parameter Type Required Description
space_id string ✓ Unique identifier for a space_id
bridge_worker_id string ✓ Unique identifier for a bridge_worker_id

Responses

Status Description Content-Type Schema
200 OK application/json object
default application/json object

Gets the current BridgeWorker from context

GET /bridge_worker/{bridge_worker_id}/me

Gets the current BridgeWorker from context

Operation ID: GetSelf

Parameters

Path Parameters

Parameter Type Required Description
bridge_worker_id string ✓ Unique identifier for a bridge_worker_id

Responses

Status Description Content-Type Schema
200 BridgeWorker represents a bridge worker in ConfigHub. A bridge worker is a worker program that connects ConfigHub to external systems and targets. It acts as a bridge between ConfigHub and the infrastructure where configurations need to be applied. Bridge workers are responsible for executing configuration changes on remote targets and reporting status back to ConfigHub. When starting a bridge worker program, both the BridgeWorkerID and Secret are required for authentication with the ConfigHub server. These credentials allow the bridge worker to establish a secure connection and receive configuration actions. application/json BridgeWorker
400 BridgeWorker request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 BridgeWorker not found. application/json StandardErrorResponse
500 Something went wrong while processing BridgeWorker. application/json StandardErrorResponse
default BridgeWorker represents a bridge worker in ConfigHub. A bridge worker is a worker program that connects ConfigHub to external systems and targets. It acts as a bridge between ConfigHub and the infrastructure where configurations need to be applied. Bridge workers are responsible for executing configuration changes on remote targets and reporting status back to ConfigHub. When starting a bridge worker program, both the BridgeWorkerID and Secret are required for authentication with the ConfigHub server. These credentials allow the bridge worker to establish a secure connection and receive configuration actions. application/json BridgeWorker

Get BridgeWorker

GET /space/{space_id}/bridge_worker/{bridge_worker_id}

Get BridgeWorker

Operation ID: GetBridgeWorker

Parameters

Path Parameters

Parameter Type Required Description
space_id string ✓ Unique identifier for a space_id
bridge_worker_id string ✓ Unique identifier for a bridge_worker_id

Query Parameters

Parameter Type Required Description
include string Include clause for expanding related entities in the response for BridgeWorker. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for BridgeWorker are OrganizationID, SpaceID. The whole string must be query-encoded.
select string Select clause for specifying which fields to include in the response for BridgeWorker. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. If not specified, all fields are returned. Entity and parent IDs (like OrganizationID, SpaceID, BridgeWorkerID) and Slug are always returned regardless of the select parameter. Fields used in where and contains filters are also automatically included. Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. The whole string must be query-encoded.

Responses

Status Description Content-Type Schema
200 OK application/json ExtendedBridgeWorker
400 BridgeWorker request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 BridgeWorker not found. application/json StandardErrorResponse
500 Something went wrong while processing BridgeWorker. application/json StandardErrorResponse
default application/json ExtendedBridgeWorker

Create action result

POST /bridge_worker/{bridge_worker_id}/action_result

Records the status/result of an action executed by a bridge worker

Operation ID: CreateActionResult

Parameters

Path Parameters

Parameter Type Required Description
bridge_worker_id string ✓ Unique identifier for a bridge_worker_id

Request Body

Content-Type: application/json

Schema: ActionResult

Responses

Status Description Content-Type Schema
200 OK application/json string
400 BridgeWorker request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 BridgeWorker not found. application/json StandardErrorResponse
500 Something went wrong while processing BridgeWorker. application/json StandardErrorResponse
default application/json string

Stream events to bridge worker

POST /bridge_worker/{bridge_worker_id}/stream

Establishes an SSE connection with a bridge worker for real-time event streaming

Operation ID: StreamBridgeWorker

Parameters

Path Parameters

Parameter Type Required Description
bridge_worker_id string ✓ Unique identifier for a bridge_worker_id

Responses

Status Description Content-Type Schema
200 OK text/event-stream EventMessage
400 BridgeWorker request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 BridgeWorker not found. application/json StandardErrorResponse
500 Something went wrong while processing BridgeWorker. application/json StandardErrorResponse
default text/event-stream EventMessage

Create BridgeWorker

POST /space/{space_id}/bridge_worker

Create BridgeWorker

Operation ID: CreateBridgeWorker

Parameters

Path Parameters

Parameter Type Required Description
space_id string ✓ Unique identifier for a space_id

Query Parameters

Parameter Type Required Description
allow_exists string Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity

Request Body

Content-Type: application/json

Schema: BridgeWorker

Responses

Status Description Content-Type Schema
200 BridgeWorker represents a bridge worker in ConfigHub. A bridge worker is a worker program that connects ConfigHub to external systems and targets. It acts as a bridge between ConfigHub and the infrastructure where configurations need to be applied. Bridge workers are responsible for executing configuration changes on remote targets and reporting status back to ConfigHub. When starting a bridge worker program, both the BridgeWorkerID and Secret are required for authentication with the ConfigHub server. These credentials allow the bridge worker to establish a secure connection and receive configuration actions. application/json BridgeWorker
400 BridgeWorker request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 BridgeWorker not found. application/json StandardErrorResponse
500 Something went wrong while processing BridgeWorker. application/json StandardErrorResponse
default BridgeWorker represents a bridge worker in ConfigHub. A bridge worker is a worker program that connects ConfigHub to external systems and targets. It acts as a bridge between ConfigHub and the infrastructure where configurations need to be applied. Bridge workers are responsible for executing configuration changes on remote targets and reporting status back to ConfigHub. When starting a bridge worker program, both the BridgeWorkerID and Secret are required for authentication with the ConfigHub server. These credentials allow the bridge worker to establish a secure connection and receive configuration actions. application/json BridgeWorker

Bulk patch multiple bridge workers

PATCH /bridge_worker

Apply JSON merge patch to multiple bridge workers selected by query parameters

Operation ID: BulkPatchBridgeWorkers

Parameters

Query Parameters

Parameter Type Required Description
where string The specified string is an expression for the purpose of filtering the list of BridgeWorkers returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, !~~ for NOT LIKE. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(ApprovedBy) > 0. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on BridgeWorker: BridgeWorkerID, CreatedAt, DisplayName, Labels, OrganizationID, Slug, SpaceID, UpdatedAt, UserID. The whole string must be query-encoded.
filter string UUID of a Filter entity to apply to the BridgeWorker list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (BridgeWorker). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains string Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for BridgeWorker include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include string Include clause for expanding related entities in the response for BridgeWorker. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for BridgeWorker are OrganizationID, SpaceID. The whole string must be query-encoded.

Request Body

Content-Type: application/merge-patch+json

Responses

Status Description Content-Type Schema
200 OK application/json Array of BridgeWorkerCreateOrUpdateResponse
207 Multi-Status: Mixed success and failure results application/json Array of BridgeWorkerCreateOrUpdateResponse
400 BridgeWorker request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 BridgeWorker not found. application/json StandardErrorResponse
500 Something went wrong while processing BridgeWorker. application/json StandardErrorResponse
default application/json Array of BridgeWorkerCreateOrUpdateResponse

Patch BridgeWorker

PATCH /space/{space_id}/bridge_worker/{bridge_worker_id}

Patch BridgeWorker

Operation ID: PatchBridgeWorker

Parameters

Path Parameters

Parameter Type Required Description
space_id string ✓ Unique identifier for a space_id
bridge_worker_id string ✓ Unique identifier for a bridge_worker_id

Request Body

Content-Type: application/merge-patch+json

Responses

Status Description Content-Type Schema
200 BridgeWorker represents a bridge worker in ConfigHub. A bridge worker is a worker program that connects ConfigHub to external systems and targets. It acts as a bridge between ConfigHub and the infrastructure where configurations need to be applied. Bridge workers are responsible for executing configuration changes on remote targets and reporting status back to ConfigHub. When starting a bridge worker program, both the BridgeWorkerID and Secret are required for authentication with the ConfigHub server. These credentials allow the bridge worker to establish a secure connection and receive configuration actions. application/json BridgeWorker
400 BridgeWorker request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 BridgeWorker not found. application/json StandardErrorResponse
500 Something went wrong while processing BridgeWorker. application/json StandardErrorResponse
default BridgeWorker represents a bridge worker in ConfigHub. A bridge worker is a worker program that connects ConfigHub to external systems and targets. It acts as a bridge between ConfigHub and the infrastructure where configurations need to be applied. Bridge workers are responsible for executing configuration changes on remote targets and reporting status back to ConfigHub. When starting a bridge worker program, both the BridgeWorkerID and Secret are required for authentication with the ConfigHub server. These credentials allow the bridge worker to establish a secure connection and receive configuration actions. application/json BridgeWorker

Update BridgeWorker

PUT /space/{space_id}/bridge_worker/{bridge_worker_id}

Update BridgeWorker

Operation ID: UpdateBridgeWorker

Parameters

Path Parameters

Parameter Type Required Description
space_id string ✓ Unique identifier for a space_id
bridge_worker_id string ✓ Unique identifier for a bridge_worker_id

Request Body

Content-Type: application/json

Schema: BridgeWorker

Responses

Status Description Content-Type Schema
200 BridgeWorker represents a bridge worker in ConfigHub. A bridge worker is a worker program that connects ConfigHub to external systems and targets. It acts as a bridge between ConfigHub and the infrastructure where configurations need to be applied. Bridge workers are responsible for executing configuration changes on remote targets and reporting status back to ConfigHub. When starting a bridge worker program, both the BridgeWorkerID and Secret are required for authentication with the ConfigHub server. These credentials allow the bridge worker to establish a secure connection and receive configuration actions. application/json BridgeWorker
400 BridgeWorker request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 BridgeWorker not found. application/json StandardErrorResponse
409 BridgeWorker data conflict. Data has changed since last read. application/json StandardErrorResponse
500 Something went wrong while processing BridgeWorker. application/json StandardErrorResponse
default BridgeWorker represents a bridge worker in ConfigHub. A bridge worker is a worker program that connects ConfigHub to external systems and targets. It acts as a bridge between ConfigHub and the infrastructure where configurations need to be applied. Bridge workers are responsible for executing configuration changes on remote targets and reporting status back to ConfigHub. When starting a bridge worker program, both the BridgeWorkerID and Secret are required for authentication with the ConfigHub server. These credentials allow the bridge worker to establish a secure connection and receive configuration actions. application/json BridgeWorker

Bulk delete multiple bridge workers

DELETE /bridge_worker

Delete multiple bridge workers selected by query parameters

Operation ID: BulkDeleteBridgeWorkers

Parameters

Query Parameters

Parameter Type Required Description
where string The specified string is an expression for the purpose of filtering the list of BridgeWorkers returned. The expression syntax was inspired by SQL. It supports conjunctions using AND of relational expressions of the form attribute operator attribute_or_literal. The attribute names are case-sensitive and PascalCase, as in the JSON encoding. Strings support the following operators: <, >, <=, >=, =, !=, LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, !~~ for NOT LIKE. String regex operators: ~ for regex matching, ~* for case-insensitive regex, !~ and !~* for regex not matching (case-sensitive and insensitive). Integers support the following operators: <, >, <=, >=, =, !=, IN, NOT IN. UUIDs and boolean attributes support equality and inequality only. UUID and time literals must be quoted as string literals. String literals are quoted with single quotes, such as 'string'. Time literals use the same form as when serialized as JSON, such as: CreatedAt > '2025-02-18T23:16:34'. Integer and boolean literals are also supported for attributes of those types. Arrays support the ? operator to to match any element of the array, as in ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(ApprovedBy) > 0. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. The IN and NOT IN operators accept a comma-separated list of values in parentheses, such as Slug IN ('slugone', 'slugtwo') or Labels.environment IN ('prod', 'staging'). Conjunctions are supported using the AND operator. An example conjunction is: CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'. Supported attributes for filtering on BridgeWorker: BridgeWorkerID, CreatedAt, DisplayName, Labels, OrganizationID, Slug, SpaceID, UpdatedAt, UserID. The whole string must be query-encoded.
filter string UUID of a Filter entity to apply to the BridgeWorker list. The Filter must be in the same Organization as the user credentials. The Filter's From field must match the entity type being filtered (BridgeWorker). For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
contains string Free text search that approximately matches the specified string against string fields and map keys/values. The search is case-insensitive and uses pattern matching to find entities containing the text. Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. For map fields (like Labels and Annotations), the search matches both map keys and values. The search uses OR logic across all searchable fields, so matching any field will return the entity. If both 'where' and 'contains' parameters are specified, they are combined with AND logic. Searchable fields for BridgeWorker include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include string Include clause for expanding related entities in the response for BridgeWorker. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for BridgeWorker are OrganizationID, SpaceID. The whole string must be query-encoded.

Responses

Status Description Content-Type Schema
200 OK application/json Array of DeleteResponse
207 Multi-Status: Mixed success and failure results application/json Array of DeleteResponse
400 BridgeWorker request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 BridgeWorker not found. application/json StandardErrorResponse
422 BridgeWorker could not be deleted. application/json StandardErrorResponse
500 Something went wrong while processing BridgeWorker. application/json StandardErrorResponse
default application/json Array of DeleteResponse

Delete BridgeWorker

DELETE /space/{space_id}/bridge_worker/{bridge_worker_id}

Delete BridgeWorker

Operation ID: DeleteBridgeWorker

Parameters

Path Parameters

Parameter Type Required Description
space_id string ✓ Unique identifier for a space_id
bridge_worker_id string ✓ Unique identifier for a bridge_worker_id

Responses

Status Description Content-Type Schema
200 Response for successful delete operation application/json DeleteResponse
400 BridgeWorker request is invalid (Bad Request). application/json StandardErrorResponse
401 Unauthorized access. application/json StandardErrorResponse
403 Forbidden access. application/json StandardErrorResponse
404 BridgeWorker not found. application/json StandardErrorResponse
422 BridgeWorker could not be deleted. application/json StandardErrorResponse
500 Something went wrong while processing BridgeWorker. application/json StandardErrorResponse
default Response for successful delete operation application/json DeleteResponse

Schemas

ActionResult

Properties

Property Type Required Description
Action ActionType
Data string (base64) Configuration data of the Unit
LiveState string (base64) Live state corresponding to the Unit
Message string
Outputs string (base64) Outputs resulting from applying the configuration data of the Unit
QueuedOperationID string (uuid) UUID of the operation corresponding to the action request
Result ActionResultType
RevisionNum integer (int64)
SpaceID string (uuid) UUID of the Space of the Unit on which the action is performed
StartedAt string (date-time)
Status ActionStatusType
TerminatedAt string (date-time)
UnitID string (uuid) UUID of the Unit on which the action is performed

BridgeWorker

BridgeWorker represents a bridge worker in ConfigHub. A bridge worker is a worker program that connects ConfigHub to external systems and targets. It acts as a bridge between ConfigHub and the infrastructure where configurations need to be applied. Bridge workers are responsible for executing configuration changes on remote targets and reporting status back to ConfigHub. When starting a bridge worker program, both the BridgeWorkerID and Secret are required for authentication with the ConfigHub server. These credentials allow the bridge worker to establish a secure connection and receive configuration actions.

Properties

Property Type Required Description
Annotations object An optional map of Annotation key/value pairs for tools to attach information to entities.
BridgeWorkerID string (uuid) Unique identifier for a Bridge Worker.
Condition string Condition represents the worker's readiness state (Ready, NotReady, Unresponsive, Disconnected).
CreatedAt string (date-time) The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
CursorID integer (int64) An auto-incrementing sequence number used for pagination.
DeleteGates object An optional set of gates that, if any is present, will block deletion.
DisplayName string Friendly name for the entity.
EntityType string The type of entity.
IPAddress string IPAddress is the IP address from which the worker last connected.
Labels object An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them.
LastMessage string LastMessage contains the last message from the worker (heartbeat message or other status).
LastSeenAt string (date-time) LastSeenAt is the time the worker was last seen (heartbeat, connection, or any event).
OrganizationID string (uuid) Unique identifier for an organization.
ProvidedInfo WorkerInfo
Secret string Secret is a unique secret token for the bridge worker. It's auto-generated when the BridgeWorker entity is created and cannot be modified. This field is output-only and used for authentication. This secret is required when starting the bridge worker program.
Slug string ✓ Unique URL-safe identifier for the entity.
SpaceID string (uuid) Unique identifier for a space.
UpdatedAt string (date-time) The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format.
UserID UUID
Version integer (int64) An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.

BridgeWorkerCreateOrUpdateResponse

Properties

Property Type Required Description
BridgeWorker BridgeWorker
Error ResponseError

DeleteResponse

Response for successful delete operation

Properties

Property Type Required Description
Error ResponseError
Message string Response message.

EventMessage

Properties

Property Type Required Description
Data string (base64)
Event string

ExtendedBridgeWorker

Properties

Property Type Required Description
BridgeWorker BridgeWorker
Error ResponseError
Organization Organization
Space Space
TargetCount integer (int64)

StandardErrorResponse

Error response details.

Properties

Property Type Required Description
Code string HTTP status code of the response.
Message string Message returned with the response.