s3_destination

The s3_destination domain has 10 actions. On the meta surface they are all reached through arcane_s3_destination; on the individual surface each one is its own tool; on the dynamic surface run them with arcane_execute_action and the canonical ID.

Summary

Action	Title	Kind
s3_destination.create	Create S3 destination	write
s3_destination.delete	Delete S3 destination	destructive
s3_destination.get	Get S3 destination	read
s3_destination.list	List S3 destinations	read
s3_destination.options	List all S3 destination options	read
s3_destination.sync	Sync S3 destinations	destructive
s3_destination.test	Test S3 destination	write
s3_destination.test_configuration	Test unsaved S3 destination configuration	read
s3_destination.update	Update S3 destination	write
s3_destination.usage	Check S3 destination references	read

Actions

s3_destination.create

Create S3 destination

• Kind: write
• Required parameters: accessKeyId, bucket, forcePathStyle, name, region, secretAccessKey, useSsl
• Meta tool: arcane_s3_destination with "action": "create"
• Individual tool: arcane_s3_destination_create
• Arcane route: POST /api/backups/s3
• Operation ID: create-s3-destination
• Usage: Arcane first runs the connection test (uploads, reads back and deletes a temporary object under the prefix) and refuses to save if it fails, so the bucket must already exist and be writable. Required: name (unique), bucket, accessKeyId, secretAccessKey, useSsl, forcePathStyle and region (may be empty only when endpoint is set. Omit endpoint for AWS S3, set it plus forcePathStyle=true for MinIO-style servers. useSsl picks http or https for the endpoint, overriding any scheme written in it). Returns the destination with its id (no secret), and the change is then pushed to remote environments in the background.
• Related actions: s3_destination.test_configuration, s3_destination.list, backup.policies_update, volume_backup.policy_update

s3_destination.delete

Delete S3 destination

• Kind: destructive — requires confirm: true
• Required parameters: id
• Meta tool: arcane_s3_destination with "action": "delete"
• Individual tool: arcane_s3_destination_delete
• Arcane route: DELETE /api/backups/s3/{id}
• Operation ID: delete-s3-destination
• Usage: id from s3_destination.list. Fails with 409 while the destination is in use (see s3_destination.usage) on this instance or on any remote environment, or while a remote environment cannot be reached to check. Disable it in the backup policies and remove the backups stored there first. Deletes only Arcane’s record, not the objects in the bucket. Remote environments then get the change in the background. It does not check system-managed volume backup policies (backup.volume_config_get), so review those first.
• Related actions: s3_destination.usage, s3_destination.list, backup.policies_update, volume_backup.policy_update

s3_destination.get

Get S3 destination

• Kind: read
• Required parameters: id
• Meta tool: arcane_s3_destination with "action": "get"
• Individual tool: arcane_s3_destination_get
• Arcane route: GET /api/backups/s3/{id}
• Operation ID: get-s3-destination
• Usage: id from s3_destination.list or s3_destination.options. Returns the destination’s connection settings (endpoint, bucket, region, accessKeyId, prefix, useSsl, forcePathStyle) and secretConfigured. The secret access key is never returned. Read it before s3_destination.update, which replaces every field.
• Related actions: s3_destination.list, s3_destination.update, s3_destination.usage

s3_destination.list

List S3 destinations

List saved S3-compatible backup destinations with search, sorting, and pagination

• Kind: read
• Required parameters: none
• Meta tool: arcane_s3_destination with "action": "list"
• Individual tool: arcane_s3_destination_list
• Arcane route: GET /api/backups/s3
• Operation ID: list-s3-destinations
• Usage: Paged list of the saved S3 destinations (global, not per environment). search matches name, endpoint, bucket, region and prefix, start/limit page it (limit defaults to 20). Each item’s id is the s3DestinationId that backup.create, volume_backup.create, backup.policies_update and volume_backup.policy_update take. Secrets are never returned, only secretConfigured. For the whole list without paging use s3_destination.options.
• Related actions: s3_destination.get, s3_destination.options, s3_destination.create

s3_destination.options

List all S3 destination options

List saved S3-compatible destinations for backup configuration selectors

