On this page
Permissions
Every Arcane permission, what it requires, and which API endpoints check it.
Add these permissions to a role. Picking a permission also adds the ones listed under Requires.
- Global permissions apply to the whole Manager.
- Agent permissions apply to every agent, or only to the agent a role assignment names.
Generate this list from your own install with arcane permissions -o permissions.json.
Permissions
Section titled “Permissions”229 of 229 permissions
| Permission | Details |
|---|---|
users:list | List user accounts |
users:read | View a user account and its details |
users:create | Create user accounts |
users:update | Change user account details |
users:delete | Delete user accounts |
roles:list | List roles |
roles:read | View a role and its permissions |
apikeys:list | List API keys |
apikeys:read | View an API key and its permissions |
apikeys:create | Create API keys |
apikeys:update | Change API key details and permissions |
apikeys:delete | Revoke and delete API keys |
federated:list | List federated credentials |
federated:read | View a federated credential |
federated:create | Create federated credentials |
federated:update | Change federated credentials |
federated:delete | Delete federated credentials |
settings:read | View app-wide settings such as experimental features, analytics, update checks, and notification options |
settings:update | Change app-wide settings such as experimental features, analytics, update checks, and notification options |
environments:list | List environments |
environments:read | View an environment, its version, and test its connection |
environments:create | Add environments |
environments:update | Change environment details |
environments:delete | Remove environments |
environments:pair | Get agent deployment snippets and mTLS bundles to pair an agent |
environments:sync | Trigger an environment sync and heartbeat |
environments:restart | Drop and reconnect the agent tunnel |
registries:list | List container registries |
registries:read | View a container registry and registry pull usage |
registries:create | Add container registries |
registries:update | Change container registries and sync them to agents |
registries:delete | Remove container registries |
registries:test | Test a container registry connection |
registries:browse | Browse repositories and tags stored in the registry (the pages also require Read) |
registries:delete-tags | Delete image manifests from the registry |
templates:list | List templates and template registries |
templates:read | View a template, its content, the default templates, and fetch remote registries |
templates:create | Create templates, download remote templates, and add template registries |
templates:update | Change templates, the default templates, and template registries |
templates:delete | Delete templates and template registries |
variables:list | List global variables |
variables:read | View global variable sync status |
variables:create | Create global variables |
variables:update | Change global variables |
variables:delete | Delete global variables |
variables:sync | Sync global variables to environments |
git-repositories:list | List Git repositories |
git-repositories:read | View a Git repository, its branches, and its files |
git-repositories:create | Add Git repositories |
git-repositories:update | Change Git repositories |
git-repositories:delete | Remove Git repositories |
git-repositories:test | Test a Git repository connection |
git-repositories:sync | Sync Git repositories to agents |
s3-destinations:list | List S3 destinations |
s3-destinations:read | View an S3 destination and where it is used |
s3-destinations:create | Add S3 destinations |
s3-destinations:update | Change S3 destinations |
s3-destinations:delete | Remove S3 destinations |
s3-destinations:test | Test an S3 destination connection |
s3-destinations:sync | Sync S3 destinations to agents |
system-backups:list | List backups and backup history |
system-backups:read | View backup policies, volume backup settings, and backup contents |
system-backups:create | Start system and volume backups |
system-backups:update | Change backup policies and volume backup settings, and discover existing backups |
system-backups:delete | Delete backups |
system-backups:upload | Upload a backup to an S3 destination |
system-backups:restore | Restore the system or individual files from a backup |
system-backups:recovery-key | Generate or replace the backup recovery key |
events:list | List events, event stats, and environment change feeds |
events:delete | Delete events |
diagnostics:read | View runtime diagnostics and backend logs |
diagnostics:profile | Capture pprof profiles and goroutine dumps, which can contain in-memory secrets |
containers:list | List containers, container counts, and published ports |
containers:read | View a container, its config, processes, and stats |
containers:logs | View and download container logs |
containers:create | Create containers and convert docker run commands |
containers:start | Start containers |
containers:stop | Stop containers |
containers:restart | Restart containers |
containers:redeploy | Pull the image again and recreate a container |
containers:update | Change a container's config and recreate it |
containers:kill | Send a signal to a container's main process |
containers:pause | Pause and unpause containers |
containers:delete | Remove containers |
containers:exec | Open an interactive shell inside a container |
containers:autoupdate | Turn automatic updates on or off for a container |
projects:list | List projects, project counts, tags, and references |
projects:read | View a project, its compose files, runtime state, workspace, and updates |
projects:logs | View project logs |
projects:create | Create projects |
projects:update | Change project files, tags, and services |
projects:deploy | Deploy, redeploy, pull, and build projects |
projects:down | Stop and remove a project's containers |
projects:restart | Restart a project's containers |
projects:delete | Delete projects |
projects:archive | Archive and unarchive projects |
images:list | List images, image counts, builds, and image patches |
images:read | View an image, its history and attestations, search, export, and view builds |
images:pull | Pull images from registries |
images:push | Push images to registries |
images:build | Build images |
images:tag | Tag images |
images:commit | Create an image from a container |
images:prune | Remove unused images |
images:delete | Remove images |
images:upload | Load images from uploaded archives |
images:patch | Patch vulnerable packages in images |
volumes:list | List volumes, volume counts, and volume sizes |
volumes:read | View a volume, its usage, files, backups, and backup policy |
volumes:create | Create volumes |
volumes:rename | Rename volumes |
volumes:delete | Remove volumes and delete files inside volumes |
volumes:prune | Remove unused volumes |
volumes:upload | Upload and change files inside volumes and upload volume backups |
volumes:backup | Create, delete, upload, and restore volume backups and change backup policies |
networks:list | List networks and network counts |
networks:read | View a network and the network topology |
networks:create | Create networks |
networks:delete | Remove networks |
networks:prune | Remove unused networks |
networks:connect | Connect containers to networks |
networks:disconnect | Disconnect containers from networks |
swarm:read | View cluster status, info, tasks, and identity |
swarm:update | Change the cluster spec |
swarm:init | Initialize a new cluster |
swarm:join | Join a cluster and add environments to it |
swarm:leave | Leave the cluster |
swarm:unlock | Unlock the cluster and view or rotate the unlock key and join tokens |
swarm-services:list | List services |
swarm-services:read | View a service and its tasks |
swarm-services:create | Create services |
swarm-services:update | Update, scale, or roll back a service |
swarm-services:delete | Remove services |
swarm-services:logs | View service logs |
swarm-stacks:list | List stacks |
swarm-stacks:read | View a stack, its services, tasks, and source |
swarm-stacks:create | Deploy stacks and render stack configs |
swarm-stacks:update | Change a stack's source |
swarm-stacks:delete | Remove stacks |
swarm-nodes:list | List nodes |
swarm-nodes:read | View a node and its tasks |
swarm-nodes:update | Update node availability, labels, and agent deployments |
swarm-nodes:delete | Remove nodes from the cluster |
swarm-nodes:promote | Promote a worker node to manager |
swarm-nodes:demote | Demote a manager node to worker |
swarm-configs:list | List configs |
swarm-configs:read | View a config |
swarm-configs:create | Create configs |
swarm-configs:update | Change configs |
swarm-configs:delete | Remove configs |
swarm-secrets:list | List secrets |
swarm-secrets:read | View secret metadata; the value is never included |
swarm-secrets:create | Create secrets |
swarm-secrets:update | Change secrets |
swarm-secrets:delete | Remove secrets |
podman:read | View Podman status and info |
podman:autoupdate | Run podman auto-update |
podman-pods:list | List pods |
podman-pods:read | View a pod, its processes, and pod stats |
podman-pods:create | Create pods |
podman-pods:delete | Remove pods |
podman-pods:prune | Remove every stopped pod |
podman-pods:start | Start pods |
podman-pods:stop | Stop pods |
podman-pods:restart | Restart pods |
podman-pods:pause | Pause and unpause pods |
podman-pods:kill | Send a signal to a pod's containers |
podman-quadlets:list | List quadlets |
podman-quadlets:read | View a quadlet and its file |
podman-quadlets:create | Install quadlets |
podman-quadlets:update | Replace a quadlet file |
podman-quadlets:delete | Remove quadlets |
podman-quadlets:start | Start a quadlet's systemd unit |
podman-quadlets:stop | Stop a quadlet's systemd unit |
podman-quadlets:restart | Restart a quadlet's systemd unit |
podman-secrets:list | List secrets |
podman-secrets:read | View secret metadata; the value is never included |
podman-secrets:create | Create secrets |
podman-secrets:update | Replace the value, driver, and labels of a secret |
podman-secrets:delete | Remove secrets |
podman-kube:read | Generate Kubernetes YAML from existing pods, containers, or volumes |
podman-kube:create | Create pods and containers from Kubernetes YAML |
podman-kube:delete | Remove pods and containers created from Kubernetes YAML |
gitops:list | List GitOps syncs |
gitops:read | View a sync, its status, and its files |
gitops:create | Create and import syncs |
gitops:update | Change syncs |
gitops:delete | Delete syncs |
gitops:sync | Run a sync now |
gitops:lifecycle | Create or modify a sync's pre-deploy lifecycle hook, which runs an arbitrary container with host bind mounts and env on every sync |
gitops:backup | View a project's Git backup preview and history, and manage the backup together with the matching sync permission (create, update, sync, delete) |
webhooks:list | List webhooks |
webhooks:create | Create webhooks |
webhooks:update | Change webhooks |
webhooks:delete | Delete webhooks |
jobs:list | List jobs and their runs |
jobs:read | View job schedules and run details |
jobs:update | Change job schedules |
jobs:run | Run a job now |
jobs:restart | Restart a continuous job worker |
jobs:retry | Retry a job run |
jobs:cancel | Cancel a job run |
jobs:ack | Acknowledge a job run |
notifications:list | List notification provider settings |
notifications:read | View a notification provider's settings |
notifications:update | Create or update notification provider settings |
notifications:delete | Remove notification provider settings |
notifications:test | Send a test notification |
system:read | View system health, Docker info, disk usage, stats, and upgrade status |
system:prune | Remove unused Docker resources |
system:upgrade | Upgrade Arcane |
image-updates:list | View update summaries, update info for images, and updater history |
image-updates:read | View updater status and release notes |
image-updates:check | Check images and projects for updates |
image-updates:apply | Pull new images and recreate containers or projects with them |
vulnerabilities:list | View environment-wide vulnerability overviews, ignores, and patch targets |
vulnerabilities:read | View an image's vulnerabilities and scanner status |
vulnerabilities:scan | Scan images for vulnerabilities |
vulnerabilities:update | Ignore or unignore vulnerabilities |
build-workspaces:list | Browse build workspace directories |
build-workspaces:read | View and download build workspace files |
build-workspaces:create | Upload files and create directories |
build-workspaces:delete | Delete files and directories |
activities:list | List and stream activities |
activities:read | View an activity and its messages |
activities:cancel | Cancel a running activity |
activities:delete | Clear activity history |
environment-settings:read | View per-environment Docker, storage, security, timeouts, builds, activity, and automations settings |
environment-settings:update | Change per-environment Docker, storage, security, timeouts, builds, activity, and automations settings |
No permissions match. Try a resource name like containers.
Endpoints
Section titled “Endpoints”Every API endpoint and the permission it checks. Some endpoints check a different permission per ?action=, or add one based on the request.
475 of 475 endpoints
| Endpoint | Access |
|---|---|
GET/api/agent/mtls/ca | Download Arcane-generated agent mTLS CA |
GET/api/agents | List environments |
POST/api/agents | Create an environment |
POST/api/agents/enroll | Enroll an agent |
POST/api/agents/pair | Pair agent with manager |
DELETE/api/agents/{id} | Delete an environment |
GET/api/agents/{id} | Get an environment |
PATCH/api/agents/{id} | Update an environment |
GET/api/agents/{id}/activities | List background activities |
DELETE/api/agents/{id}/activities/history | Clear background activity history |
GET/api/agents/{id}/activities/{activityId} | Get background activity |
POST/api/agents/{id}/activities/{activityId} | Cancel a background activity |
GET/api/agents/{id}/backups/history | List an environment's backup history |
DELETE/api/agents/{id}/backups/{backupId} | Delete Arcane system backup |
POST/api/agents/{id}/backups/{backupId} | Restore Arcane system backup Global admin only |
POST/api/agents/{id}/backups/{backupId}/files/browse | Browse project files in an Arcane system backup |
POST/api/agents/{id}/backups/{backupId}/upload | Upload Arcane system backup |
GET/api/agents/{id}/builds/workspace | Get build workspace |
PATCH/api/agents/{id}/builds/workspace | Update build workspace |
GET/api/agents/{id}/builds/workspace/file | Get build workspace file |
GET/api/agents/{id}/builds/workspace/file/download | Download build workspace file |
POST/api/agents/{id}/builds/workspace/upload | Upload build workspace file |
GET/api/agents/{id}/containers | List containers |
POST/api/agents/{id}/containers | Create container |
POST/api/agents/{id}/containers/compose | Generate compose file |
GET/api/agents/{id}/containers/counts | Container status counts |
DELETE/api/agents/{id}/containers/{containerId} | Delete container |
GET/api/agents/{id}/containers/{containerId} | Get container |
POST/api/agents/{id}/containers/{containerId} | Run container lifecycle action |
PUT/api/agents/{id}/containers/{containerId}/autoupdate | Set container auto-update |
POST/api/agents/{id}/containers/{containerId}/commit | Commit container |
GET/api/agents/{id}/containers/{containerId}/config | Get container edit config |
PUT/api/agents/{id}/containers/{containerId}/config | Edit container |
GET/api/agents/{id}/containers/{containerId}/logs/download | Download container logs |
GET/api/agents/{id}/containers/{containerId}/processes | Get container processes |
POST/api/agents/{id}/containers/{containerId}/redeploy | Redeploy container |
POST/api/agents/{id}/containers/{containerId}/update | Update a single container |
POST/api/agents/{id}/deployment | Create deployment snippets |
GET/api/agents/{id}/deployment/mtls/bundle | Download environment mTLS bundle |
GET/api/agents/{id}/deployment/mtls/{fileName} | Download environment mTLS asset |
GET/api/agents/{id}/diagnostics/actors | Get actor diagnostics for an environment |
GET/api/agents/{id}/diagnostics/goroutines | Get goroutine diagnostics for an environment |
GET/api/agents/{id}/events/changes | Wait for environment changes |
GET/api/agents/{id}/gitops/syncs | List GitOps syncs |
POST/api/agents/{id}/gitops/syncs | Create a GitOps sync |
POST/api/agents/{id}/gitops/syncs/import | Import GitOps syncs |
DELETE/api/agents/{id}/gitops/syncs/{syncId} | Delete a GitOps sync |
GET/api/agents/{id}/gitops/syncs/{syncId} | Get a GitOps sync |
PATCH/api/agents/{id}/gitops/syncs/{syncId} | Update a GitOps sync |
POST/api/agents/{id}/gitops/syncs/{syncId} | Perform a GitOps sync |
GET/api/agents/{id}/gitops/syncs/{syncId}/backup/history | List Git backup history |
GET/api/agents/{id}/gitops/syncs/{syncId}/backup/history/{commit} | Get a Git backup revision |
GET/api/agents/{id}/gitops/syncs/{syncId}/backup/preview | Preview a Git backup |
POST/api/agents/{id}/gitops/syncs/{syncId}/backup/resolve | Resolve a Git backup conflict |
GET/api/agents/{id}/gitops/syncs/{syncId}/files | Browse GitOps sync files |
GET/api/agents/{id}/gitops/syncs/{syncId}/status | Get GitOps sync status |
GET/api/agents/{id}/images | List images |
POST/api/agents/{id}/images/build | Build an image |
GET/api/agents/{id}/images/builds | List image builds |
GET/api/agents/{id}/images/builds/{buildId} | Get image build |
GET/api/agents/{id}/images/counts | Get image usage counts |
GET/api/agents/{id}/images/patches | List image patches |
GET/api/agents/{id}/images/patches/targets | List image patch targets |
POST/api/agents/{id}/images/prune | Prune unused images |
POST/api/agents/{id}/images/pull | Pull an image |
GET/api/agents/{id}/images/search | Search images |
GET/api/agents/{id}/images/updates/check | Check image update by reference |
POST/api/agents/{id}/images/updates/check | Check all or multiple images |
GET/api/agents/{id}/images/updates/check/{imageId} | Check image update by ID |
POST/api/agents/{id}/images/updates/check/{imageId} | Check image update by ID (POST) |
GET/api/agents/{id}/images/updates/refs | Get persisted update info for image references |
GET/api/agents/{id}/images/updates/releasenotes | Get image release notes |
GET/api/agents/{id}/images/updates/summary | Get update summary |
POST/api/agents/{id}/images/upload | Upload an image |
POST/api/agents/{id}/images/vulnerabilities/summaries | Get vulnerability scan summaries |
DELETE/api/agents/{id}/images/{imageId} | Remove an image |
GET/api/agents/{id}/images/{imageId} | Get image by ID |
POST/api/agents/{id}/images/{imageId}/patch | Patch image |
GET/api/agents/{id}/images/{imageId}/vulnerabilities | Get vulnerability scan result |
GET/api/agents/{id}/images/{imageId}/vulnerabilities/list | List image vulnerabilities |
POST/api/agents/{id}/images/{imageId}/vulnerabilities/scan | Scan image for vulnerabilities |
GET/api/agents/{id}/images/{imageId}/vulnerabilities/summary | Get vulnerability scan summary |
GET/api/agents/{id}/images/{name}/attestations | Get image attestations |
GET/api/agents/{id}/images/{name}/export | Export image |
GET/api/agents/{id}/images/{name}/history | Get image history |
POST/api/agents/{id}/images/{name}/tag | Tag image |
GET/api/agents/{id}/jobs | List all background jobs |
GET/api/agents/{id}/jobs/schedules | Get job schedules |
PATCH/api/agents/{id}/jobs/schedules | Update job schedules |
POST/api/agents/{id}/jobs/{jobId} | Run a job action |
GET/api/agents/{id}/jobs/{jobId}/runs | List job runs |
GET/api/agents/{id}/jobs/{jobId}/runs/{runId} | Get job run |
POST/api/agents/{id}/jobs/{jobId}/runs/{runId} | Retry, cancel, or acknowledge a job run |
GET/api/agents/{id}/networks | List networks |
POST/api/agents/{id}/networks | Create network |
GET/api/agents/{id}/networks/counts | Network counts |
POST/api/agents/{id}/networks/prune | Prune networks |
GET/api/agents/{id}/networks/topology | Get network topology |
DELETE/api/agents/{id}/networks/{networkId} | Delete network |
GET/api/agents/{id}/networks/{networkId} | Get network |
POST/api/agents/{id}/networks/{networkId} | Connect or disconnect a container |
POST/api/agents/{id}/podman/autoupdate | Run Podman auto-update |
GET/api/agents/{id}/podman/info | Get Podman info |
POST/api/agents/{id}/podman/kube/down | Tear down kube YAML |
POST/api/agents/{id}/podman/kube/generate | Generate kube YAML |
POST/api/agents/{id}/podman/kube/play | Play kube YAML |
GET/api/agents/{id}/podman/pods | List pods |
POST/api/agents/{id}/podman/pods | Create pod |
POST/api/agents/{id}/podman/pods/prune | Prune pods |
GET/api/agents/{id}/podman/pods/stats | Get pod stats |
DELETE/api/agents/{id}/podman/pods/{podId} | Remove pod |
GET/api/agents/{id}/podman/pods/{podId} | Inspect pod |
POST/api/agents/{id}/podman/pods/{podId} | Run pod lifecycle action |
GET/api/agents/{id}/podman/pods/{podId}/top | List pod processes |
GET/api/agents/{id}/podman/quadlets | List quadlets |
POST/api/agents/{id}/podman/quadlets | Install quadlet |
DELETE/api/agents/{id}/podman/quadlets/{name} | Remove quadlet |
GET/api/agents/{id}/podman/quadlets/{name} | Get quadlet |
POST/api/agents/{id}/podman/quadlets/{name} | Run quadlet lifecycle action |
PUT/api/agents/{id}/podman/quadlets/{name} | Update quadlet |
GET/api/agents/{id}/podman/quadlets/{name}/file | Get quadlet file |
GET/api/agents/{id}/podman/secrets | List Podman secrets |
POST/api/agents/{id}/podman/secrets | Create Podman secret |
DELETE/api/agents/{id}/podman/secrets/{secretId} | Remove Podman secret |
GET/api/agents/{id}/podman/secrets/{secretId} | Inspect Podman secret |
PUT/api/agents/{id}/podman/secrets/{secretId} | Replace Podman secret |
GET/api/agents/{id}/podman/status | Get Podman status |
GET/api/agents/{id}/ports | List port mappings |
GET/api/agents/{id}/projects | List projects |
POST/api/agents/{id}/projects | Create a project |
GET/api/agents/{id}/projects/counts | Get project status counts |
GET/api/agents/{id}/projects/directories | List projects directories |
GET/api/agents/{id}/projects/references | List project references |
GET/api/agents/{id}/projects/tags | List project tags |
DELETE/api/agents/{id}/projects/{projectId} | Destroy a project |
GET/api/agents/{id}/projects/{projectId} | Get a project |
PATCH/api/agents/{id}/projects/{projectId} | Update a project |
POST/api/agents/{id}/projects/{projectId} | Run project action |
POST/api/agents/{id}/projects/{projectId}/build | Build project images |
GET/api/agents/{id}/projects/{projectId}/compose | Get project compose details |
POST/api/agents/{id}/projects/{projectId}/deploy | Deploy, redeploy, or pull a project |
GET/api/agents/{id}/projects/{projectId}/runtime | Get project runtime |
PATCH/api/agents/{id}/projects/{projectId}/tags | Update a project tag |
GET/api/agents/{id}/projects/{projectId}/updates | Get project updates |
GET/api/agents/{id}/projects/{projectId}/workspace | Get project workspace |
PATCH/api/agents/{id}/projects/{projectId}/workspace | Update project workspace |
GET/api/agents/{id}/projects/{projectId}/workspace/file | Get project workspace file |
GET/api/agents/{id}/projects/{projectId}/workspace/file/download | Download project workspace file |
GET/api/agents/{id}/settings | Get environment settings |
PATCH/api/agents/{id}/settings | Update environment settings |
GET/api/agents/{id}/settings/public | Get public settings |
GET/api/agents/{id}/swarm/configs | List swarm configs |
POST/api/agents/{id}/swarm/configs | Create swarm config |
DELETE/api/agents/{id}/swarm/configs/{configId} | Delete swarm config |
GET/api/agents/{id}/swarm/configs/{configId} | Get swarm config |
PUT/api/agents/{id}/swarm/configs/{configId} | Update swarm config labels |
GET/api/agents/{id}/swarm/info | Get swarm info |
POST/api/agents/{id}/swarm/init | Initialize swarm |
POST/api/agents/{id}/swarm/join | Join swarm |
POST/api/agents/{id}/swarm/join/agents | Join environments to a swarm |
GET/api/agents/{id}/swarm/join/candidates | List environments available for Easy Join |
GET/api/agents/{id}/swarm/join/tokens | Get swarm join tokens |
POST/api/agents/{id}/swarm/join/tokens | Rotate swarm join tokens |
POST/api/agents/{id}/swarm/leave | Leave swarm |
GET/api/agents/{id}/swarm/nodes | List swarm nodes |
POST/api/agents/{id}/swarm/nodes/agents/reconcile | Reconcile swarm node agent bindings |
DELETE/api/agents/{id}/swarm/nodes/{nodeId} | Delete swarm node |
GET/api/agents/{id}/swarm/nodes/{nodeId} | Get swarm node |
PATCH/api/agents/{id}/swarm/nodes/{nodeId} | Update swarm node |
POST/api/agents/{id}/swarm/nodes/{nodeId} | Promote or demote swarm node |
DELETE/api/agents/{id}/swarm/nodes/{nodeId}/agent/binding | Detach a visible environment from a swarm node |
PUT/api/agents/{id}/swarm/nodes/{nodeId}/agent/binding | Attach a visible environment to a swarm node |
DELETE/api/agents/{id}/swarm/nodes/{nodeId}/agent/deployment | Remove a dedicated swarm node agent registration |
POST/api/agents/{id}/swarm/nodes/{nodeId}/agent/deployment | Get swarm node agent deployment snippets |
GET/api/agents/{id}/swarm/nodes/{nodeId}/tasks | List tasks for a swarm node |
GET/api/agents/{id}/swarm/secrets | List swarm secrets |
POST/api/agents/{id}/swarm/secrets | Create swarm secret |
DELETE/api/agents/{id}/swarm/secrets/{secretId} | Delete swarm secret |
GET/api/agents/{id}/swarm/secrets/{secretId} | Get swarm secret |
PUT/api/agents/{id}/swarm/secrets/{secretId} | Update swarm secret labels |
GET/api/agents/{id}/swarm/services | List swarm services |
POST/api/agents/{id}/swarm/services | Create swarm service |
DELETE/api/agents/{id}/swarm/services/{serviceId} | Delete swarm service |
GET/api/agents/{id}/swarm/services/{serviceId} | Get swarm service |
PATCH/api/agents/{id}/swarm/services/{serviceId} | Scale a swarm service |
POST/api/agents/{id}/swarm/services/{serviceId} | Rollback a swarm service |
PUT/api/agents/{id}/swarm/services/{serviceId} | Update swarm service |
GET/api/agents/{id}/swarm/services/{serviceId}/tasks | List tasks for a swarm service |
PUT/api/agents/{id}/swarm/spec | Update swarm spec |
GET/api/agents/{id}/swarm/stacks | List swarm stacks |
POST/api/agents/{id}/swarm/stacks | Deploy swarm stack |
POST/api/agents/{id}/swarm/stacks/config/render | Render/validate swarm stack config |
DELETE/api/agents/{id}/swarm/stacks/{name} | Delete swarm stack |
GET/api/agents/{id}/swarm/stacks/{name} | Get swarm stack |
POST/api/agents/{id}/swarm/stacks/{name}/down | Bring down swarm stack |
GET/api/agents/{id}/swarm/stacks/{name}/services | List swarm stack services |
GET/api/agents/{id}/swarm/stacks/{name}/source | Get swarm stack source |
PATCH/api/agents/{id}/swarm/stacks/{name}/source | Update swarm stack source |
GET/api/agents/{id}/swarm/stacks/{name}/tasks | List swarm stack tasks |
POST/api/agents/{id}/swarm/stacks/{name}/up | Bring up swarm stack |
GET/api/agents/{id}/swarm/status | Get swarm status |
GET/api/agents/{id}/swarm/tasks | List swarm tasks |
POST/api/agents/{id}/swarm/unlock | Unlock swarm |
GET/api/agents/{id}/swarm/unlock/key | Get swarm unlock key |
POST/api/agents/{id}/sync | Sync environment |
POST/api/agents/{id}/system/containers | Run bulk container action |
POST/api/agents/{id}/system/convert | Convert docker run command |
GET/api/agents/{id}/system/df | Get reclaimable disk usage |
GET/api/agents/{id}/system/docker/info | Get Docker info |
HEAD/api/agents/{id}/system/health | Check system health |
POST/api/agents/{id}/system/prune | Prune Docker resources |
POST/api/agents/{id}/system/upgrade | Trigger system upgrade |
GET/api/agents/{id}/system/upgrade/check | Check for system upgrade |
POST/api/agents/{id}/system/upgrade/jobs | Start upgrade job |
GET/api/agents/{id}/system/upgrade/jobs/current | Get current upgrade job |
GET/api/agents/{id}/system/upgrade/progress | Stream upgrade progress |
POST/api/agents/{id}/test | Test environment connection |
POST/api/agents/{id}/tunnel/restart | Restart environment agent tunnel |
GET/api/agents/{id}/updater/history | Get updater history |
POST/api/agents/{id}/updater/projects/{projectId}/check | Check project service updates |
POST/api/agents/{id}/updater/run | Run updater |
GET/api/agents/{id}/updater/status | Get updater status |
POST/api/agents/{id}/uploads/{kind} | Create an upload session |
DELETE/api/agents/{id}/uploads/{kind}/{uploadId} | Delete an upload session |
GET/api/agents/{id}/uploads/{kind}/{uploadId} | Get an upload session |
PUT/api/agents/{id}/uploads/{kind}/{uploadId}/chunks/{index} | Upload a chunk |
GET/api/agents/{id}/version | Get environment version |
GET/api/agents/{id}/volumes | List volumes |
POST/api/agents/{id}/volumes | Create a volume |
POST/api/agents/{id}/volumes/backups/discover | Discover volume backups on an S3 destination |
DELETE/api/agents/{id}/volumes/backups/{backupId} | Delete volume backup |
GET/api/agents/{id}/volumes/backups/{backupId}/download | Download volume backup |
GET/api/agents/{id}/volumes/backups/{backupId}/files | List files in a volume backup |
GET/api/agents/{id}/volumes/backups/{backupId}/files/browse | Browse files in a volume backup |
GET/api/agents/{id}/volumes/backups/{backupId}/files/exists | Check if backup contains path |
POST/api/agents/{id}/volumes/backups/{backupId}/upload | Upload volume backup |
GET/api/agents/{id}/volumes/counts | Get volume usage counts |
POST/api/agents/{id}/volumes/prune | Prune unused volumes |
GET/api/agents/{id}/volumes/sizes | Get volume sizes |
DELETE/api/agents/{id}/volumes/{volumeName} | Remove a volume |
GET/api/agents/{id}/volumes/{volumeName} | Get volume by name |
GET/api/agents/{id}/volumes/{volumeName}/backups | List volume backups |
POST/api/agents/{id}/volumes/{volumeName}/backups | Create volume backup |
GET/api/agents/{id}/volumes/{volumeName}/backups/policy | Get volume backup policies |
PUT/api/agents/{id}/volumes/{volumeName}/backups/policy | Update volume backup policies |
POST/api/agents/{id}/volumes/{volumeName}/backups/upload | Upload and restore volume backup |
POST/api/agents/{id}/volumes/{volumeName}/backups/{backupId} | Restore volume backup |
POST/api/agents/{id}/volumes/{volumeName}/rename | Rename a volume |
GET/api/agents/{id}/volumes/{volumeName}/usage | Get volume usage |
GET/api/agents/{id}/volumes/{volumeName}/workspace | Get volume workspace |
PATCH/api/agents/{id}/volumes/{volumeName}/workspace | Update volume workspace |
GET/api/agents/{id}/volumes/{volumeName}/workspace/file | Get volume workspace file |
GET/api/agents/{id}/volumes/{volumeName}/workspace/file/download | Download volume workspace file |
GET/api/agents/{id}/vulnerabilities/all | List environment vulnerabilities |
GET/api/agents/{id}/vulnerabilities/export | Export environment vulnerabilities |
GET/api/agents/{id}/vulnerabilities/ignored | List ignored vulnerabilities |
POST/api/agents/{id}/vulnerabilities/ignored | Ignore a vulnerability |
POST/api/agents/{id}/vulnerabilities/ignored/bulk | Ignore or restore vulnerabilities in bulk |
DELETE/api/agents/{id}/vulnerabilities/ignored/{ignoreId} | Unignore a vulnerability |
GET/api/agents/{id}/vulnerabilities/images | List vulnerability image options |
GET/api/agents/{id}/vulnerabilities/overview | Get environment vulnerability risk overview |
GET/api/agents/{id}/vulnerabilities/scanner | Get vulnerability scanner status |
GET/api/agents/{id}/vulnerabilities/summary | Get environment vulnerability summary |
GET/api/agents/{id}/webhooks | List webhooks |
POST/api/agents/{id}/webhooks | Create webhook |
DELETE/api/agents/{id}/webhooks/{webhookId} | Delete webhook |
PATCH/api/agents/{id}/webhooks/{webhookId} | Update webhook |
GET/api/agents/{id}/ws/containers/stats | |
GET/api/agents/{id}/ws/containers/{containerId}/logs | |
GET/api/agents/{id}/ws/containers/{containerId}/stats | |
GET/api/agents/{id}/ws/containers/{containerId}/terminal | |
GET/api/agents/{id}/ws/projects/{projectId}/logs | |
GET/api/agents/{id}/ws/swarm/services/{serviceId}/logs | |
GET/api/agents/{id}/ws/system/stats | |
GET/api/apikeys | List API keys |
POST/api/apikeys | Create an API key |
DELETE/api/apikeys/{id} | Delete an API key |
GET/api/apikeys/{id} | Get an API key |
PATCH/api/apikeys/{id} | Update an API key |
POST/api/apns/devices | Register a mobile device |
DELETE/api/apns/devices/{id} | Remove a mobile device |
PATCH/api/apns/devices/{id} | Update a mobile device |
POST/api/apns/devices/{id} | Send a test push |
POST/api/apns/pairing | Issue a pairing token |
GET/api/apns/status | Get mobile push status |
DELETE/api/app/images/favicon | Delete custom favicon |
GET/api/app/images/favicon | Get application favicon |
PUT/api/app/images/favicon | Upload custom favicon |
GET/api/app/images/logo | Get application logo |
DELETE/api/app/images/logo/{variant} | Delete custom logo |
PUT/api/app/images/logo/{variant} | Upload custom logo |
GET/api/app/images/profile | Get default profile image |
DELETE/api/app/images/pwa | Delete custom PWA icon |
PUT/api/app/images/pwa | Upload custom PWA icon |
GET/api/app/images/pwa/{filename} | Get PWA icon |
GET/api/app/version | Get app version |
GET/api/auth/bootstrap | Get session bootstrap |
POST/api/auth/federated/token | Exchange a federated subject token |
POST/api/auth/login | Login |
POST/api/auth/logout | Logout |
GET/api/auth/me | Get current user |
GET/api/auth/me/apikeys | List my API keys |
POST/api/auth/me/apikeys | Create my API key |
DELETE/api/auth/me/apikeys/{id} | Delete my API key |
DELETE/api/auth/me/avatar | Delete own avatar |
POST/api/auth/me/avatar | Upload own avatar |
DELETE/api/auth/me/backdrop | Delete own background image |
GET/api/auth/me/backdrop | Get own background image |
POST/api/auth/me/backdrop | Upload own background image |
GET/api/auth/me/mfa | Get passkey MFA status |
POST/api/auth/me/mfa/disable | Disable passkey MFA |
POST/api/auth/me/mfa/enable | Enable passkey MFA |
POST/api/auth/me/mfa/recovery | Regenerate MFA recovery codes |
GET/api/auth/me/passkeys | List my passkeys |
GET/api/auth/me/passkeys/capabilities | Get passkey capabilities |
POST/api/auth/me/passkeys/reauth/begin | Begin passkey step-up |
POST/api/auth/me/passkeys/reauth/finish | Finish passkey step-up |
POST/api/auth/me/passkeys/reauth/password | Reauthenticate with password |
POST/api/auth/me/passkeys/register/begin | Begin passkey registration |
POST/api/auth/me/passkeys/register/finish | Finish passkey registration |
DELETE/api/auth/me/passkeys/{id} | Delete my passkey |
PATCH/api/auth/me/passkeys/{id} | Rename my passkey |
PATCH/api/auth/me/profile | Update own profile |
POST/api/auth/mfa/passkey/begin | Begin passkey MFA |
POST/api/auth/mfa/passkey/finish | Finish passkey MFA |
POST/api/auth/mfa/recovery | Use an MFA recovery code |
GET/api/auth/passkey/login/availability | Get passkey login availability |
POST/api/auth/passkey/login/begin | Begin passkey login |
POST/api/auth/passkey/login/finish | Finish passkey login |
POST/api/auth/passkey/mobile/exchange | Exchange mobile passkey login |
POST/api/auth/passkey/mobile/finish | Finish mobile passkey login |
POST/api/auth/password | Change password |
POST/api/auth/refresh | Refresh token |
DELETE/api/auth/sessions | Logout all other sessions |
GET/api/backups | List Arcane system backups |
POST/api/backups | Create Arcane system backup |
POST/api/backups/discover | Discover Arcane system backups in S3 Global admin only |
GET/api/backups/history | List unified backup history |
GET/api/backups/policies | Get Arcane system backup policies |
PUT/api/backups/policies | Update Arcane system backup policies |
POST/api/backups/recovery/key | Generate an Arcane system backup recovery key Global admin only |
PUT/api/backups/recovery/key | Configure Arcane system backup recovery key Global admin only |
GET/api/backups/s3 | List S3 destinations |
POST/api/backups/s3 | Create S3 destination |
GET/api/backups/s3/options | List all S3 destination options |
POST/api/backups/s3/sync | Sync S3 destinations |
POST/api/backups/s3/test | Test unsaved S3 destination configuration |
DELETE/api/backups/s3/{id} | Delete S3 destination |
GET/api/backups/s3/{id} | Get S3 destination |
PATCH/api/backups/s3/{id} | Update S3 destination |
POST/api/backups/s3/{id} | Test S3 destination |
GET/api/backups/s3/{id}/usage | Check S3 destination references |
GET/api/backups/volumes/config | Get system-managed volume backup policies |
PUT/api/backups/volumes/config | Update system-managed volume backup policies |
GET/api/backups/volumes/options | List volumes available to system-managed backups |
POST/api/backups/volumes/run | Run system-managed volume backups |
GET/api/debug/pprof | |
GET/api/debug/pprof/ | |
GET/api/debug/pprof/cmdline | |
GET/api/debug/pprof/profile | |
GET/api/debug/pprof/symbol | |
POST/api/debug/pprof/symbol | |
GET/api/debug/pprof/trace | |
GET/api/debug/pprof/{name} | |
GET/api/diagnostics/actors/stream | |
GET/api/diagnostics/logs/stream | |
GET/api/diagnostics/stream | |
GET/api/docs | |
GET/api/docs/scalar.js | |
GET/api/enrollment-tokens | List enrollment tokens |
POST/api/enrollment-tokens | Create an enrollment token |
DELETE/api/enrollment-tokens/{id} | Revoke an enrollment token |
GET/api/enrollment-tokens/{id}/token | Get an enrollment token secret |
GET/api/events | List events |
POST/api/events | Ingest an agent event |
GET/api/events/agent/{environmentId} | Get events by environment |
GET/api/events/stats | Event severity counts |
DELETE/api/events/{eventId} | Delete an event |
GET/api/federated/credentials | List federated credentials |
POST/api/federated/credentials | Create a federated credential |
DELETE/api/federated/credentials/{id} | Delete a federated credential |
GET/api/federated/credentials/{id} | Get a federated credential |
PATCH/api/federated/credentials/{id} | Update a federated credential |
POST/api/git/repositories/sync | Sync git repositories |
GET/api/gitops/repositories | List git repositories |
POST/api/gitops/repositories | Create a git repository |
DELETE/api/gitops/repositories/{id} | Delete a git repository |
GET/api/gitops/repositories/{id} | Get a git repository |
PATCH/api/gitops/repositories/{id} | Update a git repository |
POST/api/gitops/repositories/{id} | Test a git repository |
GET/api/gitops/repositories/{id}/branches | List repository branches |
GET/api/gitops/repositories/{id}/files | Browse repository files |
GET/api/health | Health check |
HEAD/api/health | Health check (HEAD) |
GET/api/health/ready | Readiness probe |
POST/api/notifications/dispatch | Dispatch notification from remote agent to manager |
GET/api/notifications/settings | Get all notification settings |
POST/api/notifications/settings | Create or update notification settings |
DELETE/api/notifications/settings/{provider} | Delete notification settings |
GET/api/notifications/settings/{provider} | Get notification settings by provider |
POST/api/notifications/settings/{provider} | Test notification |
POST/api/oidc/callback | Handle OIDC callback |
GET/api/oidc/config | Get OIDC config |
POST/api/oidc/device/code | Initiate OIDC device authorization |
POST/api/oidc/device/token | Exchange device code for tokens |
GET/api/oidc/mappings | List OIDC group → role mappings |
POST/api/oidc/mappings | Create an OIDC role mapping |
DELETE/api/oidc/mappings/{id} | Delete an OIDC role mapping |
PATCH/api/oidc/mappings/{id} | Update an OIDC role mapping |
GET/api/oidc/status | Get OIDC status |
POST/api/oidc/url | Get OIDC auth URL |
GET/api/openapi-3.0.json | |
GET/api/openapi-3.0.yaml | |
GET/api/openapi.json | |
GET/api/openapi.yaml | |
GET/api/registries | List container registries |
POST/api/registries | Create a container registry |
POST/api/registries/sync | Sync container registries |
GET/api/registries/usage | Get container registry pull usage |
DELETE/api/registries/{id} | Delete a container registry |
GET/api/registries/{id} | Get a container registry |
PATCH/api/registries/{id} | Update a container registry |
POST/api/registries/{id} | Test a container registry |
GET/api/registries/{id}/repositories | List registry repositories |
DELETE/api/registries/{id}/tags | Delete a repository tag |
GET/api/registries/{id}/tags | List repository tags |
GET/api/roles | List roles |
POST/api/roles | Create a custom role |
GET/api/roles/permissions | Get the permission manifest |
DELETE/api/roles/{id} | Delete a custom role |
GET/api/roles/{id} | Get a role |
PATCH/api/roles/{id} | Update a custom role |
GET/api/schemas/{schema} | |
GET/api/settings | Get app-wide settings |
PATCH/api/settings | Update app-wide settings |
GET/api/settings/authentication | Get authentication settings |
PATCH/api/settings/authentication | Update authentication settings |
GET/api/settings/categories | Get settings categories |
POST/api/settings/search | Search settings |
GET/api/stream | Multiplexed client stream |
GET/api/swarm/identity | Get local swarm node identity |
POST/api/telemetry/{signal} | Relay browser telemetry |
GET/api/templates | List templates (paginated) |
POST/api/templates | Create a template |
GET/api/templates/all | List all templates |
GET/api/templates/default | Get default templates |
POST/api/templates/default | Save default templates |
GET/api/templates/fetch | Fetch remote registry |
GET/api/templates/registries | List template registries |
POST/api/templates/registries | Create a template registry |
DELETE/api/templates/registries/{id} | Delete a template registry |
PATCH/api/templates/registries/{id} | Update a template registry |
DELETE/api/templates/{id} | Delete a template |
GET/api/templates/{id} | Get a template |
PATCH/api/templates/{id} | Update a template |
POST/api/templates/{id} | Download a template |
GET/api/templates/{id}/content | Get template content |
GET/api/tunnel/connect | |
POST/api/tunnel/mtls/enroll | Enroll an agent mTLS certificate |
GET/api/users | List users |
POST/api/users | Create a user |
DELETE/api/users/{userId} | Delete a user |
GET/api/users/{userId} | Get a user |
PATCH/api/users/{userId} | Update a user |
GET/api/users/{userId}/avatar | Get user avatar |
GET/api/users/{userId}/roles | List a user's role assignments |
PUT/api/users/{userId}/roles | Replace a user's manual role assignments |
GET/api/variables | List global variables |
POST/api/variables | Create a global variable |
GET/api/variables/sync | Get variable sync status |
POST/api/variables/sync | Sync global variables |
DELETE/api/variables/{id} | Delete a global variable |
PATCH/api/variables/{id} | Update a global variable |
GET/api/version | Get version information |
POST/api/webhooks/trigger/{token} | Trigger webhook |
No endpoints match. Try a path like /containers or a permission.