Skip to main content
POST
CreateFold

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
matcher
id_pattern · object
required

Which entities the fold shows as its node.

id
string<uuid>

Id of the new fold, a UUID.

name
string

Name shown on the fold's node.

Required string length: 1 - 200
enabled
boolean | null

Whether lineage applies the fold from the start. Defaults to on.

actor
Actor · object

Who is making the change. Optional: the identity is completed from the calling credentials. Set it to attribute the change to a person.

Response

200 - application/json

Success

fold
LineageFold · object

LineageFold shows many similar entities as one node in lineage.

Some tools write to a new table or a new storage path on every run: a date sharded table (events_20261008), a staging table per load (tmp_load_<uuid>), an export per day (exports/orders_20261008). Each of them is its own entity, so lineage shows one node per day or per run. A fold matches those entities and lineage shows them as the single fold node instead, connected to everything any of them is connected to.

Folding changes only how lineage is drawn. Every folded entity keeps its own page, checks, owners and documentation, and switching a fold off brings the original nodes back.