Skip to content

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.

229 of 229 permissions

PermissionDetails
users:list

List user accounts

ScopeGlobalEndpoints
1 endpoint
  • GET/api/usersList users
users:read

View a user account and its details

ScopeGlobalRequiresusers:listEndpoints
1 endpoint
  • GET/api/users/{userId}Get a user
users:create

Create user accounts

ScopeGlobalRequiresusers:readEndpoints
1 endpoint
  • POST/api/usersCreate a user
users:update

Change user account details

ScopeGlobalRequiresusers:readEndpoints
1 endpoint
  • PATCH/api/users/{userId}Update a user
users:delete

Delete user accounts

ScopeGlobalRequiresusers:readEndpoints
1 endpoint
  • DELETE/api/users/{userId}Delete a user
roles:list

List roles

ScopeGlobalEndpoints
1 endpoint
  • GET/api/rolesList roles
roles:read

View a role and its permissions

ScopeGlobalRequiresroles:listEndpoints
1 endpoint
  • GET/api/roles/{id}Get a role
apikeys:list

List API keys

ScopeGlobalEndpoints
1 endpoint
  • GET/api/apikeysList API keys
apikeys:read

View an API key and its permissions

ScopeGlobalRequiresapikeys:listEndpoints
1 endpoint
  • GET/api/apikeys/{id}Get an API key
apikeys:create

Create API keys

ScopeGlobalRequiresapikeys:readEndpoints
1 endpoint
  • POST/api/apikeysCreate an API key
apikeys:update

Change API key details and permissions

ScopeGlobalRequiresapikeys:readEndpoints
1 endpoint
  • PATCH/api/apikeys/{id}Update an API key
apikeys:delete

Revoke and delete API keys

ScopeGlobalRequiresapikeys:readEndpoints
1 endpoint
  • DELETE/api/apikeys/{id}Delete an API key
federated:list

List federated credentials

ScopeGlobalEndpoints
1 endpoint
  • GET/api/federated/credentialsList federated credentials
federated:read

View a federated credential

ScopeGlobalRequiresfederated:listEndpoints
1 endpoint
  • GET/api/federated/credentials/{id}Get a federated credential
federated:create

Create federated credentials

ScopeGlobalRequiresfederated:readEndpoints
1 endpoint
  • POST/api/federated/credentialsCreate a federated credential
federated:update

Change federated credentials

ScopeGlobalRequiresfederated:readEndpoints
1 endpoint
  • PATCH/api/federated/credentials/{id}Update a federated credential
federated:delete

Delete federated credentials

ScopeGlobalRequiresfederated:readEndpoints
1 endpoint
  • DELETE/api/federated/credentials/{id}Delete a federated credential
settings:read

View app-wide settings such as experimental features, analytics, update checks, and notification options

ScopeGlobalEndpoints
1 endpoint
  • GET/api/settingsGet app-wide settings
settings:update

Change app-wide settings such as experimental features, analytics, update checks, and notification options

ScopeGlobalRequiressettings:readEndpoints
7 endpoints
  • DELETE/api/app/images/faviconDelete custom favicon
  • PUT/api/app/images/faviconUpload custom favicon
  • DELETE/api/app/images/logo/{variant}Delete custom logo
  • PUT/api/app/images/logo/{variant}Upload custom logo
  • DELETE/api/app/images/pwaDelete custom PWA icon
  • PUT/api/app/images/pwaUpload custom PWA icon
  • PATCH/api/settingsUpdate app-wide settings
environments:list

List environments

ScopeGlobal
environments:read

View an environment, its version, and test its connection

ScopeGlobalRequiresenvironments:listEndpoints
3 endpoints
  • GET/api/agents/{id}Get an environment
  • POST/api/agents/{id}/testTest environment connection
  • GET/api/agents/{id}/versionGet environment version
environments:create

Add environments

ScopeGlobalRequiresenvironments:readEndpoints
5 endpoints
  • POST/api/agentsCreate an environment
  • GET/api/enrollment-tokensList enrollment tokens
  • POST/api/enrollment-tokensCreate an enrollment token
  • DELETE/api/enrollment-tokens/{id}Revoke an enrollment token
  • GET/api/enrollment-tokens/{id}/tokenGet an enrollment token secret
environments:update

Change environment details

ScopeGlobalRequiresenvironments:readEndpoints
1 endpoint
  • PATCH/api/agents/{id}Update an environment
environments:delete

Remove environments

ScopeGlobalRequiresenvironments:readEndpoints
1 endpoint
  • DELETE/api/agents/{id}Delete an environment
environments:pair

Get agent deployment snippets and mTLS bundles to pair an agent

ScopeGlobalRequiresenvironments:readEndpoints
4 endpoints
  • GET/api/agent/mtls/caDownload Arcane-generated agent mTLS CA
  • POST/api/agents/{id}/deploymentCreate deployment snippets
  • GET/api/agents/{id}/deployment/mtls/bundleDownload environment mTLS bundle
  • GET/api/agents/{id}/deployment/mtls/{fileName}Download environment mTLS asset
environments:sync

Trigger an environment sync and heartbeat

ScopeGlobalRequiresenvironments:readEndpoints
1 endpoint
  • POST/api/agents/{id}/syncSync environment
environments:restart

Drop and reconnect the agent tunnel

ScopeGlobalRequiresenvironments:readEndpoints
1 endpoint
  • POST/api/agents/{id}/tunnel/restartRestart environment agent tunnel
registries:list

List container registries

ScopeGlobalEndpoints
1 endpoint
  • GET/api/registriesList container registries
registries:read

View a container registry and registry pull usage

ScopeGlobalRequiresregistries:listEndpoints
2 endpoints
  • GET/api/registries/usageGet container registry pull usage
  • GET/api/registries/{id}Get a container registry
registries:create

Add container registries

ScopeGlobalRequiresregistries:readEndpoints
1 endpoint
  • POST/api/registriesCreate a container registry
registries:update

Change container registries and sync them to agents

ScopeGlobalRequiresregistries:readEndpoints
2 endpoints
  • POST/api/registries/syncSync container registries
  • PATCH/api/registries/{id}Update a container registry
registries:delete

Remove container registries

ScopeGlobalRequiresregistries:readEndpoints
1 endpoint
  • DELETE/api/registries/{id}Delete a container registry
registries:test

Test a container registry connection

ScopeGlobalRequiresregistries:readEndpoints
1 endpoint
  • POST/api/registries/{id}Test a container registry
registries:browse

Browse repositories and tags stored in the registry (the pages also require Read)

ScopeGlobalRequiresregistries:readEndpoints
2 endpoints
  • GET/api/registries/{id}/repositoriesList registry repositories
  • GET/api/registries/{id}/tagsList repository tags
registries:delete-tags

Delete image manifests from the registry

ScopeGlobalRequiresregistries:browseEndpoints
1 endpoint
  • DELETE/api/registries/{id}/tagsDelete a repository tag
templates:list

List templates and template registries

ScopeGlobalEndpoints
3 endpoints
  • GET/api/templatesList templates (paginated)
  • GET/api/templates/allList all templates
  • GET/api/templates/registriesList template registries
templates:read

View a template, its content, the default templates, and fetch remote registries

ScopeGlobalRequirestemplates:listEndpoints
4 endpoints
  • GET/api/templates/defaultGet default templates
  • GET/api/templates/fetchFetch remote registry
  • GET/api/templates/{id}Get a template
  • GET/api/templates/{id}/contentGet template content
templates:create

Create templates, download remote templates, and add template registries

ScopeGlobalRequirestemplates:readEndpoints
3 endpoints
  • POST/api/templatesCreate a template
  • POST/api/templates/registriesCreate a template registry
  • POST/api/templates/{id}Download a template
templates:update

Change templates, the default templates, and template registries

ScopeGlobalRequirestemplates:readEndpoints
3 endpoints
  • POST/api/templates/defaultSave default templates
  • PATCH/api/templates/registries/{id}Update a template registry
  • PATCH/api/templates/{id}Update a template
templates:delete

Delete templates and template registries

ScopeGlobalRequirestemplates:readEndpoints
2 endpoints
  • DELETE/api/templates/registries/{id}Delete a template registry
  • DELETE/api/templates/{id}Delete a template
variables:list

List global variables

ScopeGlobalEndpoints
1 endpoint
  • GET/api/variablesList global variables
variables:read

View global variable sync status

ScopeGlobalRequiresvariables:listEndpoints
1 endpoint
  • GET/api/variables/syncGet variable sync status
variables:create

Create global variables

ScopeGlobalRequiresvariables:readEndpoints
1 endpoint
  • POST/api/variablesCreate a global variable
variables:update

Change global variables

ScopeGlobalRequiresvariables:readEndpoints
1 endpoint
  • PATCH/api/variables/{id}Update a global variable
variables:delete

Delete global variables

ScopeGlobalRequiresvariables:readEndpoints
1 endpoint
  • DELETE/api/variables/{id}Delete a global variable
variables:sync

Sync global variables to environments

ScopeGlobalRequiresvariables:readEndpoints
1 endpoint
  • POST/api/variables/syncSync global variables
git-repositories:list

List Git repositories

ScopeGlobalEndpoints
1 endpoint
  • GET/api/gitops/repositoriesList git repositories
git-repositories:read

View a Git repository, its branches, and its files

ScopeGlobalRequiresgit-repositories:listEndpoints
3 endpoints
  • GET/api/gitops/repositories/{id}Get a git repository
  • GET/api/gitops/repositories/{id}/branchesList repository branches
  • GET/api/gitops/repositories/{id}/filesBrowse repository files
git-repositories:create

Add Git repositories

ScopeGlobalRequiresgit-repositories:readEndpoints
1 endpoint
  • POST/api/gitops/repositoriesCreate a git repository
git-repositories:update

Change Git repositories

ScopeGlobalRequiresgit-repositories:readEndpoints
1 endpoint
  • PATCH/api/gitops/repositories/{id}Update a git repository
git-repositories:delete

Remove Git repositories

ScopeGlobalRequiresgit-repositories:readEndpoints
1 endpoint
  • DELETE/api/gitops/repositories/{id}Delete a git repository
git-repositories:test

Test a Git repository connection

ScopeGlobalRequiresgit-repositories:readEndpoints
1 endpoint
  • POST/api/gitops/repositories/{id}Test a git repository
git-repositories:sync

Sync Git repositories to agents

ScopeGlobalRequiresgit-repositories:readEndpoints
1 endpoint
  • POST/api/git/repositories/syncSync git repositories
s3-destinations:list

List S3 destinations

ScopeGlobalEndpoints
2 endpoints
  • GET/api/backups/s3List S3 destinations
  • GET/api/backups/s3/optionsList all S3 destination options
s3-destinations:read

View an S3 destination and where it is used

ScopeGlobalRequiress3-destinations:listEndpoints
2 endpoints
  • GET/api/backups/s3/{id}Get S3 destination
  • GET/api/backups/s3/{id}/usageCheck S3 destination references
s3-destinations:create

Add S3 destinations

ScopeGlobalRequiress3-destinations:readEndpoints
1 endpoint
  • POST/api/backups/s3Create S3 destination
s3-destinations:update

Change S3 destinations

ScopeGlobalRequiress3-destinations:readEndpoints
1 endpoint
  • PATCH/api/backups/s3/{id}Update S3 destination
s3-destinations:delete

Remove S3 destinations

ScopeGlobalRequiress3-destinations:readEndpoints
1 endpoint
  • DELETE/api/backups/s3/{id}Delete S3 destination
s3-destinations:test

Test an S3 destination connection

ScopeGlobalRequiress3-destinations:readEndpoints
2 endpoints
  • POST/api/backups/s3/testTest unsaved S3 destination configuration
  • POST/api/backups/s3/{id}Test S3 destination
s3-destinations:sync

Sync S3 destinations to agents

ScopeGlobalRequiress3-destinations:readEndpoints
1 endpoint
  • POST/api/backups/s3/syncSync S3 destinations
system-backups:list

List backups and backup history

ScopeGlobalEndpoints
2 endpoints
  • GET/api/backupsList Arcane system backups
  • GET/api/backups/historyList unified backup history
system-backups:read

View backup policies, volume backup settings, and backup contents

ScopeGlobalRequiressystem-backups:listEndpoints
4 endpoints
  • POST/api/agents/{id}/backups/{backupId}/files/browseBrowse project files in an Arcane system backup
  • GET/api/backups/policiesGet Arcane system backup policies
  • GET/api/backups/volumes/configGet system-managed volume backup policies
  • GET/api/backups/volumes/optionsList volumes available to system-managed backups
system-backups:create

Start system and volume backups

ScopeGlobalRequiressystem-backups:readEndpoints
2 endpoints
  • POST/api/backupsCreate Arcane system backup
  • POST/api/backups/volumes/runRun system-managed volume backups
system-backups:update

Change backup policies and volume backup settings, and discover existing backups

