Skip to main content
GET
/
entities
/
{entity_id}
/
migration
/
cutover
/
status
Get current cutover state
curl --request GET \
  --url https://api.arcuserp.com/v1/entities/{entity_id}/migration/cutover/status \
  --header 'Authorization: Bearer <token>'
{
  "object": "cutover_status",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "frozen": true,
  "current_state": "idle",
  "frozen_at": "2023-11-07T05:31:56Z",
  "frozen_reason": "<string>",
  "snapshot_id": "<string>",
  "latest_action": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "action": "freeze_engaged",
    "status": "in_progress",
    "performed_at": "2023-11-07T05:31:56Z",
    "rds_snapshot_id": "<string>",
    "rds_snapshot_status": "<string>",
    "verification_result": {},
    "error_text": "<string>",
    "notes": "<string>",
    "metadata": {},
    "related_cutover_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "recent_log": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "action": "freeze_engaged",
      "status": "in_progress",
      "performed_at": "2023-11-07T05:31:56Z",
      "rds_snapshot_id": "<string>",
      "rds_snapshot_status": "<string>",
      "verification_result": {},
      "error_text": "<string>",
      "notes": "<string>",
      "metadata": {},
      "related_cutover_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

Response

Cutover status

Current cutover state + recent action history.

object
enum<string>
Available options:
cutover_status
entity_id
string<uuid>
frozen
boolean
current_state
enum<string>
Available options:
idle,
frozen,
snapshotting,
swapped,
verified,
rolled_back
frozen_at
string<date-time> | null
frozen_reason
string | null
snapshot_id
string | null
latest_action
object

Single entry in the cutover audit log (append-only).

recent_log
object[]