Link

Link connects two config Units in a dependency / producer-consumer relationship. A Link indicates that config values Provided by the To Unit (the producer) may satisfy config values Needed by the From Unit (the consumer), and should be attempted to be matched before values Provided by other Units in the Space (if within the same Space). Links must be created in the same Space as the From Unit. They also imply an ordering when Applied or Destroyed as a Set.

Operations

Method	Endpoint	Description
GET	/link	List of Links across spaces
GET	/space/{space_id}/link	List Links
GET	/space/{space_id}/link/{link_id}	Get Link
POST	/link	Bulk create (clone) multiple links
POST	/space/{space_id}/link	Create Link
PATCH	/link	Update multiple Links
PATCH	/space/{space_id}/link/{link_id}	Patch Link
PUT	/space/{space_id}/link/{link_id}	Update Link
DELETE	/link	Delete multiple Links
DELETE	/space/{space_id}/link/{link_id}	Delete Link

---

List of Links across spaces

GET /link

Retrieves a list of Links across spaces in the Organization

Operation ID: SearchListLinks

Parameters

Query Parameters

Parameter	Type	Required	Description
where	string		The specified string is an expression for the purpose of filtering the list of Links 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 Link: CreatedAt, DeleteGates, DisplayName, FromUnitID, Labels, LinkID, OrganizationID, Slug, SpaceID, ToSpaceID, ToUnitID, UpdatedAt. The whole string must be query-encoded.
filter	string		UUID of a Filter entity to apply to the Link 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 (Link). 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 Link 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 Link. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Link are FromUnitID, OrganizationID, SpaceID, ToSpaceID, ToUnitID. The whole string must be query-encoded.
select	string		Select clause for specifying which fields to include in the response for Link. 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, LinkID) 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 ExtendedLink
400	Link request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Link not found.	application/json	StandardErrorResponse
500	Something went wrong while processing Link.	application/json	StandardErrorResponse
default		application/json	Array of ExtendedLink

---

List Links

GET /space/{space_id}/link

List Links

Operation ID: ListLinks

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 Links 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 Link: CreatedAt, DeleteGates, DisplayName, FromUnitID, Labels, LinkID, OrganizationID, Slug, SpaceID, ToSpaceID, ToUnitID, UpdatedAt. The whole string must be query-encoded.
filter	string		UUID of a Filter entity to apply to the Link 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 (Link). 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 Link 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 Link. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Link are FromUnitID, OrganizationID, SpaceID, ToSpaceID, ToUnitID. The whole string must be query-encoded.
select	string		Select clause for specifying which fields to include in the response for Link. 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, LinkID) 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 ExtendedLink
400	Link request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Link not found.	application/json	StandardErrorResponse
500	Something went wrong while processing Link.	application/json	StandardErrorResponse
default		application/json	Array of ExtendedLink

---

Get Link

GET /space/{space_id}/link/{link_id}

Get Link

Operation ID: GetLink

Parameters

Path Parameters

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

Query Parameters

Parameter	Type	Required	Description
include	string		Include clause for expanding related entities in the response for Link. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Link are FromUnitID, OrganizationID, SpaceID, ToSpaceID, ToUnitID. The whole string must be query-encoded.
select	string		Select clause for specifying which fields to include in the response for Link. 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, LinkID) 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	ExtendedLink
400	Link request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Link not found.	application/json	StandardErrorResponse
500	Something went wrong while processing Link.	application/json	StandardErrorResponse
default		application/json	ExtendedLink

---

Bulk create (clone) multiple links

POST /link

Clone multiple links selected by query parameters with optional name prefixes and destination spaces

Operation ID: BulkCreateLinks

Parameters

Query Parameters