ScopeGlobalRequiressystem-backups:readEndpoints
3 endpoints
  • POST/api/backups/discoverDiscover Arcane system backups in S3
  • PUT/api/backups/policiesUpdate Arcane system backup policies
  • PUT/api/backups/volumes/configUpdate system-managed volume backup policies
system-backups:delete

Delete backups

ScopeGlobalRequiressystem-backups:readEndpoints
1 endpoint
  • DELETE/api/agents/{id}/backups/{backupId}Delete Arcane system backup
system-backups:upload

Upload a backup to an S3 destination

ScopeGlobalRequiressystem-backups:reads3-destinations:listEndpoints
1 endpoint
  • POST/api/agents/{id}/backups/{backupId}/uploadUpload Arcane system backup
system-backups:restore

Restore the system or individual files from a backup

ScopeGlobalRequiressystem-backups:readEndpoints
2 endpoints
  • POST/api/agents/{id}/backups/{backupId}Restore Arcane system backup
  • POST/api/agents/{id}/backups/{backupId}Restore Arcane system backup
system-backups:recovery-key

Generate or replace the backup recovery key

ScopeGlobalRequiressystem-backups:readEndpoints
2 endpoints
  • POST/api/backups/recovery/keyGenerate an Arcane system backup recovery key
  • PUT/api/backups/recovery/keyConfigure Arcane system backup recovery key
events:list

List events, event stats, and environment change feeds

ScopeGlobalEndpoints
4 endpoints
  • GET/api/agents/{id}/events/changesWait for environment changes
  • GET/api/eventsList events
  • GET/api/events/agent/{environmentId}Get events by environment
  • GET/api/events/statsEvent severity counts
events:delete

Delete events

ScopeGlobalRequiresevents:listEndpoints
1 endpoint
  • DELETE/api/events/{eventId}Delete an event
diagnostics:read

View runtime diagnostics and backend logs

ScopeGlobalEndpoints
5 endpoints
  • GET/api/agents/{id}/diagnostics/actorsGet actor diagnostics for an environment
  • GET/api/agents/{id}/diagnostics/goroutinesGet goroutine diagnostics for an environment
  • GET/api/diagnostics/actors/stream
  • GET/api/diagnostics/logs/stream
  • GET/api/diagnostics/stream
diagnostics:profile

Capture pprof profiles and goroutine dumps, which can contain in-memory secrets

ScopeGlobalRequiresdiagnostics:readEndpoints
10 endpoints
  • 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/stream
  • GET/api/diagnostics/stream
containers:list

List containers, container counts, and published ports

ScopeAgentEndpoints
3 endpoints
  • GET/api/agents/{id}/containersList containers
  • GET/api/agents/{id}/containers/countsContainer status counts
  • GET/api/agents/{id}/portsList port mappings
containers:read

View a container, its config, processes, and stats

ScopeAgentRequirescontainers:listEndpoints
6 endpoints
  • POST/api/agents/{id}/containers/composeGenerate compose file
  • GET/api/agents/{id}/containers/{containerId}Get container
  • GET/api/agents/{id}/containers/{containerId}/configGet container edit config
  • GET/api/agents/{id}/containers/{containerId}/processesGet container processes
  • GET/api/agents/{id}/ws/containers/stats
  • GET/api/agents/{id}/ws/containers/{containerId}/stats
containers:logs

View and download container logs

ScopeAgentRequirescontainers:readEndpoints
2 endpoints
  • GET/api/agents/{id}/containers/{containerId}/logs/downloadDownload container logs
  • GET/api/agents/{id}/ws/containers/{containerId}/logs
containers:create

Create containers and convert docker run commands

ScopeAgentRequirescontainers:readimages:readnetworks:listvolumes:listEndpoints
2 endpoints
  • POST/api/agents/{id}/containersCreate container
  • POST/api/agents/{id}/system/convertConvert docker run command
containers:start

Start containers

ScopeAgentRequirescontainers:readactivities:readEndpoints
3 endpoints
  • POST/api/agents/{id}/containers/{containerId}Run container lifecycle action
  • POST/api/agents/{id}/system/containersRun bulk container action
  • POST/api/agents/{id}/system/containersRun bulk container action
containers:stop

Stop containers

ScopeAgentRequirescontainers:readactivities:readEndpoints
2 endpoints
  • POST/api/agents/{id}/containers/{containerId}Run container lifecycle action
  • POST/api/agents/{id}/system/containersRun bulk container action
containers:restart

Restart containers

ScopeAgentRequirescontainers:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/containers/{containerId}Run container lifecycle action
containers:redeploy

Pull the image again and recreate a container

ScopeAgentRequirescontainers:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/containers/{containerId}/redeployRedeploy container
containers:update

Change a container's config and recreate it

ScopeAgentRequirescontainers:readimages:readnetworks:listvolumes:listactivities:readEndpoints
1 endpoint
  • PUT/api/agents/{id}/containers/{containerId}/configEdit container
containers:kill

Send a signal to a container's main process

ScopeAgentRequirescontainers:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/containers/{containerId}Run container lifecycle action
containers:pause

Pause and unpause containers

ScopeAgentRequirescontainers:readactivities:readEndpoints
2 endpoints
  • POST/api/agents/{id}/containers/{containerId}Run container lifecycle action
  • POST/api/agents/{id}/containers/{containerId}Run container lifecycle action
containers:delete

Remove containers

ScopeAgentRequirescontainers:readactivities:readEndpoints
1 endpoint
  • DELETE/api/agents/{id}/containers/{containerId}Delete container
containers:exec

Open an interactive shell inside a container

ScopeAgentRequirescontainers:readEndpoints
1 endpoint
  • GET/api/agents/{id}/ws/containers/{containerId}/terminal
containers:autoupdate

Turn automatic updates on or off for a container

ScopeAgentRequirescontainers:readEndpoints
1 endpoint
  • PUT/api/agents/{id}/containers/{containerId}/autoupdateSet container auto-update
projects:list

List projects, project counts, tags, and references

ScopeAgentEndpoints
5 endpoints
  • GET/api/agents/{id}/projectsList projects
  • GET/api/agents/{id}/projects/countsGet project status counts
  • GET/api/agents/{id}/projects/directoriesList projects directories
  • GET/api/agents/{id}/projects/referencesList project references
  • GET/api/agents/{id}/projects/tagsList project tags
projects:read

View a project, its compose files, runtime state, workspace, and updates

ScopeAgentRequiresprojects:listEndpoints
7 endpoints
  • GET/api/agents/{id}/projects/{projectId}Get a project
  • GET/api/agents/{id}/projects/{projectId}/composeGet project compose details
  • GET/api/agents/{id}/projects/{projectId}/runtimeGet project runtime
  • GET/api/agents/{id}/projects/{projectId}/updatesGet project updates
  • GET/api/agents/{id}/projects/{projectId}/workspaceGet project workspace
  • GET/api/agents/{id}/projects/{projectId}/workspace/fileGet project workspace file
  • GET/api/agents/{id}/projects/{projectId}/workspace/file/downloadDownload project workspace file
projects:logs

View project logs

ScopeAgentRequiresprojects:readEndpoints
1 endpoint
  • GET/api/agents/{id}/ws/projects/{projectId}/logs
projects:create

Create projects

ScopeAgentRequiresprojects:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/projectsCreate a project
projects:update

Change project files, tags, and services

ScopeAgentRequiresprojects:readactivities:readEndpoints
4 endpoints
  • PATCH/api/agents/{id}/projects/{projectId}Update a project
  • POST/api/agents/{id}/projects/{projectId}Run project action
  • PATCH/api/agents/{id}/projects/{projectId}/tagsUpdate a project tag
  • PATCH/api/agents/{id}/projects/{projectId}/workspaceUpdate project workspace
projects:deploy

Deploy, redeploy, pull, and build projects

ScopeAgentRequiresprojects:readactivities:readEndpoints
4 endpoints
  • POST/api/agents/{id}/projects/{projectId}/buildBuild project images
  • POST/api/agents/{id}/projects/{projectId}/deployDeploy, redeploy, or pull a project
  • POST/api/agents/{id}/projects/{projectId}/deployDeploy, redeploy, or pull a project
  • POST/api/agents/{id}/projects/{projectId}/deployDeploy, redeploy, or pull a project
projects:down

Stop and remove a project's containers

ScopeAgentRequiresprojects:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/projects/{projectId}Run project action
projects:restart

Restart a project's containers

ScopeAgentRequiresprojects:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/projects/{projectId}Run project action
projects:delete

Delete projects

ScopeAgentRequiresprojects:readactivities:readEndpoints
1 endpoint
  • DELETE/api/agents/{id}/projects/{projectId}Destroy a project
projects:archive

Archive and unarchive projects

ScopeAgentRequiresprojects:readEndpoints
2 endpoints
  • POST/api/agents/{id}/projects/{projectId}Run project action
  • POST/api/agents/{id}/projects/{projectId}Run project action
images:list

List images, image counts, builds, and image patches

ScopeAgentEndpoints
4 endpoints
  • GET/api/agents/{id}/imagesList images
  • GET/api/agents/{id}/images/buildsList image builds
  • GET/api/agents/{id}/images/countsGet image usage counts
  • GET/api/agents/{id}/images/patchesList image patches
images:read

View an image, its history and attestations, search, export, and view builds

ScopeAgentRequiresimages:listEndpoints
6 endpoints
  • GET/api/agents/{id}/images/builds/{buildId}Get image build
  • GET/api/agents/{id}/images/searchSearch images
  • GET/api/agents/{id}/images/{imageId}Get image by ID
  • GET/api/agents/{id}/images/{name}/attestationsGet image attestations
  • GET/api/agents/{id}/images/{name}/exportExport image
  • GET/api/agents/{id}/images/{name}/historyGet image history
images:pull

Pull images from registries

ScopeAgentRequiresimages:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/images/pullPull an image
images:push

Push images to registries

ScopeAgentRequiresimages:readEndpoints
2 endpoints
  • POST/api/agents/{id}/images/buildBuild an image
  • POST/api/agents/{id}/projects/{projectId}/buildBuild project images
images:build

Build images

ScopeAgentRequiresimages:readbuild-workspaces:listactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/images/buildBuild an image
images:tag

Tag images

ScopeAgentRequiresimages:readEndpoints
1 endpoint
  • POST/api/agents/{id}/images/{name}/tagTag image
images:commit

Create an image from a container

ScopeAgentRequiresimages:readcontainers:readEndpoints
1 endpoint
  • POST/api/agents/{id}/containers/{containerId}/commitCommit container
images:prune

Remove unused images

ScopeAgentRequiresimages:readEndpoints
1 endpoint
  • POST/api/agents/{id}/images/prunePrune unused images
images:delete

Remove images

ScopeAgentRequiresimages:readEndpoints
1 endpoint
  • DELETE/api/agents/{id}/images/{imageId}Remove an image
images:upload

Load images from uploaded archives

ScopeAgentRequiresimages:readEndpoints
5 endpoints
  • POST/api/agents/{id}/images/uploadUpload an image
  • 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
images:patch

Patch vulnerable packages in images

ScopeAgentRequiresimages:readvulnerabilities:listactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/images/{imageId}/patchPatch image
volumes:list

List volumes, volume counts, and volume sizes

ScopeAgentEndpoints
3 endpoints
  • GET/api/agents/{id}/volumesList volumes
  • GET/api/agents/{id}/volumes/countsGet volume usage counts
  • GET/api/agents/{id}/volumes/sizesGet volume sizes
volumes:read

View a volume, its usage, files, backups, and backup policy

ScopeAgentRequiresvolumes:listEndpoints
13 endpoints
  • GET/api/agents/{id}/backups/historyList an environment's backup history
  • GET/api/agents/{id}/volumes/backups/{backupId}/downloadDownload volume backup
  • GET/api/agents/{id}/volumes/backups/{backupId}/filesList files in a volume backup
  • GET/api/agents/{id}/volumes/backups/{backupId}/files/browseBrowse files in a volume backup
  • GET/api/agents/{id}/volumes/backups/{backupId}/files/existsCheck if backup contains path
  • GET/api/agents/{id}/volumes/{volumeName}Get volume by name
  • GET/api/agents/{id}/volumes/{volumeName}/backupsList volume backups
  • GET/api/agents/{id}/volumes/{volumeName}/backups/policyGet volume backup policies
  • GET/api/agents/{id}/volumes/{volumeName}/usageGet volume usage
  • GET/api/agents/{id}/volumes/{volumeName}/workspaceGet volume workspace
  • PATCH/api/agents/{id}/volumes/{volumeName}/workspaceUpdate volume workspace
  • GET/api/agents/{id}/volumes/{volumeName}/workspace/fileGet volume workspace file
  • GET/api/agents/{id}/volumes/{volumeName}/workspace/file/downloadDownload volume workspace file
volumes:create

Create volumes

ScopeAgentRequiresvolumes:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/volumesCreate a volume
volumes:rename

