Manifest reference
Manifest create request fields, presets, resource shape, graph entities, and command vocabulary.
Every field the control plane knows about a manifest. For outcome-forward guidance, see Manifests.
Create request
Section titled “Create request”POST /org/{org}/ws/{workspace}/worlds/manifests
| Field | Type | Default | Notes |
|---|---|---|---|
name | string or null | null | Display name. |
project_id | UUID or null | workspace default | Grouping bucket inside the workspace. |
preset | small, medium, large, enterprise, or null | null | Opaque preset passed to the Worlds backend. |
seed | int or null | null | Deterministic generation seed. |
num_users | int or null | null | 1–50,000. Mutually useful with preset. |
num_hosts | int or null | null | 1–10,000. |
domains | list of strings or null | null | Domain names for the generated AD environment. |
Manifest kind
Section titled “Manifest kind”manifest_kind | Meaning |
|---|---|
active_directory | Synthetic Active Directory environment. Currently the only kind. |
Resource shape
Section titled “Resource shape”GET /org/{org}/ws/{workspace}/worlds/manifests/{manifest-id} returns:
| Field | Type | Notes |
|---|---|---|
id | string | Manifest UUID. |
organization_id | string | |
workspace_id | string | |
created_by | string or null | User ID. |
project_id | string or null | |
source_job_id | string or null | The manifest_generation job that produced this manifest. |
name | string or null | |
manifest_kind | active_directory | |
preset | preset enum or null | Whatever was submitted. |
seed | int or null | |
stats | WorldManifestStats | Summary counts; see below. |
artifact_refs | object | Backend-dependent references to stored manifest artifacts. |
created_at | ISO 8601 string |
WorldManifestStats
Section titled “WorldManifestStats”| Field | Type | Notes |
|---|---|---|
network_id | string or null | Backend network identifier. |
total_hosts | int ≥ 0 | |
total_principals | int ≥ 0 | |
total_edges | int ≥ 0 | |
domains | list of strings | Domains present in the generated graph. |
Graph entities
Section titled “Graph entities”The manifest graph is rendered as nodes and edges. Inspect via:
GET /manifests/{id}/graph/nodes— paginated nodes (up to 5,000 per page).GET /manifests/{id}/graph/edges— paginated edges (up to 20,000 per page).GET /manifests/{id}/graph/overview— semantically aggregated overview.GET /manifests/{id}/graph/subgraph?center=<node-id>&depth=<n>— k-hop subgraph centered on a node.
Node and edge payloads are backend-defined and passed through. The overview endpoint aggregates nodes by type so large enterprise manifests stay renderable in the graph explorer.
Principals
Section titled “Principals”GET /manifests/{id}/principals/search?query=<text>&principal_type=<type>— paginated principal search.GET /manifests/{id}/principals/{principal-id}— basic metadata.GET /manifests/{id}/principals/{principal-id}/details— expanded detail including memberships, credentials (redacted), and graph context.
Principal types commonly seen in Active Directory manifests include User, Computer,
Group, and service accounts; the set is backend-defined and appears on each principal
record as principal_type.
GET /manifests/{id}/hosts/{host-id}— basic host metadata.GET /manifests/{id}/hosts/{host-id}/details— expanded detail including services, artifacts, and graph neighbors.
Command vocabulary
Section titled “Command vocabulary”GET /manifests/{id}/commands returns the actions the sampler can take against this
manifest. Each command carries:
| Field | Meaning |
|---|---|
name | Unique identifier for the command. |
pattern | Invocation pattern (shell-style template). |
description | Human-readable description. |
usage | Usage syntax with argument placeholders. |
The catalog is live — it reads from the Worlds backend sandbox for the manifest. If the backend is no longer reachable, the endpoint returns an empty list and the web UI surfaces a warning.
Scopes
Section titled “Scopes”| Endpoint | Required scope |
|---|---|
All GET routes | WORLDS_READ |
POST /manifests | WORLDS_WRITE |