Resource reference

Preview This section documents every resource the managed.dev /v1 API exposes — what each object looks like, the endpoints that act on it, the scopes those endpoints require, and worked request/response examples. Read it alongside the core concepts, which cover the cross-cutting behavior (auth, errors, pagination, jobs) that every resource shares.

Developer preview

The managed.dev public API is in active development. Endpoints, scopes, and payloads described here reflect the current design and may change before general availability.

How the reference is organized

The API is split into two layers, and the split is deliberate.

• A product-agnostic core. account, teams, sites, environments, deployments, domains, backups, observability, security, and jobs are defined without reference to any CMS. A static site and a WordPress site are the same resource types — they differ only in the capabilities they advertise. These pages are stable across every runtime.
• A capability-gated dynamic application layer. components (plugins, themes, modules), exec, content, database, and cache/secrets reach into the running application. Which of these a given site supports depends on its runtime — you ask the site what it can do rather than hard-coding if runtime == "wordpress".

This page indexes the core. The application-layer pages live alongside it and carry the same anatomy, with one extra element: a capability gate.

The per-endpoint anatomy

Every endpoint on every resource page is documented the same way, so you can scan it quickly:

1. The HTTP method and path, as a heading or inline code — for example POST /v1/sites or GET /v1/sites/{id}/capabilities.
2. The required scope(s), shown as a badge — for example sites:write. Remember write implies read and admin implies write, so a narrower badge is always sufficient.
3. Any capability gate, shown as an aside — for example “requires the components.plugins capability”. Endpoints in the core layer have no gate; only the application layer does.
4. A parameters table — name, type, required, and a one-line description for each path, query, and body field.
5. Request and response examples in tabs — at minimum cURL plus one of Go, TypeScript, or the mf CLI, every response wrapped in the standard envelope.

Reading scope badges

A badge like environments:write means the endpoint needs at least that scope. The effective permission for any call is the intersection of your role, your key’s scopes, and your key’s resource constraint — see the security model.

The resource convention

Most resources follow the same shape, so once you’ve learned one you’ve learned them all:

Verb	Method + path	Returns
create	POST /v1/{collection}	the new object, or a 202 job for non-instant creates
retrieve	GET /v1/{collection}/{id}	a single object
update	PATCH /v1/{collection}/{id}	the updated object, or a 202 job
list	GET /v1/{collection}	a cursor-paginated collection
delete	DELETE /v1/{collection}/{id}	204, or a 202 job for non-instant deletes

Action endpoints — restart, promote, clone-content, restore, and the like — sit under the resource they act on (POST /v1/sites/{id}/restart) and almost always return a 202 Accepted with an async job you track to completion.

The resources

Account & teams

Your account, teams, members and roles, projects, invites, audit log, and plan usage. Read more

Sites

The product-agnostic site resource — create, configure, restart, clone, and discover what a site can do. Read more

Environments

First-class children of a site: production, staging, and preview, with their full lifecycle and content cloning. Read more

Deployments

Builds, deployments, releases, promotes, and rollbacks across environments. Read more

Domains, DNS & TLS

Attach custom domains to an environment, manage DNS records on a site, and renew certificates. Read more

Backups & snapshots

Take snapshots, restore them, and download archives. Read more

Observability

Performance summaries, timeseries, logs, traces, and requests — per environment. Read more

Security

Blocked requests, malware scans, and detections. Read more

Jobs

The async-job resource that long-running mutations return. Read more

Components

The capability-gated application layer: plugins, themes, and modules. Read more

Exec

Run scoped commands — WP-CLI and shell — inside an environment. Read more

Content

Posts, pages, media, and users on runtimes that support them. Read more

Database

Schema, read queries, and exports for runtimes with a managed database. Read more

Cache & secrets

Purge caches and manage env-scoped config vars and secrets. Read more

API keys

Mint, list, roll, and revoke the keys that authenticate every call. Read more

Next steps

Async jobsHow non-instant mutations return a job you poll or stream to completion.

Scope catalogThe full product.resource:action grammar and every scope you can grant.

Capability discoveryHow a site advertises what it can do, so your client never hard-codes a runtime.

API quickstartMake your first authenticated call in a few minutes.