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>"
}
'
import requests

url = "https://api.arcuserp.com/v1/entities/{entity_id}/migration/cutover/snapshot"

payload = {
"freeze_token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({freeze_token: '3c90c3cc-0d44-4b50-8888-8dd25736052a', description: '<string>'})
};

fetch('https://api.arcuserp.com/v1/entities/{entity_id}/migration/cutover/snapshot', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arcuserp.com/v1/entities/{entity_id}/migration/cutover/snapshot",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'freeze_token' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.arcuserp.com/v1/entities/{entity_id}/migration/cutover/snapshot"

payload := strings.NewReader("{\n \"freeze_token\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/entities/{entity_id}/migration/cutover/snapshot")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"freeze_token\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/entities/{entity_id}/migration/cutover/snapshot")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"freeze_token\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "object": "rds_snapshot",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "snapshot_id": "<string>",
  "db_instance_id": "<string>",
  "percent_progress": 50,
  "started_at": "2023-11-07T05:31:56Z",
  "estimated_completion_at": "2023-11-07T05:31:56Z",
  "dev_stub": true,
  "cutover_log_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}

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>