Rename volumes

ScopeAgentRequiresvolumes:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/volumes/{volumeName}/renameRename a volume
volumes:delete

Remove volumes and delete files inside volumes

ScopeAgentRequiresvolumes:readactivities:readEndpoints
4 endpoints
  • DELETE/api/agents/{id}/volumes/{volumeName}Remove a volume
  • PATCH/api/agents/{id}/volumes/{volumeName}/workspaceUpdate volume workspace
  • PATCH/api/agents/{id}/volumes/{volumeName}/workspaceUpdate volume workspace
  • PATCH/api/agents/{id}/volumes/{volumeName}/workspaceUpdate volume workspace
volumes:prune

Remove unused volumes

ScopeAgentRequiresvolumes:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/volumes/prunePrune unused volumes
volumes:upload

Upload and change files inside volumes and upload volume backups

ScopeAgentRequiresvolumes:readactivities:readEndpoints
10 endpoints
  • 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
  • POST/api/agents/{id}/volumes/{volumeName}/backups/uploadUpload and restore volume backup
  • PATCH/api/agents/{id}/volumes/{volumeName}/workspaceUpdate volume workspace
  • PATCH/api/agents/{id}/volumes/{volumeName}/workspaceUpdate volume workspace
  • PATCH/api/agents/{id}/volumes/{volumeName}/workspaceUpdate volume workspace
  • PATCH/api/agents/{id}/volumes/{volumeName}/workspaceUpdate volume workspace
  • PATCH/api/agents/{id}/volumes/{volumeName}/workspaceUpdate volume workspace
volumes:backup

Create, delete, upload, and restore volume backups and change backup policies

ScopeAgentRequiresvolumes:readactivities:readEndpoints
8 endpoints
  • POST/api/agents/{id}/volumes/backups/discoverDiscover volume backups on an S3 destination
  • DELETE/api/agents/{id}/volumes/backups/{backupId}Delete volume backup
  • POST/api/agents/{id}/volumes/backups/{backupId}/uploadUpload volume backup
  • POST/api/agents/{id}/volumes/{volumeName}/backupsCreate volume backup
  • PUT/api/agents/{id}/volumes/{volumeName}/backups/policyUpdate volume backup policies
  • POST/api/agents/{id}/volumes/{volumeName}/backups/{backupId}Restore volume backup
  • POST/api/agents/{id}/volumes/{volumeName}/backups/{backupId}Restore volume backup
  • PATCH/api/agents/{id}/volumes/{volumeName}/workspaceUpdate volume workspace
networks:list

List networks and network counts

ScopeAgentEndpoints
2 endpoints
  • GET/api/agents/{id}/networksList networks
  • GET/api/agents/{id}/networks/countsNetwork counts
networks:read

View a network and the network topology

ScopeAgentRequiresnetworks:listEndpoints
2 endpoints
  • GET/api/agents/{id}/networks/topologyGet network topology
  • GET/api/agents/{id}/networks/{networkId}Get network
networks:create

Create networks

ScopeAgentRequiresnetworks:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/networksCreate network
networks:delete

Remove networks

ScopeAgentRequiresnetworks:readactivities:readEndpoints
1 endpoint
  • DELETE/api/agents/{id}/networks/{networkId}Delete network
networks:prune

Remove unused networks

ScopeAgentRequiresnetworks:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/networks/prunePrune networks
networks:connect

Connect containers to networks

ScopeAgentRequiresnetworks:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/networks/{networkId}Connect or disconnect a container
networks:disconnect

Disconnect containers from networks

ScopeAgentRequiresnetworks:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/networks/{networkId}Connect or disconnect a container
swarm:read

View cluster status, info, tasks, and identity

ScopeAgentEndpoints
4 endpoints
  • GET/api/agents/{id}/swarm/infoGet swarm info
  • GET/api/agents/{id}/swarm/statusGet swarm status
  • GET/api/agents/{id}/swarm/tasksList swarm tasks
  • GET/api/swarm/identityGet local swarm node identity
swarm:update

Change the cluster spec

ScopeAgentRequiresswarm:readEndpoints
1 endpoint
  • PUT/api/agents/{id}/swarm/specUpdate swarm spec
swarm:init

Initialize a new cluster

ScopeAgentRequiresswarm:readEndpoints
1 endpoint
  • POST/api/agents/{id}/swarm/initInitialize swarm
swarm:join

Join a cluster and add environments to it

ScopeAgentRequiresswarm:readEndpoints
3 endpoints
  • POST/api/agents/{id}/swarm/joinJoin swarm
  • POST/api/agents/{id}/swarm/join/agentsJoin environments to a swarm
  • GET/api/agents/{id}/swarm/join/candidatesList environments available for Easy Join
swarm:leave

Leave the cluster

ScopeAgentRequiresswarm:readEndpoints
1 endpoint
  • POST/api/agents/{id}/swarm/leaveLeave swarm
swarm:unlock

Unlock the cluster and view or rotate the unlock key and join tokens

ScopeAgentRequiresswarm:readEndpoints
4 endpoints
  • GET/api/agents/{id}/swarm/join/tokensGet swarm join tokens
  • POST/api/agents/{id}/swarm/join/tokensRotate swarm join tokens
  • POST/api/agents/{id}/swarm/unlockUnlock swarm
  • GET/api/agents/{id}/swarm/unlock/keyGet swarm unlock key
swarm-services:list

List services

ScopeAgentRequiresswarm:readEndpoints
1 endpoint
  • GET/api/agents/{id}/swarm/servicesList swarm services
swarm-services:read

View a service and its tasks

ScopeAgentRequiresswarm-services:listEndpoints
2 endpoints
  • GET/api/agents/{id}/swarm/services/{serviceId}Get swarm service
  • GET/api/agents/{id}/swarm/services/{serviceId}/tasksList tasks for a swarm service
swarm-services:create

Create services

ScopeAgentRequiresswarm-services:readEndpoints
1 endpoint
  • POST/api/agents/{id}/swarm/servicesCreate swarm service
swarm-services:update

Update, scale, or roll back a service

ScopeAgentRequiresswarm-services:readEndpoints
3 endpoints
  • 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
swarm-services:delete

Remove services

ScopeAgentRequiresswarm-services:readEndpoints
1 endpoint
  • DELETE/api/agents/{id}/swarm/services/{serviceId}Delete swarm service
swarm-services:logs

View service logs

ScopeAgentRequiresswarm-services:readEndpoints
1 endpoint
  • GET/api/agents/{id}/ws/swarm/services/{serviceId}/logs
swarm-stacks:list

List stacks

ScopeAgentRequiresswarm:readEndpoints
1 endpoint
  • GET/api/agents/{id}/swarm/stacksList swarm stacks
swarm-stacks:read

View a stack, its services, tasks, and source

ScopeAgentRequiresswarm-stacks:listEndpoints
4 endpoints
  • GET/api/agents/{id}/swarm/stacks/{name}Get swarm stack
  • GET/api/agents/{id}/swarm/stacks/{name}/servicesList swarm stack services
  • GET/api/agents/{id}/swarm/stacks/{name}/sourceGet swarm stack source
  • GET/api/agents/{id}/swarm/stacks/{name}/tasksList swarm stack tasks
swarm-stacks:create

Deploy stacks and render stack configs

ScopeAgentRequiresswarm-stacks:readEndpoints
2 endpoints
  • POST/api/agents/{id}/swarm/stacksDeploy swarm stack
  • POST/api/agents/{id}/swarm/stacks/config/renderRender/validate swarm stack config
swarm-stacks:update

Change a stack's source

ScopeAgentRequiresswarm-stacks:readEndpoints
3 endpoints
  • POST/api/agents/{id}/swarm/stacks/{name}/downBring down swarm stack
  • PATCH/api/agents/{id}/swarm/stacks/{name}/sourceUpdate swarm stack source
  • POST/api/agents/{id}/swarm/stacks/{name}/upBring up swarm stack
swarm-stacks:delete

Remove stacks

ScopeAgentRequiresswarm-stacks:readEndpoints
2 endpoints
  • DELETE/api/agents/{id}/gitops/syncs/{syncId}Delete a GitOps sync
  • DELETE/api/agents/{id}/swarm/stacks/{name}Delete swarm stack
swarm-nodes:list

List nodes

ScopeAgentRequiresswarm:readEndpoints
1 endpoint
  • GET/api/agents/{id}/swarm/nodesList swarm nodes
swarm-nodes:read

View a node and its tasks

ScopeAgentRequiresswarm-nodes:listEndpoints
2 endpoints
  • GET/api/agents/{id}/swarm/nodes/{nodeId}Get swarm node
  • GET/api/agents/{id}/swarm/nodes/{nodeId}/tasksList tasks for a swarm node
swarm-nodes:update

Update node availability, labels, and agent deployments

ScopeAgentRequiresswarm-nodes:readEndpoints
6 endpoints
  • POST/api/agents/{id}/swarm/nodes/agents/reconcileReconcile swarm node agent bindings
  • PATCH/api/agents/{id}/swarm/nodes/{nodeId}Update swarm node
  • DELETE/api/agents/{id}/swarm/nodes/{nodeId}/agent/bindingDetach a visible environment from a swarm node
  • PUT/api/agents/{id}/swarm/nodes/{nodeId}/agent/bindingAttach a visible environment to a swarm node
  • DELETE/api/agents/{id}/swarm/nodes/{nodeId}/agent/deploymentRemove a dedicated swarm node agent registration
  • POST/api/agents/{id}/swarm/nodes/{nodeId}/agent/deploymentGet swarm node agent deployment snippets
swarm-nodes:delete

Remove nodes from the cluster

ScopeAgentRequiresswarm-nodes:readEndpoints
1 endpoint
  • DELETE/api/agents/{id}/swarm/nodes/{nodeId}Delete swarm node
swarm-nodes:promote

Promote a worker node to manager

ScopeAgentRequiresswarm-nodes:readEndpoints
1 endpoint
  • POST/api/agents/{id}/swarm/nodes/{nodeId}Promote or demote swarm node
swarm-nodes:demote

Demote a manager node to worker

ScopeAgentRequiresswarm-nodes:readEndpoints
1 endpoint
  • POST/api/agents/{id}/swarm/nodes/{nodeId}Promote or demote swarm node
swarm-configs:list

List configs

ScopeAgentRequiresswarm:readEndpoints
1 endpoint
  • GET/api/agents/{id}/swarm/configsList swarm configs
swarm-configs:read

View a config

ScopeAgentRequiresswarm-configs:listEndpoints
1 endpoint
  • GET/api/agents/{id}/swarm/configs/{configId}Get swarm config
swarm-configs:create

Create configs

ScopeAgentRequiresswarm-configs:readEndpoints
1 endpoint
  • POST/api/agents/{id}/swarm/configsCreate swarm config
swarm-configs:update

Change configs

ScopeAgentRequiresswarm-configs:readEndpoints
1 endpoint
  • PUT/api/agents/{id}/swarm/configs/{configId}Update swarm config labels
swarm-configs:delete

Remove configs

ScopeAgentRequiresswarm-configs:readEndpoints
1 endpoint
  • DELETE/api/agents/{id}/swarm/configs/{configId}Delete swarm config
swarm-secrets:list

List secrets

ScopeAgentRequiresswarm:readEndpoints
1 endpoint
  • GET/api/agents/{id}/swarm/secretsList swarm secrets
swarm-secrets:read

View secret metadata; the value is never included

ScopeAgentRequiresswarm-secrets:listEndpoints
1 endpoint
  • GET/api/agents/{id}/swarm/secrets/{secretId}Get swarm secret
swarm-secrets:create

Create secrets

ScopeAgentRequiresswarm-secrets:readEndpoints
1 endpoint
  • POST/api/agents/{id}/swarm/secretsCreate swarm secret
swarm-secrets:update

Change secrets

ScopeAgentRequiresswarm-secrets:readEndpoints
1 endpoint
  • PUT/api/agents/{id}/swarm/secrets/{secretId}Update swarm secret labels
swarm-secrets:delete

Remove secrets

ScopeAgentRequiresswarm-secrets:readEndpoints
1 endpoint
  • DELETE/api/agents/{id}/swarm/secrets/{secretId}Delete swarm secret
podman:read

View Podman status and info

ScopeAgentEndpoints
2 endpoints
  • GET/api/agents/{id}/podman/infoGet Podman info
  • GET/api/agents/{id}/podman/statusGet Podman status
podman:autoupdate

Run podman auto-update

ScopeAgentRequirespodman:readEndpoints
1 endpoint
  • POST/api/agents/{id}/podman/autoupdateRun Podman auto-update
podman-pods:list

List pods

ScopeAgentRequirespodman:readEndpoints
1 endpoint
  • GET/api/agents/{id}/podman/podsList pods
podman-pods:read

View a pod, its processes, and pod stats