Parameter	Type	Required	Description
where_space	string		The specified string is an expression for the purpose of filtering the list of Spaces 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 Space: CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Slug, SpaceID, UpdatedAt. Where expression to select destination spaces for created links The whole string must be query-encoded.
filter_space	string		UUID of a Filter entity to apply to the Space 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 (Space). 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.
where_to_space	string		The specified string is an expression for the purpose of filtering the list of Spaces 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 Space: CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Slug, SpaceID, UpdatedAt. Where expression to select ToSpaces for created links The whole string must be query-encoded.
filter_to_space	string		UUID of a Filter entity to apply to the Space 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 (Space). 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.
where_from	string		The specified string is an expression for the purpose of filtering the list of Units 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 Unit: ApplyGates, ApprovedBy, BridgeWorkerID, ChangeSetID, CreatedAt, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, Labels, LastActionAt, LastAppliedRevisionNum, LastChangeDescription, LiveRevisionNum, OrganizationID, PreviousLiveRevisionNum, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamOrganizationID, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values. Where expression to select FromUnits for created links The whole string must be query-encoded.
filter_from	string		UUID of a Filter entity to apply to the Unit 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 (Unit). 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.
where_to	string		The specified string is an expression for the purpose of filtering the list of Units 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 Unit: ApplyGates, ApprovedBy, BridgeWorkerID, ChangeSetID, CreatedAt, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, Labels, LastActionAt, LastAppliedRevisionNum, LastChangeDescription, LiveRevisionNum, OrganizationID, PreviousLiveRevisionNum, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamOrganizationID, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values. Where expression to select ToUnits for created links The whole string must be query-encoded.
filter_to	string		UUID of a Filter entity to apply to the Unit 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 (Unit). 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.
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/merge-patch+json

Responses

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

---

Create Link

POST /space/{space_id}/link

Create Link

Operation ID: CreateLink

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: Link

Responses

Status	Description	Content-Type	Schema
200	Link connects two config Units in a dependency / producer-consumer relationship. A Link indicates that config values Provided by the To Unit (the producer) may satisfy config values Needed by the From Unit (the consumer), and should be attempted to be matched before values Provided by other Units in the Space (if within the same Space). Links must be created in the same Space as the From Unit. They also imply an ordering when Applied or Destroyed as a Set.	application/json	Link
400	Link request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Link not found.	application/json	StandardErrorResponse
500	Something went wrong while processing Link.	application/json	StandardErrorResponse
default	Link connects two config Units in a dependency / producer-consumer relationship. A Link indicates that config values Provided by the To Unit (the producer) may satisfy config values Needed by the From Unit (the consumer), and should be attempted to be matched before values Provided by other Units in the Space (if within the same Space). Links must be created in the same Space as the From Unit. They also imply an ordering when Applied or Destroyed as a Set.	application/json	Link

---

Update multiple Links

PATCH /link

Updates multiple Links based on search criteria

Operation ID: BulkPatchLinks

Parameters

Query Parameters

Parameter	Type	Required	Description
where	string		The specified string is an expression for the purpose of filtering the list of Links 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 Link: CreatedAt, DeleteGates, DisplayName, FromUnitID, Labels, LinkID, OrganizationID, Slug, SpaceID, ToSpaceID, ToUnitID, UpdatedAt. filter The whole string must be query-encoded.
filter	string		UUID of a Filter entity to apply to the Link 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 (Link). 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 Link 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 Link. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Link are FromUnitID, OrganizationID, SpaceID, ToSpaceID, ToUnitID. 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 LinkCreateOrUpdateResponse
207	Multi-Status: Mixed success and failure results	application/json	Array of LinkCreateOrUpdateResponse
400	Link request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Link not found.	application/json	StandardErrorResponse
500	Something went wrong while processing Link.	application/json	StandardErrorResponse
default		application/json	Array of LinkCreateOrUpdateResponse

---

Patch Link

PATCH /space/{space_id}/link/{link_id}

Patch Link

Operation ID: PatchLink

Parameters

Path Parameters

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

Request Body

Content-Type: application/merge-patch+json

Responses

Status	Description	Content-Type	Schema
200	Link connects two config Units in a dependency / producer-consumer relationship. A Link indicates that config values Provided by the To Unit (the producer) may satisfy config values Needed by the From Unit (the consumer), and should be attempted to be matched before values Provided by other Units in the Space (if within the same Space). Links must be created in the same Space as the From Unit. They also imply an ordering when Applied or Destroyed as a Set.	application/json	Link
400	Link request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Link not found.	application/json	StandardErrorResponse
500	Something went wrong while processing Link.	application/json	StandardErrorResponse
default	Link connects two config Units in a dependency / producer-consumer relationship. A Link indicates that config values Provided by the To Unit (the producer) may satisfy config values Needed by the From Unit (the consumer), and should be attempted to be matched before values Provided by other Units in the Space (if within the same Space). Links must be created in the same Space as the From Unit. They also imply an ordering when Applied or Destroyed as a Set.	application/json	Link

