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	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 `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'`. 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, 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.

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, returning at most one UnitEvent per unit

Operation ID: ListAllUnitEvents

Parameters

Query Parameters

Parameter	Type	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 `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'`. 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, 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.

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

Error response details.

Properties

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

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	Description
`Action`	`ActionType`
`BridgeWorkerID`	string (uuid)	BridgeWorkerID is the ID of the bridge worker that performed this action. This field is populated from the Target's BridgeWorkerID when the event is created.
`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.
`EntityType`	string	The type of entity.
`Message`	string
`OrganizationID`	string (uuid)	Unique identifier for an Organization.
`QueuedOperationID`	string (uuid)	QueuedOperationID is the unique identifier for the corresponding queued operation.
`ResourceStatuses`	`ResourceStatusMap`
`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.
`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.