ScopeAgentRequirespodman-pods:listEndpoints
3 endpoints
  • GET/api/agents/{id}/podman/pods/statsGet pod stats
  • GET/api/agents/{id}/podman/pods/{podId}Inspect pod
  • GET/api/agents/{id}/podman/pods/{podId}/topList pod processes
podman-pods:create

Create pods

ScopeAgentRequirespodman-pods:readEndpoints
1 endpoint
  • POST/api/agents/{id}/podman/podsCreate pod
podman-pods:delete

Remove pods

ScopeAgentRequirespodman-pods:readEndpoints
1 endpoint
  • DELETE/api/agents/{id}/podman/pods/{podId}Remove pod
podman-pods:prune

Remove every stopped pod

ScopeAgentRequirespodman-pods:readEndpoints
1 endpoint
  • POST/api/agents/{id}/podman/pods/prunePrune pods
podman-pods:start

Start pods

ScopeAgentRequirespodman-pods:readEndpoints
1 endpoint
  • POST/api/agents/{id}/podman/pods/{podId}Run pod lifecycle action
podman-pods:stop

Stop pods

ScopeAgentRequirespodman-pods:readEndpoints
1 endpoint
  • POST/api/agents/{id}/podman/pods/{podId}Run pod lifecycle action
podman-pods:restart

Restart pods

ScopeAgentRequirespodman-pods:readEndpoints
1 endpoint
  • POST/api/agents/{id}/podman/pods/{podId}Run pod lifecycle action
podman-pods:pause

Pause and unpause pods

ScopeAgentRequirespodman-pods:readEndpoints
2 endpoints
  • POST/api/agents/{id}/podman/pods/{podId}Run pod lifecycle action
  • POST/api/agents/{id}/podman/pods/{podId}Run pod lifecycle action
podman-pods:kill

Send a signal to a pod's containers

ScopeAgentRequirespodman-pods:readEndpoints
1 endpoint
  • POST/api/agents/{id}/podman/pods/{podId}Run pod lifecycle action
podman-quadlets:list

List quadlets

ScopeAgentRequirespodman:readEndpoints
1 endpoint
  • GET/api/agents/{id}/podman/quadletsList quadlets
podman-quadlets:read

View a quadlet and its file

ScopeAgentRequirespodman-quadlets:listEndpoints
2 endpoints
  • GET/api/agents/{id}/podman/quadlets/{name}Get quadlet
  • GET/api/agents/{id}/podman/quadlets/{name}/fileGet quadlet file
podman-quadlets:create

Install quadlets

ScopeAgentRequirespodman-quadlets:readEndpoints
1 endpoint
  • POST/api/agents/{id}/podman/quadletsInstall quadlet
podman-quadlets:update

Replace a quadlet file

ScopeAgentRequirespodman-quadlets:readEndpoints
1 endpoint
  • PUT/api/agents/{id}/podman/quadlets/{name}Update quadlet
podman-quadlets:delete

Remove quadlets

ScopeAgentRequirespodman-quadlets:readEndpoints
1 endpoint
  • DELETE/api/agents/{id}/podman/quadlets/{name}Remove quadlet
podman-quadlets:start

Start a quadlet's systemd unit

ScopeAgentRequirespodman-quadlets:readEndpoints
1 endpoint
  • POST/api/agents/{id}/podman/quadlets/{name}Run quadlet lifecycle action
podman-quadlets:stop

Stop a quadlet's systemd unit

ScopeAgentRequirespodman-quadlets:readEndpoints
1 endpoint
  • POST/api/agents/{id}/podman/quadlets/{name}Run quadlet lifecycle action
podman-quadlets:restart

Restart a quadlet's systemd unit

ScopeAgentRequirespodman-quadlets:readEndpoints
1 endpoint
  • POST/api/agents/{id}/podman/quadlets/{name}Run quadlet lifecycle action
podman-secrets:list

List secrets

ScopeAgentRequirespodman:readEndpoints
1 endpoint
  • GET/api/agents/{id}/podman/secretsList Podman secrets
podman-secrets:read

View secret metadata; the value is never included

ScopeAgentRequirespodman-secrets:listEndpoints
1 endpoint
  • GET/api/agents/{id}/podman/secrets/{secretId}Inspect Podman secret
podman-secrets:create

Create secrets

ScopeAgentRequirespodman-secrets:readEndpoints
1 endpoint
  • POST/api/agents/{id}/podman/secretsCreate Podman secret
podman-secrets:update

Replace the value, driver, and labels of a secret

ScopeAgentRequirespodman-secrets:readEndpoints
1 endpoint
  • PUT/api/agents/{id}/podman/secrets/{secretId}Replace Podman secret
podman-secrets:delete

Remove secrets

ScopeAgentRequirespodman-secrets:readEndpoints
1 endpoint
  • DELETE/api/agents/{id}/podman/secrets/{secretId}Remove Podman secret
podman-kube:read

Generate Kubernetes YAML from existing pods, containers, or volumes

ScopeAgentRequirespodman:readEndpoints
1 endpoint
  • POST/api/agents/{id}/podman/kube/generateGenerate kube YAML
podman-kube:create

Create pods and containers from Kubernetes YAML

ScopeAgentRequirespodman:readEndpoints
1 endpoint
  • POST/api/agents/{id}/podman/kube/playPlay kube YAML
podman-kube:delete

Remove pods and containers created from Kubernetes YAML

ScopeAgentRequirespodman:readEndpoints
1 endpoint
  • POST/api/agents/{id}/podman/kube/downTear down kube YAML
gitops:list

List GitOps syncs

ScopeAgentEndpoints
1 endpoint
  • GET/api/agents/{id}/gitops/syncsList GitOps syncs
gitops:read

View a sync, its status, and its files

ScopeAgentRequiresgitops:listEndpoints
3 endpoints
  • GET/api/agents/{id}/gitops/syncs/{syncId}Get a GitOps sync
  • GET/api/agents/{id}/gitops/syncs/{syncId}/filesBrowse GitOps sync files
  • GET/api/agents/{id}/gitops/syncs/{syncId}/statusGet GitOps sync status
gitops:create

Create and import syncs

ScopeAgentRequiresgitops:readEndpoints
2 endpoints
  • POST/api/agents/{id}/gitops/syncsCreate a GitOps sync
  • POST/api/agents/{id}/gitops/syncs/importImport GitOps syncs
gitops:update

Change syncs

ScopeAgentRequiresgitops:readEndpoints
1 endpoint
  • PATCH/api/agents/{id}/gitops/syncs/{syncId}Update a GitOps sync
gitops:delete

Delete syncs

ScopeAgentRequiresgitops:readEndpoints
1 endpoint
  • DELETE/api/agents/{id}/gitops/syncs/{syncId}Delete a GitOps sync
gitops:sync

Run a sync now

ScopeAgentRequiresgitops:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/gitops/syncs/{syncId}Perform a GitOps sync
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

ScopeAgentRequiresgitops:readEndpoints
3 endpoints
  • POST/api/agents/{id}/gitops/syncsCreate a GitOps sync
  • POST/api/agents/{id}/gitops/syncs/importImport GitOps syncs
  • PATCH/api/agents/{id}/gitops/syncs/{syncId}Update a GitOps 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)

ScopeAgentRequiresgitops:readEndpoints
8 endpoints
  • POST/api/agents/{id}/gitops/syncsCreate a GitOps sync
  • DELETE/api/agents/{id}/gitops/syncs/{syncId}Delete 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/historyList 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/previewPreview a Git backup
  • POST/api/agents/{id}/gitops/syncs/{syncId}/backup/resolveResolve a Git backup conflict
webhooks:list

List webhooks

ScopeAgentEndpoints
1 endpoint
  • GET/api/agents/{id}/webhooksList webhooks
webhooks:create

Create webhooks

ScopeAgentRequireswebhooks:listEndpoints
1 endpoint
  • POST/api/agents/{id}/webhooksCreate webhook
webhooks:update

Change webhooks

ScopeAgentRequireswebhooks:listEndpoints
1 endpoint
  • PATCH/api/agents/{id}/webhooks/{webhookId}Update webhook
webhooks:delete

Delete webhooks

ScopeAgentRequireswebhooks:listEndpoints
1 endpoint
  • DELETE/api/agents/{id}/webhooks/{webhookId}Delete webhook
jobs:list

List jobs and their runs

ScopeAgentEndpoints
2 endpoints
  • GET/api/agents/{id}/jobsList all background jobs
  • GET/api/agents/{id}/jobs/{jobId}/runsList job runs
jobs:read

View job schedules and run details

ScopeAgentRequiresjobs:listEndpoints
2 endpoints
  • GET/api/agents/{id}/jobs/schedulesGet job schedules
  • GET/api/agents/{id}/jobs/{jobId}/runs/{runId}Get job run
jobs:update

Change job schedules

ScopeAgentRequiresjobs:readEndpoints
1 endpoint
  • PATCH/api/agents/{id}/jobs/schedulesUpdate job schedules
jobs:run

Run a job now

ScopeAgentRequiresjobs:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/jobs/{jobId}Run a job action
jobs:restart

Restart a continuous job worker

ScopeAgentRequiresjobs:readEndpoints
1 endpoint
  • POST/api/agents/{id}/jobs/{jobId}Run a job action
jobs:retry

Retry a job run

ScopeAgentRequiresjobs:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/jobs/{jobId}/runs/{runId}Retry, cancel, or acknowledge a job run
jobs:cancel

Cancel a job run

ScopeAgentRequiresjobs:readEndpoints
1 endpoint
  • POST/api/agents/{id}/jobs/{jobId}/runs/{runId}Retry, cancel, or acknowledge a job run
jobs:ack

Acknowledge a job run

ScopeAgentRequiresjobs:readEndpoints
1 endpoint
  • POST/api/agents/{id}/jobs/{jobId}/runs/{runId}Retry, cancel, or acknowledge a job run
notifications:list

List notification provider settings

ScopeGlobalEndpoints
1 endpoint
  • GET/api/notifications/settingsGet all notification settings
notifications:read

View a notification provider's settings

ScopeGlobalRequiresnotifications:listEndpoints
1 endpoint
  • GET/api/notifications/settings/{provider}Get notification settings by provider
notifications:update

Create or update notification provider settings

ScopeGlobalRequiresnotifications:readEndpoints
1 endpoint
  • POST/api/notifications/settingsCreate or update notification settings
notifications:delete

Remove notification provider settings

ScopeGlobalRequiresnotifications:readEndpoints
1 endpoint
  • DELETE/api/notifications/settings/{provider}Delete notification settings
notifications:test

Send a test notification

ScopeGlobalRequiresnotifications:readEndpoints
1 endpoint
  • POST/api/notifications/settings/{provider}Test notification
system:read

View system health, Docker info, disk usage, stats, and upgrade status

ScopeAgentEndpoints
8 endpoints
  • GET/api/agents/{id}/system/dfGet reclaimable disk usage
  • GET/api/agents/{id}/system/docker/infoGet Docker info
  • HEAD/api/agents/{id}/system/healthCheck system health
  • GET/api/agents/{id}/system/upgrade/checkCheck for system upgrade
  • GET/api/agents/{id}/system/upgrade/jobs/currentGet current upgrade job
  • GET/api/agents/{id}/system/upgrade/progressStream upgrade progress
  • GET/api/agents/{id}/ws/system/stats
  • GET/api/streamMultiplexed client stream
system:prune

Remove unused Docker resources

ScopeAgentRequiressystem:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/system/prunePrune Docker resources
system:upgrade

Upgrade Arcane

ScopeAgentRequiressystem:readEndpoints
2 endpoints
  • POST/api/agents/{id}/system/upgradeTrigger system upgrade
  • POST/api/agents/{id}/system/upgrade/jobsStart upgrade job
image-updates:list

View update summaries, update info for images, and updater history

ScopeAgentEndpoints
3 endpoints
  • GET/api/agents/{id}/images/updates/refsGet persisted update info for image references
  • GET/api/agents/{id}/images/updates/summaryGet update summary
  • GET/api/agents/{id}/updater/historyGet updater history
image-updates:read

View updater status and release notes

ScopeAgentRequiresimage-updates:listEndpoints
2 endpoints
  • GET/api/agents/{id}/images/updates/releasenotesGet image release notes
  • GET/api/agents/{id}/updater/statusGet updater status
image-updates:check

Check images and projects for updates

ScopeAgentRequiresimage-updates:readactivities:readEndpoints
6 endpoints
  • GET/api/agents/{id}/images/updates/checkCheck image update by reference
  • POST/api/agents/{id}/images/updates/checkCheck all or multiple images
  • POST/api/agents/{id}/images/updates/checkCheck 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)
  • POST/api/agents/{id}/updater/projects/{projectId}/checkCheck project service updates
image-updates:apply

Pull new images and recreate containers or projects with them

ScopeAgentRequiresimage-updates:readactivities:readEndpoints
2 endpoints
  • POST/api/agents/{id}/containers/{containerId}/updateUpdate a single container
  • POST/api/agents/{id}/updater/runRun updater