• Kind: read
• Required parameters: none
• Meta tool: arcane_s3_destination with "action": "options"
• Individual tool: arcane_s3_destination_options
• Arcane route: GET /api/backups/s3/options
• Operation ID: list-all-s3-destinations
• Usage: Returns every saved S3 destination as a plain array sorted by name, with no search or paging: use it to pick an s3DestinationId for a backup or a backup policy. Use s3_destination.list to search or page.
• Related actions: s3_destination.list, backup.policies_update, volume_backup.policy_update

s3_destination.sync

Sync S3 destinations

Synchronize manager-owned S3 destinations to an agent

• Kind: destructive — requires confirm: true
• Required parameters: destinations
• Meta tool: arcane_s3_destination with "action": "sync"
• Individual tool: arcane_s3_destination_sync
• Arcane route: POST /api/backups/s3/sync
• Operation ID: sync-s3-destinations
• Usage: Agent-side endpoint a manager uses to push its S3 destinations: the given list REPLACES this instance’s destinations, and every destination not in it is deleted (one still in use locally is kept and the call reports an error after the rest is applied). To push destinations to an environment use environment.sync instead.
• Related actions: environment.sync

s3_destination.test

Test S3 destination

Verify upload, download, and delete access using the saved or supplied S3 destination configuration

• Kind: write
• Required parameters: id
• Meta tool: arcane_s3_destination with "action": "test"
• Individual tool: arcane_s3_destination_test
• Arcane route: POST /api/backups/s3/{id}/test
• Operation ID: test-s3-destination
• Usage: With only id, tests the saved configuration. To test changes before saving them, pass the complete configuration (name, bucket, region, accessKeyId, secretAccessKey, useSsl, forcePathStyle, with endpoint and prefix optional): omitted fields count as empty. secretAccessKey may be empty to reuse the stored secret only while endpoint, bucket, region, accessKeyId, useSsl and forcePathStyle are unchanged. The endpoint must be reachable both from Arcane and from the backup helper containers Arcane starts on the Docker host.
• Related actions: s3_destination.test_configuration, s3_destination.get

s3_destination.test_configuration

Test unsaved S3 destination configuration

Verify upload, download, and delete access before saving an S3 destination

• Kind: read
• Required parameters: accessKeyId, bucket, forcePathStyle, name, region, secretAccessKey, useSsl
• Meta tool: arcane_s3_destination with "action": "test_configuration"
• Individual tool: arcane_s3_destination_test_configuration
• Arcane route: POST /api/backups/s3/test
• Operation ID: test-s3-destination-configuration
• Usage: Tests settings that are not saved yet, with the same body as s3_destination.create (secretAccessKey required). Nothing is stored. It writes, reads back and deletes a temporary .arcane-connection-test-* object under the prefix, and fails with the S3 error when access is missing. To test a saved destination use s3_destination.test.
• Related actions: s3_destination.create, s3_destination.test

s3_destination.update

Update S3 destination

• Kind: write
• Required parameters: id, accessKeyId, bucket, forcePathStyle, name, region, secretAccessKey, useSsl
• Meta tool: arcane_s3_destination with "action": "update"
• Individual tool: arcane_s3_destination_update
• Arcane route: PUT /api/backups/s3/{id}
• Operation ID: update-s3-destination
• Usage: id from s3_destination.list. Replaces the whole configuration: send every field (start from s3_destination.get), an omitted prefix or endpoint is cleared. secretAccessKey may be empty to keep the stored secret only if endpoint, bucket, region, accessKeyId, useSsl and forcePathStyle are unchanged, otherwise Arcane demands it again. The new settings are connection-tested before saving and then pushed to remote environments.
• Related actions: s3_destination.get, s3_destination.test, s3_destination.list

s3_destination.usage

Check S3 destination references

Report whether backup records, policies, or settings on this environment still reference the destination

• Kind: read
• Required parameters: id
• Meta tool: arcane_s3_destination with "action": "usage"
• Individual tool: arcane_s3_destination_usage
• Arcane route: GET /api/backups/s3/{id}/in-use
• Operation ID: get-s3-destination-usage
• Usage: id from s3_destination.list. Returns inUse=true when a system or volume backup policy on this Arcane instance has S3 enabled with this destination, or a system or volume backup has a copy stored in it. System-managed volume backup policies (backup.volume_config_update) are not checked. It checks only this instance, while s3_destination.delete also asks every remote environment, so delete can still fail with inUse=false.
• Related actions: s3_destination.delete, backup.policies_get, volume_backup.policy_get, backup.volume_config_get