Unit Event

UnitEvent represents an event of action performed on a Unit's configuration. Each action tracks the lifecycle of applying, destroying, or refreshing a Unit's configuration in the target live system. The event captures the current status of the operation, any configuration drift detected, and timing information about when the action started and completed. Actions are atomic from ConfigHub's perspective but may involve multiple steps in the connected Bridge. The status and drift detection help track the health and consistency of the provisioned configuration compared to what is defined in the Unit.

Operations

Method	Endpoint	Description
GET	/space/{space_id}/unit/{unit_id}/unit_event	List UnitEvents
GET	/unit_event	List of UnitEvents across units
GET	/space/{space_id}/unit/{unit_id}/unit_event/{unit_event_id}	Get UnitEvent

---

List UnitEvents

GET /space/{space_id}/unit/{unit_id}/unit_event

List UnitEvents

Operation ID: ListUnitEvents

Parameters

Path Parameters

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

Query Parameters

Parameter	Type	Required	Description
where	string		The specified string is an expression for the purpose of filtering the list of UnitEvents 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, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, NOT LIKE and !~~ for negated pattern matching. 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 FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(FromLinkID) > 0. An attribute naming a list of other entities can be filtered on their attributes with a * segment, as in FromLink.*.Slug = 'upgrade-app', which holds when any element satisfies it. Without the * such a reference is an error, since it names no single value to compare. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. Maps support IS NULL and IS NOT NULL with dot notation to check for key absence or presence, as in Labels.tier IS NULL (key doesn't exist) or Labels.tier IS NOT NULL (key exists). Comparison results can be tested with IS TRUE, IS FALSE, IS NOT TRUE, and IS NOT FALSE. These are useful for nullable columns: MergeSourceID = '<uuid>' IS NOT FALSE matches rows where MergeSourceID equals the value OR is NULL. 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 UnitEvent: Action, BridgeWorkerID, CreatedAt, HiddenReason, OrganizationID, QueuedOperationID, Result, RevisionNum, SpaceID, StartedAt, Status, TerminatedAt, UnitEventID, UnitEventNum, UnitID, UpdatedAt. The whole string must be query-encoded.
filter	string		UUID of a Filter entity to apply to the UnitEvent 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 (UnitEvent). 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 UnitEvent include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include_hidden	string		Hidden UnitEvent entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. It is a comma-separated list of HiddenReasons, or * for all of them. A where clause naming the entities, by their Slug or ID with = or IN, or naming HiddenReason at all, also returns hidden entities it selects. ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason BackingUnit.
offset	integer		Deprecated: use continue. Number of UnitEvent entities to skip before returning results. Cannot be combined with continue.
limit	integer		Maximum number of UnitEvent entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request.
order_by	string		Comma-separated list of fields to sort UnitEvent results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. Supported attributes for ordering UnitEvent: Action, BridgeWorkerID, CreatedAt, HiddenReason, OrganizationID, QueuedOperationID, Result, RevisionNum, StartedAt, Status, TerminatedAt, UnitEventID, UnitEventNum, UnitID, UpdatedAt. Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. Results are ordered by the UnitEvent's ID after the fields named, and by the ID alone if none are. The whole string must be query-encoded.
continue	string		The token from the ConfigHub-Continue header of the previous page, to return the UnitEvent entities after it. The request's other parameters, except limit, must be the same as those of the request that returned the token. Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more.

Responses

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

---

List of UnitEvents across units

GET /unit_event

Retrieves a list of UnitEvents across units in the Organization. By default, returns at most one UnitEvent per unit (the most recent). Set distinct_on=Off to receive every matching UnitEvent instead, undeduped -- paginate with limit/offset to walk the full result set (distinct_on=Off requires an explicit limit and a non-empty where or filter, since without deduplication or a filter there is nothing bounding the result set)

Operation ID: ListAllUnitEvents

Parameters

Query Parameters

Parameter	Type	Required	Description
where	string		The specified string is an expression for the purpose of filtering the list of UnitEvents 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, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*, IN, NOT IN. String pattern operators: LIKE and ~~ for pattern matching with % and _ wildcards, ILIKE for case-insensitive pattern matching, NOT LIKE and !~~ for negated pattern matching. 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 FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'. Arrays can perform LEN() to check for length, as in LEN(FromLinkID) > 0. An attribute naming a list of other entities can be filtered on their attributes with a * segment, as in FromLink.*.Slug = 'upgrade-app', which holds when any element satisfies it. Without the * such a reference is an error, since it names no single value to compare. Map support the dot notation to specify a particular map key, as in Labels.tier = 'Backend'. Maps support IS NULL and IS NOT NULL with dot notation to check for key absence or presence, as in Labels.tier IS NULL (key doesn't exist) or Labels.tier IS NOT NULL (key exists). Comparison results can be tested with IS TRUE, IS FALSE, IS NOT TRUE, and IS NOT FALSE. These are useful for nullable columns: MergeSourceID = '<uuid>' IS NOT FALSE matches rows where MergeSourceID equals the value OR is NULL. 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 UnitEvent: Action, BridgeWorkerID, CreatedAt, HiddenReason, OrganizationID, QueuedOperationID, Result, RevisionNum, SpaceID, StartedAt, Status, TerminatedAt, UnitEventID, UnitEventNum, UnitID, UpdatedAt. The whole string must be query-encoded.
filter	string		UUID of a Filter entity to apply to the UnitEvent 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 (UnitEvent). 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 UnitEvent include string and map-type attributes from the queryable attributes list. The whole string must be query-encoded.
include_hidden	string		Hidden UnitEvent entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. It is a comma-separated list of HiddenReasons, or * for all of them. A where clause naming the entities, by their Slug or ID with = or IN, or naming HiddenReason at all, also returns hidden entities it selects. ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason BackingUnit.
offset	integer		Deprecated: use continue. Number of UnitEvent entities to skip before returning results. Cannot be combined with continue.
limit	integer		Maximum number of UnitEvent entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request.
order_by	string		Comma-separated list of fields to sort UnitEvent results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. Supported attributes for ordering UnitEvent: Action, BridgeWorkerID, CreatedAt, HiddenReason, OrganizationID, QueuedOperationID, Result, RevisionNum, StartedAt, Status, TerminatedAt, UnitEventID, UnitEventNum, UnitID, UpdatedAt. Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. Results are ordered by the UnitEvent's ID after the fields named, and by the ID alone if none are. The whole string must be query-encoded.
continue	string		The token from the ConfigHub-Continue header of the previous page, to return the UnitEvent entities after it. The request's other parameters, except limit, must be the same as those of the request that returned the token. Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more.
distinct_on	string		Entity to return at most one UnitEvent per. The result set applies DISTINCT ON this key, keeping the most recent row for each. Supported values: Unit, Off. If not specified, results are restricted to at most one row per Unit. Off disables the DISTINCT ON and returns every matching row, so it requires an explicit 'limit' and is rejected with 400 without one.

