workspaces

Export a workspace

A one-shot L1 snapshot: every artifact that belongs to this workspace, plus its first-level children grouped by kind (projects, workspaces).

L1 only. Artifacts carry no per-kind metadata and no relationships, and children carry no artifact counts — an export is a manifest, not a substitute for reading each row. A caller that needs a kind's own properties reads GET /artifacts/{artifact_kind}/{artifact_id}.

Uncapped, and deliberately so: a snapshot with a page boundary in it is not a snapshot. The cost is real — a large workspace is a large response — which is why this is one request rather than a browse surface.

The requested workspace is not echoed back, and its own artifacts are direct members only: a project's linked library artifacts belong to the project, and GET /projects/{project_id}/export is where they resolve.

get/registry/v1/workspaces/{workspace_id}/export

Request

  • Base URL: https://api.atlan.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.atlan.com/registry/v1/workspaces/{workspace_id}/export
  • Auth: HTTP bearer

Path parameters

workspace_idstring required

Workspace handle (workspace_…) or the workspace's kebab-case name. The two grammars are disjoint, so no disambiguation is needed. A name is mutable — a display_name edit re-derives it — so a client that stores an address should store the handle, which every response echoes.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.