Skip to content

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.

POST /org/{org}/ws/{workspace}/worlds/manifests

FieldTypeDefaultNotes
namestring or nullnullDisplay name.
project_idUUID or nullworkspace defaultGrouping bucket inside the workspace.
presetsmall, medium, large, enterprise, or nullnullOpaque preset passed to the Worlds backend.
seedint or nullnullDeterministic generation seed.
num_usersint or nullnull1–50,000. Mutually useful with preset.
num_hostsint or nullnull1–10,000.
domainslist of strings or nullnullDomain names for the generated AD environment.
manifest_kindMeaning
active_directorySynthetic Active Directory environment. Currently the only kind.

GET /org/{org}/ws/{workspace}/worlds/manifests/{manifest-id} returns:

FieldTypeNotes
idstringManifest UUID.
organization_idstring
workspace_idstring
created_bystring or nullUser ID.
project_idstring or null
source_job_idstring or nullThe manifest_generation job that produced this manifest.
namestring or null
manifest_kindactive_directory
presetpreset enum or nullWhatever was submitted.
seedint or null
statsWorldManifestStatsSummary counts; see below.
artifact_refsobjectBackend-dependent references to stored manifest artifacts.
created_atISO 8601 string
FieldTypeNotes
network_idstring or nullBackend network identifier.
total_hostsint ≥ 0
total_principalsint ≥ 0
total_edgesint ≥ 0
domainslist of stringsDomains present in the generated graph.

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.

  • 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.

GET /manifests/{id}/commands returns the actions the sampler can take against this manifest. Each command carries:

FieldMeaning
nameUnique identifier for the command.
patternInvocation pattern (shell-style template).
descriptionHuman-readable description.
usageUsage 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.

EndpointRequired scope
All GET routesWORLDS_READ
POST /manifestsWORLDS_WRITE