vulnerabilities:list

View environment-wide vulnerability overviews, ignores, and patch targets

ScopeAgentEndpoints
8 endpoints
  • GET/api/agents/{id}/images/patches/targetsList image patch targets
  • POST/api/agents/{id}/images/vulnerabilities/summariesGet vulnerability scan summaries
  • GET/api/agents/{id}/vulnerabilities/allList environment vulnerabilities
  • GET/api/agents/{id}/vulnerabilities/exportExport environment vulnerabilities
  • GET/api/agents/{id}/vulnerabilities/ignoredList ignored vulnerabilities
  • GET/api/agents/{id}/vulnerabilities/imagesList vulnerability image options
  • GET/api/agents/{id}/vulnerabilities/overviewGet environment vulnerability risk overview
  • GET/api/agents/{id}/vulnerabilities/summaryGet environment vulnerability summary
vulnerabilities:read

View an image's vulnerabilities and scanner status

ScopeAgentRequiresvulnerabilities:listEndpoints
4 endpoints
  • GET/api/agents/{id}/images/{imageId}/vulnerabilitiesGet vulnerability scan result
  • GET/api/agents/{id}/images/{imageId}/vulnerabilities/listList image vulnerabilities
  • GET/api/agents/{id}/images/{imageId}/vulnerabilities/summaryGet vulnerability scan summary
  • GET/api/agents/{id}/vulnerabilities/scannerGet vulnerability scanner status
vulnerabilities:scan

Scan images for vulnerabilities

ScopeAgentRequiresvulnerabilities:readactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/images/{imageId}/vulnerabilities/scanScan image for vulnerabilities
vulnerabilities:update

Ignore or unignore vulnerabilities

ScopeAgentRequiresvulnerabilities:readEndpoints
4 endpoints
  • POST/api/agents/{id}/vulnerabilities/ignoredIgnore a vulnerability
  • POST/api/agents/{id}/vulnerabilities/ignored/bulkIgnore or restore vulnerabilities in bulk
  • POST/api/agents/{id}/vulnerabilities/ignored/bulkIgnore or restore vulnerabilities in bulk
  • DELETE/api/agents/{id}/vulnerabilities/ignored/{ignoreId}Unignore a vulnerability
build-workspaces:list

Browse build workspace directories

ScopeAgentEndpoints
1 endpoint
  • GET/api/agents/{id}/builds/workspaceGet build workspace
build-workspaces:read

View and download build workspace files

ScopeAgentRequiresbuild-workspaces:listEndpoints
3 endpoints
  • PATCH/api/agents/{id}/builds/workspaceUpdate build workspace
  • GET/api/agents/{id}/builds/workspace/fileGet build workspace file
  • GET/api/agents/{id}/builds/workspace/file/downloadDownload build workspace file
build-workspaces:create

Upload files and create directories

ScopeAgentRequiresbuild-workspaces:readEndpoints
10 endpoints
  • PATCH/api/agents/{id}/builds/workspaceUpdate build workspace
  • PATCH/api/agents/{id}/builds/workspaceUpdate build workspace
  • PATCH/api/agents/{id}/builds/workspaceUpdate build workspace
  • PATCH/api/agents/{id}/builds/workspaceUpdate build workspace
  • PATCH/api/agents/{id}/builds/workspaceUpdate build workspace
  • POST/api/agents/{id}/builds/workspace/uploadUpload build workspace file
  • 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
build-workspaces:delete

Delete files and directories

ScopeAgentRequiresbuild-workspaces:readEndpoints
3 endpoints
  • PATCH/api/agents/{id}/builds/workspaceUpdate build workspace
  • PATCH/api/agents/{id}/builds/workspaceUpdate build workspace
  • PATCH/api/agents/{id}/builds/workspaceUpdate build workspace
activities:list

List and stream activities

ScopeAgentEndpoints
2 endpoints
  • GET/api/agents/{id}/activitiesList background activities
  • GET/api/streamMultiplexed client stream
activities:read

View an activity and its messages

ScopeAgentRequiresactivities:listEndpoints
1 endpoint
  • GET/api/agents/{id}/activities/{activityId}Get background activity
activities:cancel

Cancel a running activity

ScopeAgentRequiresactivities:readEndpoints
1 endpoint
  • POST/api/agents/{id}/activities/{activityId}Cancel a background activity
activities:delete

Clear activity history

ScopeAgentRequiresactivities:readEndpoints
1 endpoint
  • DELETE/api/agents/{id}/activities/historyClear background activity history
environment-settings:read

View per-environment Docker, storage, security, timeouts, builds, activity, and automations settings

ScopeAgentEndpoints
2 endpoints
  • GET/api/agents/{id}/projects/directoriesList projects directories
  • GET/api/agents/{id}/settingsGet environment settings
environment-settings:update

Change per-environment Docker, storage, security, timeouts, builds, activity, and automations settings

ScopeAgentRequiresenvironment-settings:readEndpoints
1 endpoint
  • PATCH/api/agents/{id}/settingsUpdate environment settings

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

EndpointAccess
GET/api/agent/mtls/ca

Download Arcane-generated agent mTLS CA

Permissionenvironments:pair
GET/api/agents

List environments

AccessAny signed-in user
POST/api/agents

Create an environment

Permissionenvironments:create
POST/api/agents/enroll

Enroll an agent

AccessPublic
POST/api/agents/pair

Pair agent with manager

AccessPublic
DELETE/api/agents/{id}

Delete an environment

Permissionenvironments:delete
GET/api/agents/{id}

Get an environment

Permissionenvironments:read
PATCH/api/agents/{id}

Update an environment

Permissionenvironments:update
GET/api/agents/{id}/activities

List background activities

Permissionactivities:list
DELETE/api/agents/{id}/activities/history

Clear background activity history

Permissionactivities:delete
GET/api/agents/{id}/activities/{activityId}

Get background activity

Permissionactivities:read
POST/api/agents/{id}/activities/{activityId}

Cancel a background activity

?action=cancelactivities:cancel
GET/api/agents/{id}/backups/history

List an environment's backup history

Permissionvolumes:read
DELETE/api/agents/{id}/backups/{backupId}

Delete Arcane system backup

Permissionsystem-backups:delete
POST/api/agents/{id}/backups/{backupId}

Restore Arcane system backup

?action=restoresystem-backups:restore?action=restorefilessystem-backups:restore
Global admin only
POST/api/agents/{id}/backups/{backupId}/files/browse

Browse project files in an Arcane system backup

Permissionsystem-backups:read
POST/api/agents/{id}/backups/{backupId}/upload

Upload Arcane system backup

Permissionsystem-backups:upload
GET/api/agents/{id}/builds/workspace

Get build workspace

Permissionbuild-workspaces:list
PATCH/api/agents/{id}/builds/workspace

Update build workspace

Permissionbuild-workspaces:readfileChanges.operation=create_filebuild-workspaces:createfileChanges.operation=create_folderbuild-workspaces:createfileChanges.operation=update_filebuild-workspaces:createfileChanges.operation=renamebuild-workspaces:createfileChanges.operation=renamebuild-workspaces:deletefileChanges.operation=movebuild-workspaces:createfileChanges.operation=movebuild-workspaces:deletefileChanges.operation=deletebuild-workspaces:delete
GET/api/agents/{id}/builds/workspace/file

Get build workspace file

Permissionbuild-workspaces:read
GET/api/agents/{id}/builds/workspace/file/download

Download build workspace file

Permissionbuild-workspaces:read
POST/api/agents/{id}/builds/workspace/upload

Upload build workspace file

Permissionbuild-workspaces:create
GET/api/agents/{id}/containers

List containers

Permissioncontainers:list
POST/api/agents/{id}/containers

Create container

Permissioncontainers:create
POST/api/agents/{id}/containers/compose

Generate compose file

Permissioncontainers:read
GET/api/agents/{id}/containers/counts

Container status counts

Permissioncontainers:list
DELETE/api/agents/{id}/containers/{containerId}

Delete container

Permissioncontainers:delete
GET/api/agents/{id}/containers/{containerId}

Get container

Permissioncontainers:read
POST/api/agents/{id}/containers/{containerId}

Run container lifecycle action

?action=killcontainers:kill?action=pausecontainers:pause?action=restartcontainers:restart?action=startcontainers:start?action=stopcontainers:stop?action=unpausecontainers:pause
PUT/api/agents/{id}/containers/{containerId}/autoupdate

Set container auto-update

Permissioncontainers:autoupdate
POST/api/agents/{id}/containers/{containerId}/commit

Commit container

Permissionimages:commit
GET/api/agents/{id}/containers/{containerId}/config

Get container edit config

Permissioncontainers:read
PUT/api/agents/{id}/containers/{containerId}/config

Edit container

Permissioncontainers:update
GET/api/agents/{id}/containers/{containerId}/logs/download

Download container logs

Permissioncontainers:logs
GET/api/agents/{id}/containers/{containerId}/processes

Get container processes

Permissioncontainers:read
POST/api/agents/{id}/containers/{containerId}/redeploy

Redeploy container

Permissioncontainers:redeploy
POST/api/agents/{id}/containers/{containerId}/update

Update a single container

Permissionimage-updates:apply
POST/api/agents/{id}/deployment

Create deployment snippets

Permissionenvironments:pair
GET/api/agents/{id}/deployment/mtls/bundle

Download environment mTLS bundle

Permissionenvironments:pair
GET/api/agents/{id}/deployment/mtls/{fileName}

Download environment mTLS asset

Permissionenvironments:pair
GET/api/agents/{id}/diagnostics/actors

Get actor diagnostics for an environment

Permissiondiagnostics:read
GET/api/agents/{id}/diagnostics/goroutines

Get goroutine diagnostics for an environment

Permissiondiagnostics:read
GET/api/agents/{id}/events/changes

Wait for environment changes

Permissionevents:list
GET/api/agents/{id}/gitops/syncs

List GitOps syncs

Permissiongitops:list
POST/api/agents/{id}/gitops/syncs

Create a GitOps sync

Permissiongitops:createpreDeploy=truegitops:lifecyclemode=backupgitops:backup
POST/api/agents/{id}/gitops/syncs/import

Import GitOps syncs

Permissiongitops:createpreDeploy=truegitops:lifecycle
DELETE/api/agents/{id}/gitops/syncs/{syncId}

Delete a GitOps sync

Permissiongitops:deletemode=backupgitops:backupremoveStack=trueswarm-stacks:delete
GET/api/agents/{id}/gitops/syncs/{syncId}

Get a GitOps sync

Permissiongitops:read
PATCH/api/agents/{id}/gitops/syncs/{syncId}

Update a GitOps sync

Permissiongitops:updatepreDeploy=truegitops:lifecyclemode=backupgitops:backup
POST/api/agents/{id}/gitops/syncs/{syncId}

Perform a GitOps sync

?action=syncgitops:syncmode=backupgitops:backup
GET/api/agents/{id}/gitops/syncs/{syncId}/backup/history

List Git backup history

Permissiongitops:backup
GET/api/agents/{id}/gitops/syncs/{syncId}/backup/history/{commit}

Get a Git backup revision

Permissiongitops:backup
GET/api/agents/{id}/gitops/syncs/{syncId}/backup/preview

Preview a Git backup

Permissiongitops:backup
POST/api/agents/{id}/gitops/syncs/{syncId}/backup/resolve

Resolve a Git backup conflict

Permissiongitops:backup
GET/api/agents/{id}/gitops/syncs/{syncId}/files

Browse GitOps sync files

Permissiongitops:read
GET/api/agents/{id}/gitops/syncs/{syncId}/status

Get GitOps sync status

Permissiongitops:read
GET/api/agents/{id}/images

List images

Permissionimages:list
POST/api/agents/{id}/images/build

Build an image

Permissionimages:buildpush=trueimages:push
GET/api/agents/{id}/images/builds

List image builds

Permissionimages:list
GET/api/agents/{id}/images/builds/{buildId}

Get image build

Permissionimages:read
GET/api/agents/{id}/images/counts

Get image usage counts

Permissionimages:list
GET/api/agents/{id}/images/patches

List image patches

Permissionimages:list
GET/api/agents/{id}/images/patches/targets

List image patch targets

Permissionvulnerabilities:list
POST/api/agents/{id}/images/prune

Prune unused images

Permissionimages:prune
POST/api/agents/{id}/images/pull

Pull an image

Permissionimages:pull
GET/api/agents/{id}/images/search

Search images

Permissionimages:read
GET/api/agents/{id}/images/updates/check

Check image update by reference

Permissionimage-updates:check
POST/api/agents/{id}/images/updates/check

Check all or multiple images

?action=allimage-updates:check?action=batchimage-updates:check
GET/api/agents/{id}/images/updates/check/{imageId}

Check image update by ID