---

Update Link

PUT /space/{space_id}/link/{link_id}

Update Link

Operation ID: UpdateLink

Parameters

Path Parameters

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

Request Body

Content-Type: application/json

Schema: Link

Responses

Status	Description	Content-Type	Schema
200	Link connects two config Units in a dependency / producer-consumer relationship. A Link indicates that config values Provided by the To Unit (the producer) may satisfy config values Needed by the From Unit (the consumer), and should be attempted to be matched before values Provided by other Units in the Space (if within the same Space). Links must be created in the same Space as the From Unit. They also imply an ordering when Applied or Destroyed as a Set.	application/json	Link
400	Link request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Link not found.	application/json	StandardErrorResponse
409	Link data conflict. Data has changed since last read.	application/json	StandardErrorResponse
500	Something went wrong while processing Link.	application/json	StandardErrorResponse
default	Link connects two config Units in a dependency / producer-consumer relationship. A Link indicates that config values Provided by the To Unit (the producer) may satisfy config values Needed by the From Unit (the consumer), and should be attempted to be matched before values Provided by other Units in the Space (if within the same Space). Links must be created in the same Space as the From Unit. They also imply an ordering when Applied or Destroyed as a Set.	application/json	Link

---

Delete multiple Links

DELETE /link

Deletes multiple Links based on search criteria

Operation ID: BulkDeleteLinks

Parameters

Query Parameters

Parameter	Type	Required	Description
where	string		The specified string is an expression for the purpose of filtering the list of Links 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 Link: CreatedAt, DeleteGates, DisplayName, FromUnitID, Labels, LinkID, OrganizationID, Slug, SpaceID, ToSpaceID, ToUnitID, UpdatedAt. filter The whole string must be query-encoded.
filter	string		UUID of a Filter entity to apply to the Link 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 (Link). 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 Link 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 Link. The attribute names are case-sensitive, PascalCase, and expected in a comma-separated list format as in the JSON encoding. Supported attributes for Link are FromUnitID, OrganizationID, SpaceID, ToSpaceID, ToUnitID. 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	Link request is invalid (Bad Request).	application/json	StandardErrorResponse
401	Unauthorized access.	application/json	StandardErrorResponse
403	Forbidden access.	application/json	StandardErrorResponse
404	Link not found.	application/json	StandardErrorResponse
422	Unable to delete entity	application/json	StandardErrorResponse
500	Something went wrong while processing Link.	application/json	StandardErrorResponse
default		application/json	Array of DeleteResponse

---

Delete Link

DELETE /space/{space_id}/link/{link_id}

Delete Link

Operation ID: DeleteLink

Parameters

Path Parameters

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

Responses

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

---

Schemas

DeleteResponse

Response for successful delete operation

Properties

Property	Type	Required	Description
Error	ResponseError
Message	string		Response message.

ExtendedLink

Properties

Property	Type	Required	Description
Error	ResponseError
FromUnit	Unit
Link	Link
Organization	Organization
Space	Space
ToSpace	Space
ToUnit	Unit

Link

Link connects two config Units in a dependency / producer-consumer relationship. A Link indicates that config values Provided by the To Unit (the producer) may satisfy config values Needed by the From Unit (the consumer), and should be attempted to be matched before values Provided by other Units in the Space (if within the same Space). Links must be created in the same Space as the From Unit. They also imply an ordering when Applied or Destroyed as a Set.

Properties

Property	Type	Required	Description
Annotations	object		An optional map of Annotation key/value pairs for tools to attach information to entities.
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.
FromUnitID	string (uuid)	✓	Unique identifier the Unit the Link initiates from. Links must be in the same space as the source unit.
Labels	object		An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them.
LinkID	string (uuid)		Unique identifier for a Link.
OrganizationID	string (uuid)		Unique identifier for an organization.
Slug	string	✓	Unique URL-safe identifier for the entity.
SpaceID	string (uuid)		Unique identifier for a space.
ToSpaceID	string (uuid)		Unique identifier the Space of the Unit the Link targets.
ToUnitID	string (uuid)	✓	Unique identifier the Unit the Link targets.
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.

LinkCreateOrUpdateResponse

Properties

Property	Type	Required	Description
Error	ResponseError
Link	Link

StandardErrorResponse

Error response details.

Properties

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