Skip to main content
POST
/
entities
/
{entity_id}
/
migration
/
cutover
/
snapshot
Initiate RDS snapshot for cutover
curl --request POST \
  --url https://api.arcuserp.com/v1/entities/{entity_id}/migration/cutover/snapshot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "freeze_token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>"
}
'
{
  "object": "rds_snapshot",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "snapshot_id": "<string>",
  "db_instance_id": "<string>",
  "status": "creating",
  "percent_progress": 50,
  "started_at": "2023-11-07T05:31:56Z",
  "estimated_completion_at": "2023-11-07T05:31:56Z",
  "env": "dev",
  "dev_stub": true,
  "cutover_log_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

​
entity_id
string<uuid>
required

Body

application/json
​
freeze_token
string<uuid>
required

The freeze_token returned by POST .../freeze (confirms entity is frozen).

​
description
string

Optional human note stored in the cutover log.

Response

Snapshot initiated

RDS snapshot initiated by cutover/snapshot endpoint.

​
object
enum<string>
Available options:
rds_snapshot
​
entity_id
string<uuid>
​
snapshot_id
string

e.g. arcus-db-prod-cutover-wsspr-20260712-2202-a1b2c3d4

​
db_instance_id
string
​
status
enum<string>
Available options:
creating,
available,
failed
​
percent_progress
integer
Required range: 0 <= x <= 100
​
started_at
string<date-time>
​
estimated_completion_at
string<date-time>
​
env
enum<string>
Available options:
dev,
staging,
prod
​
dev_stub
boolean

True in dev env (no real AWS call made).

​
cutover_log_id
string<uuid>