Permissionimage-updates:check
POST/api/agents/{id}/images/updates/check/{imageId}

Check image update by ID (POST)

Permissionimage-updates:check
GET/api/agents/{id}/images/updates/refs

Get persisted update info for image references

Permissionimage-updates:list
GET/api/agents/{id}/images/updates/releasenotes

Get image release notes

Permissionimage-updates:read
GET/api/agents/{id}/images/updates/summary

Get update summary

Permissionimage-updates:list
POST/api/agents/{id}/images/upload

Upload an image

Permissionimages:upload
POST/api/agents/{id}/images/vulnerabilities/summaries

Get vulnerability scan summaries

Permissionvulnerabilities:list
DELETE/api/agents/{id}/images/{imageId}

Remove an image

Permissionimages:delete
GET/api/agents/{id}/images/{imageId}

Get image by ID

Permissionimages:read
POST/api/agents/{id}/images/{imageId}/patch

Patch image

Permissionimages:patch
GET/api/agents/{id}/images/{imageId}/vulnerabilities

Get vulnerability scan result

Permissionvulnerabilities:read
GET/api/agents/{id}/images/{imageId}/vulnerabilities/list

List image vulnerabilities

Permissionvulnerabilities:read
POST/api/agents/{id}/images/{imageId}/vulnerabilities/scan

Scan image for vulnerabilities

Permissionvulnerabilities:scan
GET/api/agents/{id}/images/{imageId}/vulnerabilities/summary

Get vulnerability scan summary

Permissionvulnerabilities:read
GET/api/agents/{id}/images/{name}/attestations

Get image attestations

Permissionimages:read
GET/api/agents/{id}/images/{name}/export

Export image

Permissionimages:read
GET/api/agents/{id}/images/{name}/history

Get image history

Permissionimages:read
POST/api/agents/{id}/images/{name}/tag

Tag image

Permissionimages:tag
GET/api/agents/{id}/jobs

List all background jobs

Permissionjobs:list
GET/api/agents/{id}/jobs/schedules

Get job schedules

Permissionjobs:read
PATCH/api/agents/{id}/jobs/schedules

Update job schedules

Permissionjobs:update
POST/api/agents/{id}/jobs/{jobId}

Run a job action

?action=restartjobs:restart?action=runjobs:run
GET/api/agents/{id}/jobs/{jobId}/runs

List job runs

Permissionjobs:list
GET/api/agents/{id}/jobs/{jobId}/runs/{runId}

Get job run

Permissionjobs:read
POST/api/agents/{id}/jobs/{jobId}/runs/{runId}

Retry, cancel, or acknowledge a job run

?action=ackjobs:ack?action=canceljobs:cancel?action=retryjobs:retry
GET/api/agents/{id}/networks

List networks

Permissionnetworks:list
POST/api/agents/{id}/networks

Create network

Permissionnetworks:create
GET/api/agents/{id}/networks/counts

Network counts

Permissionnetworks:list
POST/api/agents/{id}/networks/prune

Prune networks

Permissionnetworks:prune
GET/api/agents/{id}/networks/topology

Get network topology

Permissionnetworks:read
DELETE/api/agents/{id}/networks/{networkId}

Delete network

Permissionnetworks:delete
GET/api/agents/{id}/networks/{networkId}

Get network

Permissionnetworks:read
POST/api/agents/{id}/networks/{networkId}

Connect or disconnect a container

?action=connectnetworks:connect?action=disconnectnetworks:disconnect
POST/api/agents/{id}/podman/autoupdate

Run Podman auto-update

Permissionpodman:autoupdate
GET/api/agents/{id}/podman/info

Get Podman info

Permissionpodman:read
POST/api/agents/{id}/podman/kube/down

Tear down kube YAML

Permissionpodman-kube:delete
POST/api/agents/{id}/podman/kube/generate

Generate kube YAML

Permissionpodman-kube:read
POST/api/agents/{id}/podman/kube/play

Play kube YAML

Permissionpodman-kube:create
GET/api/agents/{id}/podman/pods

List pods

Permissionpodman-pods:list
POST/api/agents/{id}/podman/pods

Create pod

Permissionpodman-pods:create
POST/api/agents/{id}/podman/pods/prune

Prune pods

Permissionpodman-pods:prune
GET/api/agents/{id}/podman/pods/stats

Get pod stats

Permissionpodman-pods:read
DELETE/api/agents/{id}/podman/pods/{podId}

Remove pod

Permissionpodman-pods:delete
GET/api/agents/{id}/podman/pods/{podId}

Inspect pod

Permissionpodman-pods:read
POST/api/agents/{id}/podman/pods/{podId}

Run pod lifecycle action

?action=killpodman-pods:kill?action=pausepodman-pods:pause?action=restartpodman-pods:restart?action=startpodman-pods:start?action=stoppodman-pods:stop?action=unpausepodman-pods:pause
GET/api/agents/{id}/podman/pods/{podId}/top

List pod processes

Permissionpodman-pods:read
GET/api/agents/{id}/podman/quadlets

List quadlets

Permissionpodman-quadlets:list
POST/api/agents/{id}/podman/quadlets

Install quadlet

Permissionpodman-quadlets:create
DELETE/api/agents/{id}/podman/quadlets/{name}

Remove quadlet

Permissionpodman-quadlets:delete
GET/api/agents/{id}/podman/quadlets/{name}

Get quadlet

Permissionpodman-quadlets:read
POST/api/agents/{id}/podman/quadlets/{name}

Run quadlet lifecycle action

?action=restartpodman-quadlets:restart?action=startpodman-quadlets:start?action=stoppodman-quadlets:stop
PUT/api/agents/{id}/podman/quadlets/{name}

Update quadlet

Permissionpodman-quadlets:update
GET/api/agents/{id}/podman/quadlets/{name}/file

Get quadlet file

Permissionpodman-quadlets:read
GET/api/agents/{id}/podman/secrets

List Podman secrets

Permissionpodman-secrets:list
POST/api/agents/{id}/podman/secrets

Create Podman secret

Permissionpodman-secrets:create
DELETE/api/agents/{id}/podman/secrets/{secretId}

Remove Podman secret

Permissionpodman-secrets:delete
GET/api/agents/{id}/podman/secrets/{secretId}

Inspect Podman secret

Permissionpodman-secrets:read
PUT/api/agents/{id}/podman/secrets/{secretId}

Replace Podman secret

Permissionpodman-secrets:update
GET/api/agents/{id}/podman/status

Get Podman status

Permissionpodman:read
GET/api/agents/{id}/ports

List port mappings

Permissioncontainers:list
GET/api/agents/{id}/projects

List projects

Permissionprojects:list
POST/api/agents/{id}/projects

Create a project

Permissionprojects:create
GET/api/agents/{id}/projects/counts

Get project status counts

Permissionprojects:list
GET/api/agents/{id}/projects/directories

List projects directories

?view=projectsprojects:list?view=settingsenvironment-settings:read
GET/api/agents/{id}/projects/references

List project references

Permissionprojects:list
GET/api/agents/{id}/projects/tags

List project tags

Permissionprojects:list
DELETE/api/agents/{id}/projects/{projectId}

Destroy a project

Permissionprojects:delete
GET/api/agents/{id}/projects/{projectId}

Get a project

Permissionprojects:read
PATCH/api/agents/{id}/projects/{projectId}

Update a project

Permissionprojects:update
POST/api/agents/{id}/projects/{projectId}

Run project action

?action=archiveprojects:archive?action=downprojects:down?action=restartprojects:restart?action=unarchiveprojects:archive?action=updateservicesprojects:update
POST/api/agents/{id}/projects/{projectId}/build

Build project images

Permissionprojects:deploypush=trueimages:push
GET/api/agents/{id}/projects/{projectId}/compose

Get project compose details

Permissionprojects:read
POST/api/agents/{id}/projects/{projectId}/deploy

Deploy, redeploy, or pull a project

?action=pullprojects:deploy?action=redeployprojects:deploy?action=upprojects:deploy
GET/api/agents/{id}/projects/{projectId}/runtime

Get project runtime

Permissionprojects:read
PATCH/api/agents/{id}/projects/{projectId}/tags

Update a project tag

Permissionprojects:update
GET/api/agents/{id}/projects/{projectId}/updates

Get project updates

Permissionprojects:read
GET/api/agents/{id}/projects/{projectId}/workspace

Get project workspace

Permissionprojects:read
PATCH/api/agents/{id}/projects/{projectId}/workspace

Update project workspace

Permissionprojects:update
GET/api/agents/{id}/projects/{projectId}/workspace/file

Get project workspace file

Permissionprojects:read
GET/api/agents/{id}/projects/{projectId}/workspace/file/download

Download project workspace file

Permissionprojects:read
GET/api/agents/{id}/settings

Get environment settings

Permissionenvironment-settings:read
PATCH/api/agents/{id}/settings

Update environment settings

Permissionenvironment-settings:update
GET/api/agents/{id}/settings/public

Get public settings

AccessPublic
GET/api/agents/{id}/swarm/configs

List swarm configs

Permissionswarm-configs:list
POST/api/agents/{id}/swarm/configs

Create swarm config

Permissionswarm-configs:create
DELETE/api/agents/{id}/swarm/configs/{configId}

Delete swarm config

Permissionswarm-configs:delete
GET/api/agents/{id}/swarm/configs/{configId}

Get swarm config

Permissionswarm-configs:read
PUT/api/agents/{id}/swarm/configs/{configId}

Update swarm config labels

Permissionswarm-configs:update
GET/api/agents/{id}/swarm/info

Get swarm info

Permissionswarm:read
POST/api/agents/{id}/swarm/init

Initialize swarm

Permissionswarm:init
POST/api/agents/{id}/swarm/join

Join swarm

Permissionswarm:join
POST/api/agents/{id}/swarm/join/agents

Join environments to a swarm

Permissionswarm:join
GET/api/agents/{id}/swarm/join/candidates

List environments available for Easy Join

Permissionswarm:join
GET/api/agents/{id}/swarm/join/tokens

Get swarm join tokens

Permissionswarm:unlock
POST/api/agents/{id}/swarm/join/tokens

Rotate swarm join tokens

?action=rotateswarm:unlock
POST/api/agents/{id}/swarm/leave

Leave swarm

Permissionswarm:leave
GET/api/agents/{id}/swarm/nodes

List swarm nodes

Permissionswarm-nodes:list
POST/api/agents/{id}/swarm/nodes/agents/reconcile

Reconcile swarm node agent bindings

Permissionswarm-nodes:update
DELETE/api/agents/{id}/swarm/nodes/{nodeId}

Delete swarm node

Permissionswarm-nodes:delete
GET/api/agents/{id}/swarm/nodes/{nodeId}

Get swarm node

Permissionswarm-nodes:read
PATCH/api/agents/{id}/swarm/nodes/{nodeId}

Update swarm node

Permissionswarm-nodes:update
POST/api/agents/{id}/swarm/nodes/{nodeId}

Promote or demote swarm node

?action=demoteswarm-nodes:demote?action=promoteswarm-nodes:promote
DELETE/api/agents/{id}/swarm/nodes/{nodeId}/agent/binding

Detach a visible environment from a swarm node

Permissionswarm-nodes:update
PUT/api/agents/{id}/swarm/nodes/{nodeId}/agent/binding

Attach a visible environment to a swarm node

Permissionswarm-nodes:update
DELETE/api/agents/{id}/swarm/nodes/{nodeId}/agent/deployment

Remove a dedicated swarm node agent registration

Permissionswarm-nodes:update
POST/api/agents/{id}/swarm/nodes/{nodeId}/agent/deployment

Get swarm node agent deployment snippets

Permissionswarm-nodes:update
GET/api/agents/{id}/swarm/nodes/{nodeId}/tasks

List tasks for a swarm node

Permissionswarm-nodes:read
GET/api/agents/{id}/swarm/secrets

List swarm secrets

Permissionswarm-secrets:list
POST/api/agents/{id}/swarm/secrets

Create swarm secret

Permissionswarm-secrets:create
DELETE/api/agents/{id}/swarm/secrets/{secretId}

Delete swarm secret

Permissionswarm-secrets:delete
GET/api/agents/{id}/swarm/secrets/{secretId}

Get swarm secret

Permissionswarm-secrets:read
PUT/api/agents/{id}/swarm/secrets/{secretId}

Update swarm secret labels

Permissionswarm-secrets:update
GET/api/agents/{id}/swarm/services

List swarm services

Permissionswarm-services:list
POST/api/agents/{id}/swarm/services

Create swarm service

Permissionswarm-services:create
DELETE/api/agents/{id}/swarm/services/{serviceId}

Delete swarm service

Permissionswarm-services:delete
GET/api/agents/{id}/swarm/services/{serviceId}

Get swarm service

Permissionswarm-services:read
PATCH/api/agents/{id}/swarm/services/{serviceId}

Scale a swarm service

Permissionswarm-services:update
POST/api/agents/{id}/swarm/services/{serviceId}