Responses

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

---

Get UnitEvent

GET /space/{space_id}/unit/{unit_id}/unit_event/{unit_event_id}

Get UnitEvent

Operation ID: GetUnitEvent

Parameters

Path Parameters

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

Responses

Status	Description	Content-Type	Schema
200	UnitEvent represents an event of action performed on a Unit's configuration. Each action tracks the lifecycle of applying, destroying, or refreshing a Unit's configuration in the target live system. The event captures the current status of the operation, any configuration drift detected, and timing information about when the action started and completed. Actions are atomic from ConfigHub's perspective but may involve multiple steps in the connected Bridge. The status and drift detection help track the health and consistency of the provisioned configuration compared to what is defined in the Unit.	application/json	UnitEvent
400	UnitEvent request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	UnitEvent not found.	application/json	StandardErrorResponse
500	Something went wrong while processing UnitEvent.	application/json	StandardErrorResponse
default	Unexpected error.	application/json	StandardErrorResponse

---

Schemas

StandardErrorResponse

The body of an error response: the error as data (Error), and as one string (message) for clients written before Error.

Properties

Property	Type	Required	Description
Error			The error: its message, category (Type), HTTP status, details, and structured items.
message	string		The error as one string: its message, with any details, items, and individual errors appended. Kept for clients written before Error; new clients read Error.

UnitEvent

UnitEvent represents an event of action performed on a Unit's configuration. Each action tracks the lifecycle of applying, destroying, or refreshing a Unit's configuration in the target live system. The event captures the current status of the operation, any configuration drift detected, and timing information about when the action started and completed. Actions are atomic from ConfigHub's perspective but may involve multiple steps in the connected Bridge. The status and drift detection help track the health and consistency of the provisioned configuration compared to what is defined in the Unit.

Properties

Property	Type	Required	Description
Action	ActionType
BridgeWorkerID	string (uuid)		BridgeWorkerID is the ID of the bridge worker that performed this action: the worker that reported the result.
CreatedAt	string (date-time)		The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
EntityType	string		The type of entity.
HiddenReason	string		The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another.
Message	string
OrganizationID	string (uuid)		Unique identifier for an Organization.
QueuedOperationID	string (uuid)		QueuedOperationID is the unique identifier for the corresponding queued operation.
Result	ActionResultType
RevisionNum	integer (int64)
SpaceID	string (uuid)		Unique identifier for a space.
SpaceSlug	string		Slug of the Space this entity belongs to. (readonly)
StartedAt	string (date-time)
Status	ActionStatusType
TerminatedAt	string (date-time)
UnitEventID	string (uuid)
UnitEventNum	integer (int64)		Sequence number for this unit event.
UnitID	string (uuid)		Unique identifier for a Unit.
UnitSlug	string		Slug of the Unit this entity belongs to. (readonly)
UpdatedAt	string (date-time)		The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format.
Version	integer (int64)		An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.