Authenticate with Arcane using username and password. Returns JWT tokens.

Log out of the current session and invalidate tokens

Get information about the currently authenticated user

Refresh the authentication token using the refresh token

Change the password for the current user

Get OIDC configuration status (enabled, provider name, etc.)

Get OIDC client configuration details

Initiate OIDC device authorization flow. Returns a user code to enter at the verification URL.

List all Docker environments configured in Arcane

Get details of a specific Docker environment

Create a new Docker environment in Arcane

Update an existing Docker environment

[HIGH RISK] Delete a Docker environment from Arcane. This removes the environment configuration but does not affect the actual Docker host.

Test connectivity to a Docker environment

Generate or rotate the local agent pairing token for an environment

Get the Arcane agent version running on an environment

Get Docker system information for an environment

Get deployment snippets for installing Arcane agent on an environment

List Docker containers in an environment with pagination and filtering

Get detailed information about a specific container

Create a new Docker container

Start a stopped container

Stop a running container

Restart a container

Pull the latest image and recreate a container with the same configuration. Automatically pulls latest image before recreating.

[HIGH RISK] Delete a Docker container permanently. Use force=true to delete running containers, volumes=true to remove associated volumes.

Redeploy a single container (pull latest image and recreate)

Enable or disable automatic updates for a specific container

Get container status counts for an environment (running, stopped, etc.)

List Docker images in an environment

Get detailed information about a Docker image

Pull a Docker image from a registry

[HIGH RISK] Remove a Docker image from the host

[HIGH RISK] Remove all unused Docker images. This frees disk space but cannot be undone.

Get image counts and size statistics for an environment

Check if a newer version of an image is available

Check for updates on all images in an environment

Get a summary of available image updates across all containers

List Docker networks in an environment

Get detailed information about a Docker network

Create a new Docker network

[HIGH RISK] Delete a Docker network. Connected containers will be disconnected.

[HIGH RISK] Remove all unused Docker networks. This cannot be undone.

Get network counts for an environment

List Docker volumes in an environment

Get detailed information about a Docker volume

Create a new Docker volume

[CRITICAL RISK] Permanently delete a Docker volume and ALL its data. This cannot be undone!

[CRITICAL RISK] Remove ALL unused Docker volumes and their data. This cannot be undone!

Get volume counts for an environment

Browse files and directories in a Docker volume

Read the content of a file in a Docker volume

Create a directory in a Docker volume

List backups for a Docker volume

Create a backup of a Docker volume

[HIGH RISK] Delete a volume backup permanently

Restore a volume from a backup. This will overwrite existing data in the volume.

List files contained in a volume backup

List Docker Compose projects/stacks in an environment

Get detailed information about a Docker Compose project

Create a new Docker Compose project from a compose file

Update a Docker Compose project configuration

Deploy a Docker Compose project (docker-compose up -d). Use arcane_project_pull_images first to pull latest images.

Stop and remove containers for a Docker Compose project (docker-compose down). Use arcane_project_destroy to also remove volumes.

Restart all services in a Docker Compose project

Redeploy a project (down + up). Useful for applying configuration changes. Use arcane_project_pull_images first to pull latest images.

[CRITICAL RISK] Destroy a project completely, including containers and optionally volumes. This cannot be undone!

Pull all images for a Docker Compose project

Get project status counts for an environment

Build images for a Docker Compose project

List GitOps sync configurations

Get details of a GitOps sync configuration

Create a new GitOps sync configuration

Update a GitOps sync configuration

Delete a GitOps sync configuration

Trigger a GitOps sync to pull and deploy latest changes from the repository

Get the current sync status for a GitOps configuration

List configured Git repositories

Add a new Git repository configuration

Test connectivity to a Git repository

List branches in a Git repository

Browse files in a Git repository

Delete a Git repository configuration

List configured container registries

Get details of a container registry

Add a new container registry configuration

Update a container registry configuration

Delete a container registry configuration

Test connectivity to a container registry

Sync all container registries to refresh image information

List available Docker Compose templates

Get details of a Docker Compose template

Get the Docker Compose YAML content of a template

Create a new Docker Compose template

Update a Docker Compose template

Delete a Docker Compose template

Get global template variables

Update global template variables

Check the health status of the Arcane server

Get Docker system information for an environment