Rollback a swarm service

?action=rollbackswarm-services:update
PUT/api/agents/{id}/swarm/services/{serviceId}

Update swarm service

Permissionswarm-services:update
GET/api/agents/{id}/swarm/services/{serviceId}/tasks

List tasks for a swarm service

Permissionswarm-services:read
PUT/api/agents/{id}/swarm/spec

Update swarm spec

Permissionswarm:update
GET/api/agents/{id}/swarm/stacks

List swarm stacks

Permissionswarm-stacks:list
POST/api/agents/{id}/swarm/stacks

Deploy swarm stack

Permissionswarm-stacks:create
POST/api/agents/{id}/swarm/stacks/config/render

Render/validate swarm stack config

Permissionswarm-stacks:create
DELETE/api/agents/{id}/swarm/stacks/{name}

Delete swarm stack

Permissionswarm-stacks:delete
GET/api/agents/{id}/swarm/stacks/{name}

Get swarm stack

Permissionswarm-stacks:read
POST/api/agents/{id}/swarm/stacks/{name}/down

Bring down swarm stack

Permissionswarm-stacks:update
GET/api/agents/{id}/swarm/stacks/{name}/services

List swarm stack services

Permissionswarm-stacks:read
GET/api/agents/{id}/swarm/stacks/{name}/source

Get swarm stack source

Permissionswarm-stacks:read
PATCH/api/agents/{id}/swarm/stacks/{name}/source

Update swarm stack source

Permissionswarm-stacks:update
GET/api/agents/{id}/swarm/stacks/{name}/tasks

List swarm stack tasks

Permissionswarm-stacks:read
POST/api/agents/{id}/swarm/stacks/{name}/up

Bring up swarm stack

Permissionswarm-stacks:update
GET/api/agents/{id}/swarm/status

Get swarm status

Permissionswarm:read
GET/api/agents/{id}/swarm/tasks

List swarm tasks

Permissionswarm:read
POST/api/agents/{id}/swarm/unlock

Unlock swarm

Permissionswarm:unlock
GET/api/agents/{id}/swarm/unlock/key

Get swarm unlock key

Permissionswarm:unlock
POST/api/agents/{id}/sync

Sync environment

Permissionenvironments:sync
POST/api/agents/{id}/system/containers

Run bulk container action

?action=startallcontainers:start?action=startstoppedcontainers:start?action=stopallcontainers:stop
POST/api/agents/{id}/system/convert

Convert docker run command

Permissioncontainers:create
GET/api/agents/{id}/system/df

Get reclaimable disk usage

Permissionsystem:read
GET/api/agents/{id}/system/docker/info

Get Docker info

Permissionsystem:read
HEAD/api/agents/{id}/system/health

Check system health

Permissionsystem:read
POST/api/agents/{id}/system/prune

Prune Docker resources

Permissionsystem:prune
POST/api/agents/{id}/system/upgrade

Trigger system upgrade

Permissionsystem:upgrade
GET/api/agents/{id}/system/upgrade/check

Check for system upgrade

Permissionsystem:read
POST/api/agents/{id}/system/upgrade/jobs

Start upgrade job

Permissionsystem:upgrade
GET/api/agents/{id}/system/upgrade/jobs/current

Get current upgrade job

Permissionsystem:read
GET/api/agents/{id}/system/upgrade/progress

Stream upgrade progress

Permissionsystem:read
POST/api/agents/{id}/test

Test environment connection

Permissionenvironments:read
POST/api/agents/{id}/tunnel/restart

Restart environment agent tunnel

Permissionenvironments:restart
GET/api/agents/{id}/updater/history

Get updater history

Permissionimage-updates:list
POST/api/agents/{id}/updater/projects/{projectId}/check

Check project service updates

Permissionimage-updates:check
POST/api/agents/{id}/updater/run

Run updater

Permissionimage-updates:apply
GET/api/agents/{id}/updater/status

Get updater status

Permissionimage-updates:read
POST/api/agents/{id}/uploads/{kind}

Create an upload session

kind=imageimages:uploadkind=volume-backupvolumes:uploadkind=build-workspacebuild-workspaces:createAccessAny signed-in user
DELETE/api/agents/{id}/uploads/{kind}/{uploadId}

Delete an upload session

kind=imageimages:uploadkind=volume-backupvolumes:uploadkind=build-workspacebuild-workspaces:createAccessAny signed-in user
GET/api/agents/{id}/uploads/{kind}/{uploadId}

Get an upload session

kind=imageimages:uploadkind=volume-backupvolumes:uploadkind=build-workspacebuild-workspaces:createAccessAny signed-in user
PUT/api/agents/{id}/uploads/{kind}/{uploadId}/chunks/{index}

Upload a chunk

kind=imageimages:uploadkind=volume-backupvolumes:uploadkind=build-workspacebuild-workspaces:createAccessAny signed-in user
GET/api/agents/{id}/version

Get environment version

Permissionenvironments:read
GET/api/agents/{id}/volumes

List volumes

Permissionvolumes:list
POST/api/agents/{id}/volumes

Create a volume

Permissionvolumes:create
POST/api/agents/{id}/volumes/backups/discover

Discover volume backups on an S3 destination

Permissionvolumes:backup
DELETE/api/agents/{id}/volumes/backups/{backupId}

Delete volume backup

Permissionvolumes:backup
GET/api/agents/{id}/volumes/backups/{backupId}/download

Download volume backup

Permissionvolumes:read
GET/api/agents/{id}/volumes/backups/{backupId}/files

List files in a volume backup

Permissionvolumes:read
GET/api/agents/{id}/volumes/backups/{backupId}/files/browse

Browse files in a volume backup

Permissionvolumes:read
GET/api/agents/{id}/volumes/backups/{backupId}/files/exists

Check if backup contains path

Permissionvolumes:read
POST/api/agents/{id}/volumes/backups/{backupId}/upload

Upload volume backup

Permissionvolumes:backup
GET/api/agents/{id}/volumes/counts

Get volume usage counts

Permissionvolumes:list
POST/api/agents/{id}/volumes/prune

Prune unused volumes

Permissionvolumes:prune
GET/api/agents/{id}/volumes/sizes

Get volume sizes

Permissionvolumes:list
DELETE/api/agents/{id}/volumes/{volumeName}

Remove a volume

Permissionvolumes:delete
GET/api/agents/{id}/volumes/{volumeName}

Get volume by name

Permissionvolumes:read
GET/api/agents/{id}/volumes/{volumeName}/backups

List volume backups

Permissionvolumes:read
POST/api/agents/{id}/volumes/{volumeName}/backups

Create volume backup

Permissionvolumes:backup
GET/api/agents/{id}/volumes/{volumeName}/backups/policy

Get volume backup policies

Permissionvolumes:read
PUT/api/agents/{id}/volumes/{volumeName}/backups/policy

Update volume backup policies

Permissionvolumes:backup
POST/api/agents/{id}/volumes/{volumeName}/backups/upload

Upload and restore volume backup

Permissionvolumes:upload
POST/api/agents/{id}/volumes/{volumeName}/backups/{backupId}

Restore volume backup

?action=restorevolumes:backup?action=restorefilesvolumes:backup
POST/api/agents/{id}/volumes/{volumeName}/rename

Rename a volume

Permissionvolumes:rename
GET/api/agents/{id}/volumes/{volumeName}/usage

Get volume usage

Permissionvolumes:read
GET/api/agents/{id}/volumes/{volumeName}/workspace

Get volume workspace

Permissionvolumes:read
PATCH/api/agents/{id}/volumes/{volumeName}/workspace

Update volume workspace

Permissionvolumes:readfileChanges.operation=create_filevolumes:uploadfileChanges.operation=create_foldervolumes:uploadfileChanges.operation=update_filevolumes:uploadfileChanges.operation=renamevolumes:uploadfileChanges.operation=renamevolumes:deletefileChanges.operation=movevolumes:uploadfileChanges.operation=movevolumes:deletefileChanges.operation=deletevolumes:deletefileChanges.operation=restore_filevolumes:backup
GET/api/agents/{id}/volumes/{volumeName}/workspace/file

Get volume workspace file

Permissionvolumes:read
GET/api/agents/{id}/volumes/{volumeName}/workspace/file/download

Download volume workspace file

Permissionvolumes:read
GET/api/agents/{id}/vulnerabilities/all

List environment vulnerabilities

Permissionvulnerabilities:list
GET/api/agents/{id}/vulnerabilities/export

Export environment vulnerabilities

Permissionvulnerabilities:list
GET/api/agents/{id}/vulnerabilities/ignored

List ignored vulnerabilities

Permissionvulnerabilities:list
POST/api/agents/{id}/vulnerabilities/ignored

Ignore a vulnerability

Permissionvulnerabilities:update
POST/api/agents/{id}/vulnerabilities/ignored/bulk

Ignore or restore vulnerabilities in bulk

?action=ignorevulnerabilities:update?action=unignorevulnerabilities:update
DELETE/api/agents/{id}/vulnerabilities/ignored/{ignoreId}

Unignore a vulnerability

Permissionvulnerabilities:update
GET/api/agents/{id}/vulnerabilities/images

List vulnerability image options

Permissionvulnerabilities:list
GET/api/agents/{id}/vulnerabilities/overview

Get environment vulnerability risk overview

Permissionvulnerabilities:list
GET/api/agents/{id}/vulnerabilities/scanner

Get vulnerability scanner status

Permissionvulnerabilities:read
GET/api/agents/{id}/vulnerabilities/summary

Get environment vulnerability summary

Permissionvulnerabilities:list
GET/api/agents/{id}/webhooks

List webhooks

Permissionwebhooks:list
POST/api/agents/{id}/webhooks

Create webhook

Permissionwebhooks:create
DELETE/api/agents/{id}/webhooks/{webhookId}

Delete webhook

Permissionwebhooks:delete
PATCH/api/agents/{id}/webhooks/{webhookId}

Update webhook

Permissionwebhooks:update
GET/api/agents/{id}/ws/containers/stats
Permissioncontainers:read
GET/api/agents/{id}/ws/containers/{containerId}/logs
Permissioncontainers:logs
GET/api/agents/{id}/ws/containers/{containerId}/stats
Permissioncontainers:read
GET/api/agents/{id}/ws/containers/{containerId}/terminal
Permissioncontainers:exec
GET/api/agents/{id}/ws/projects/{projectId}/logs
Permissionprojects:logs
GET/api/agents/{id}/ws/swarm/services/{serviceId}/logs
Permissionswarm-services:logs
GET/api/agents/{id}/ws/system/stats
Permissionsystem:read
GET/api/apikeys

List API keys

Permissionapikeys:list
POST/api/apikeys

Create an API key

Permissionapikeys:create
DELETE/api/apikeys/{id}

Delete an API key

Permissionapikeys:delete
GET/api/apikeys/{id}

Get an API key

Permissionapikeys:read
PATCH/api/apikeys/{id}

Update an API key

Permissionapikeys:update
POST/api/apns/devices

Register a mobile device

AccessAny signed-in user
DELETE/api/apns/devices/{id}

Remove a mobile device

AccessAny signed-in user
PATCH/api/apns/devices/{id}

Update a mobile device

AccessAny signed-in user
POST/api/apns/devices/{id}

Send a test push

AccessAny signed-in user
POST/api/apns/pairing

Issue a pairing token

AccessAny signed-in user
GET/api/apns/status

Get mobile push status

AccessAny signed-in user
DELETE/api/app/images/favicon

Delete custom favicon

Permissionsettings:update
GET/api/app/images/favicon

Get application favicon

AccessPublic
PUT/api/app/images/favicon

Upload custom favicon

Permissionsettings:update
GET/api/app/images/logo

Get application logo

AccessPublic
DELETE/api/app/images/logo/{variant}

Delete custom logo

Permissionsettings:update
PUT/api/app/images/logo/{variant}

Upload custom logo

Permissionsettings:update
GET/api/app/images/profile

Get default profile image

AccessPublic
DELETE/api/app/images/pwa

Delete custom PWA icon

Permissionsettings:update
PUT/api/app/images/pwa

Upload custom PWA icon

Permissionsettings:update
GET/api/app/images/pwa/{filename}

Get PWA icon

AccessPublic
GET/api/app/version

Get app version

AccessPublic
GET/api/auth/bootstrap

Get session bootstrap

AccessAny signed-in user
POST/api/auth/federated/token

Exchange a federated subject token

AccessFederated subject token
POST/api/auth/login

Login

AccessPublic
POST/api/auth/logout

Logout

AccessPublic
GET/api/auth/me

Get current user

AccessAny signed-in user
GET/api/auth/me/apikeys

List my API keys

AccessAny signed-in user
POST/api/auth/me/apikeys

Create my API key

AccessAny signed-in user
DELETE/api/auth/me/apikeys/{id}

Delete my API key

AccessAny signed-in user
DELETE/api/auth/me/avatar

Delete own avatar

AccessAny signed-in user
POST/api/auth/me/avatar

Upload own avatar

AccessAny signed-in user
DELETE/api/auth/me/backdrop

Delete own background image

AccessAny signed-in user
GET/api/auth/me/backdrop

Get own background image

AccessAny signed-in user
POST/api/auth/me/backdrop

Upload own background image

AccessAny signed-in user
GET/api/auth/me/mfa

Get passkey MFA status

AccessAny signed-in user
POST/api/auth/me/mfa/disable

Disable passkey MFA

AccessAny signed-in user
POST/api/auth/me/mfa/enable

Enable passkey MFA

AccessAny signed-in user
POST/api/auth/me/mfa/recovery

Regenerate MFA recovery codes

AccessAny signed-in user
GET/api/auth/me/passkeys

List my passkeys

AccessAny signed-in user
GET/api/auth/me/passkeys/capabilities

Get passkey capabilities

AccessAny signed-in user
POST/api/auth/me/passkeys/reauth/begin

Begin passkey step-up

AccessAny signed-in user
POST/api/auth/me/passkeys/reauth/finish

Finish passkey step-up

AccessAny signed-in user
POST/api/auth/me/passkeys/reauth/password

Reauthenticate with password

AccessAny signed-in user
POST/api/auth/me/passkeys/register/begin

Begin passkey registration

AccessAny signed-in user
POST/api/auth/me/passkeys/register/finish

Finish passkey registration

AccessAny signed-in user
DELETE/api/auth/me/passkeys/{id}

Delete my passkey

AccessAny signed-in user
PATCH/api/auth/me/passkeys/{id}

Rename my passkey

AccessAny signed-in user
PATCH/api/auth/me/profile

Update own profile

AccessAny signed-in user
POST/api/auth/mfa/passkey/begin

Begin passkey MFA

AccessPublic
POST/api/auth/mfa/passkey/finish

Finish passkey MFA

AccessPublic
POST/api/auth/mfa/recovery

Use an MFA recovery code

AccessPublic
GET/api/auth/passkey/login/availability

Get passkey login availability

AccessPublic
POST/api/auth/passkey/login/begin

Begin passkey login

AccessPublic
POST/api/auth/passkey/login/finish

Finish passkey login

AccessPublic
POST/api/auth/passkey/mobile/exchange

Exchange mobile passkey login

AccessPublic
POST/api/auth/passkey/mobile/finish

Finish mobile passkey login

AccessPublic
POST/api/auth/password

Change password

AccessAny signed-in user
POST/api/auth/refresh

Refresh token

AccessPublic
DELETE/api/auth/sessions

Logout all other sessions

AccessAny signed-in user
GET/api/backups

List Arcane system backups

Permissionsystem-backups:list
POST/api/backups

Create Arcane system backup

Permissionsystem-backups:create
POST/api/backups/discover

Discover Arcane system backups in S3

Permissionsystem-backups:update
Global admin only
GET/api/backups/history

List unified backup history

Permissionsystem-backups:list
GET/api/backups/policies

Get Arcane system backup policies

Permissionsystem-backups:read
PUT/api/backups/policies

Update Arcane system backup policies

Permissionsystem-backups:update
POST/api/backups/recovery/key

Generate an Arcane system backup recovery key

?action=generatesystem-backups:recovery-key
Global admin only
PUT/api/backups/recovery/key

Configure Arcane system backup recovery key

Permissionsystem-backups:recovery-key
Global admin only
GET/api/backups/s3

List S3 destinations

Permissions3-destinations:list
POST/api/backups/s3

Create S3 destination

Permissions3-destinations:create
GET/api/backups/s3/options

List all S3 destination options

Permissions3-destinations:list
POST/api/backups/s3/sync

Sync S3 destinations

Permissions3-destinations:sync
POST/api/backups/s3/test

Test unsaved S3 destination configuration

Permissions3-destinations:test
DELETE/api/backups/s3/{id}

Delete S3 destination

Permissions3-destinations:delete
GET/api/backups/s3/{id}

Get S3 destination

Permissions3-destinations:read
PATCH/api/backups/s3/{id}

Update S3 destination

Permissions3-destinations:update
POST/api/backups/s3/{id}

Test S3 destination

?action=tests3-destinations:test
GET/api/backups/s3/{id}/usage

Check S3 destination references

Permissions3-destinations:read
GET/api/backups/volumes/config

Get system-managed volume backup policies

Permissionsystem-backups:read
PUT/api/backups/volumes/config

Update system-managed volume backup policies

Permissionsystem-backups:update
GET/api/backups/volumes/options

List volumes available to system-managed backups

Permissionsystem-backups:read
POST/api/backups/volumes/run

Run system-managed volume backups

Permissionsystem-backups:create
GET/api/debug/pprof
Permissiondiagnostics:profile
GET/api/debug/pprof/
Permissiondiagnostics:profile
GET/api/debug/pprof/cmdline
Permissiondiagnostics:profile
GET/api/debug/pprof/profile
Permissiondiagnostics:profile
GET/api/debug/pprof/symbol
Permissiondiagnostics:profile
POST/api/debug/pprof/symbol
Permissiondiagnostics:profile
GET/api/debug/pprof/trace
Permissiondiagnostics:profile
GET/api/debug/pprof/{name}
Permissiondiagnostics:profile
GET/api/diagnostics/actors/stream
Permissiondiagnostics:read
GET/api/diagnostics/logs/stream
Permissiondiagnostics:read
GET/api/diagnostics/stream
Permissiondiagnostics:readtype=dumpdiagnostics:profiletype=profilediagnostics:profile
GET/api/docs
AccessPublic
GET/api/docs/scalar.js
AccessPublic
GET/api/enrollment-tokens

List enrollment tokens

Permissionenvironments:create
POST/api/enrollment-tokens

Create an enrollment token

Permissionenvironments:create
DELETE/api/enrollment-tokens/{id}

Revoke an enrollment token

Permissionenvironments:create
GET/api/enrollment-tokens/{id}/token

Get an enrollment token secret

Permissionenvironments:create
GET/api/events

List events

Permissionevents:list
POST/api/events

Ingest an agent event

AccessAgent token
GET/api/events/agent/{environmentId}

Get events by environment

Permissionevents:list
GET/api/events/stats

Event severity counts

Permissionevents:list
DELETE/api/events/{eventId}

Delete an event

Permissionevents:delete
GET/api/federated/credentials

List federated credentials

Permissionfederated:list
POST/api/federated/credentials

Create a federated credential

Permissionfederated:create
DELETE/api/federated/credentials/{id}

Delete a federated credential

Permissionfederated:delete
GET/api/federated/credentials/{id}

Get a federated credential

Permissionfederated:read
PATCH/api/federated/credentials/{id}

Update a federated credential

Permissionfederated:update
POST/api/git/repositories/sync

Sync git repositories

Permissiongit-repositories:sync
GET/api/gitops/repositories

List git repositories

Permissiongit-repositories:list
POST/api/gitops/repositories

Create a git repository

Permissiongit-repositories:create
DELETE/api/gitops/repositories/{id}

Delete a git repository

Permissiongit-repositories:delete
GET/api/gitops/repositories/{id}

Get a git repository

Permissiongit-repositories:read
PATCH/api/gitops/repositories/{id}

Update a git repository

Permissiongit-repositories:update
POST/api/gitops/repositories/{id}

Test a git repository

?action=testgit-repositories:test
GET/api/gitops/repositories/{id}/branches

List repository branches

Permissiongit-repositories:read
GET/api/gitops/repositories/{id}/files

Browse repository files

Permissiongit-repositories:read
GET/api/health

Health check

AccessPublic
HEAD/api/health

Health check (HEAD)

AccessPublic
GET/api/health/ready

Readiness probe

AccessPublic
POST/api/notifications/dispatch

Dispatch notification from remote agent to manager

AccessAny signed-in user
GET/api/notifications/settings

Get all notification settings

Permissionnotifications:list
POST/api/notifications/settings

Create or update notification settings

Permissionnotifications:update
DELETE/api/notifications/settings/{provider}

Delete notification settings

Permissionnotifications:delete
GET/api/notifications/settings/{provider}

Get notification settings by provider

Permissionnotifications:read
POST/api/notifications/settings/{provider}

Test notification

?action=testnotifications:test
POST/api/oidc/callback

Handle OIDC callback

AccessPublic
GET/api/oidc/config

Get OIDC config

AccessPublic
POST/api/oidc/device/code

Initiate OIDC device authorization

AccessPublic
POST/api/oidc/device/token

Exchange device code for tokens

AccessPublic
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

AccessPublic
POST/api/oidc/url

Get OIDC auth URL

AccessPublic
GET/api/openapi-3.0.json
AccessPublic
GET/api/openapi-3.0.yaml
AccessPublic
GET/api/openapi.json
AccessPublic
GET/api/openapi.yaml
AccessPublic
GET/api/registries

List container registries

Permissionregistries:list
POST/api/registries

Create a container registry

Permissionregistries:create
POST/api/registries/sync

Sync container registries

Permissionregistries:update
GET/api/registries/usage

Get container registry pull usage

Permissionregistries:read
DELETE/api/registries/{id}

Delete a container registry

Permissionregistries:delete
GET/api/registries/{id}

Get a container registry

Permissionregistries:read
PATCH/api/registries/{id}

Update a container registry

Permissionregistries:update
POST/api/registries/{id}

Test a container registry

?action=testregistries:test
GET/api/registries/{id}/repositories

List registry repositories

Permissionregistries:browse
DELETE/api/registries/{id}/tags

Delete a repository tag

Permissionregistries:delete-tags
GET/api/registries/{id}/tags

List repository tags

Permissionregistries:browse
GET/api/roles

List roles

Permissionroles:list
POST/api/roles

Create a custom role

GET/api/roles/permissions

Get the permission manifest

AccessAny signed-in user
DELETE/api/roles/{id}

Delete a custom role

GET/api/roles/{id}

Get a role

Permissionroles:read
PATCH/api/roles/{id}

Update a custom role

GET/api/schemas/{schema}
AccessPublic
GET/api/settings

Get app-wide settings

Permissionsettings:read
PATCH/api/settings

Update app-wide settings

Permissionsettings:update
GET/api/settings/authentication

Get authentication settings

PATCH/api/settings/authentication

Update authentication settings

GET/api/settings/categories

Get settings categories

AccessAny signed-in user
POST/api/settings/search

Search settings

AccessAny signed-in user
GET/api/stream

Multiplexed client stream

channels=activitiesactivities:listchannels=arcane-upgradesystem:readAccessAny signed-in user
GET/api/swarm/identity

Get local swarm node identity

Permissionswarm:read
POST/api/telemetry/{signal}

Relay browser telemetry

AccessPublic
GET/api/templates

List templates (paginated)

Permissiontemplates:list
POST/api/templates

Create a template

Permissiontemplates:create
GET/api/templates/all

List all templates

Permissiontemplates:list
GET/api/templates/default

Get default templates

Permissiontemplates:read
POST/api/templates/default

Save default templates

Permissiontemplates:update
GET/api/templates/fetch

Fetch remote registry

Permissiontemplates:read
GET/api/templates/registries

List template registries

Permissiontemplates:list
POST/api/templates/registries

Create a template registry

Permissiontemplates:create
DELETE/api/templates/registries/{id}

Delete a template registry

Permissiontemplates:delete
PATCH/api/templates/registries/{id}

Update a template registry

Permissiontemplates:update
DELETE/api/templates/{id}

Delete a template

Permissiontemplates:delete
GET/api/templates/{id}

Get a template

Permissiontemplates:read
PATCH/api/templates/{id}

Update a template

Permissiontemplates:update
POST/api/templates/{id}

Download a template

?action=downloadtemplates:create
GET/api/templates/{id}/content

Get template content

Permissiontemplates:read
GET/api/tunnel/connect
AccessAgent token
POST/api/tunnel/mtls/enroll

Enroll an agent mTLS certificate

AccessAgent token
GET/api/users

List users

Permissionusers:list
POST/api/users

Create a user

Permissionusers:create
DELETE/api/users/{userId}

Delete a user

Permissionusers:delete
GET/api/users/{userId}

Get a user

Permissionusers:read
PATCH/api/users/{userId}

Update a user

Permissionusers:update
GET/api/users/{userId}/avatar

Get user avatar

AccessPublic
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

Permissionvariables:list
POST/api/variables

Create a global variable

Permissionvariables:create
GET/api/variables/sync

Get variable sync status

Permissionvariables:read
POST/api/variables/sync

Sync global variables

Permissionvariables:sync
DELETE/api/variables/{id}

Delete a global variable

Permissionvariables:delete
PATCH/api/variables/{id}

Update a global variable

Permissionvariables:update
GET/api/version

Get version information

AccessPublic
POST/api/webhooks/trigger/{token}

Trigger webhook

AccessWebhook token