CorefinityCorefinityDocs
Open the Control PanelControl Panel
Enterprise copies · 3 of 5

Get an Enterprise copy

Answers where the copy is and what it copied. A copy that failed says why in failure_reason, and in error what happened and what to do next.

GET/api/enterprise-copies/{copy}

Path parameters

copyintegerRequired

The id of a copy, as a start or a re-sync answers it. Digits only; 0 or an id above 2147483647 is refused 422.

Returns

200 The copy.

Fields of the 200 answer
copyobjectRequired
Fields
copiedobject or any or nullRequired

What the run copied. Null until it has ended.

copied_atstring or nullRequired

When the copy's run last ended. A copy's times are sent in UTC with a +00:00 offset, not Z. Format: date-time.

copy_ofinteger or nullRequired

The copy this one followed, when it was made by a re-sync. At least 1.

created_atstring or nullRequired

When the copy was started. Format: date-time.

database_bytesinteger or nullRequired

The size of the environment's database, measured when the copy started.

errorstring or nullRequired

For a failed copy, what happened and what to do next.

failure_reasonstring or nullRequired

For a failed copy, the stable code of why.

files_bytesinteger or nullRequired

The size of the environment's files, measured when the copy started.

finishablebooleanRequired

Whether the copy itself is ready to be finished. The site's own checks are made when you finish it.

finished_atstring or nullRequired

When the copy was finished. Format: date-time.

idintegerRequired

At least 1.

operationobject or any or nullRequired

The copy's run, as an operation of the site.

phasestringRequired

presync until the copy ends, then done (finished, or followed by a newer copy) or failed.

source_environment_idintegerRequired

At least 1.

statestringRequired

running while the copy runs, waiting once its run has ended, failed when it failed.

stepstring or nullRequired

Where the copy is: guard, transfer, fixups and check while it runs, copied once its run has ended, superseded when a re-sync followed it, finished when it was finished.

superseded_byinteger or nullRequired

The copy a re-sync made after this one. At least 1.

target_cluster_idintegerRequired

At least 1.

target_site_idintegerRequired

At least 1.

unactivated_atstring or nullRequired

When the site was last checked to be a copy and not a live site. Format: date-time.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403scope_requiredUse a token with the scope named in scope.
404noneCheck the id. You see only what your account can reach.
422invalidFix the field named in field; errors says why.
429rate_limitedWait for the seconds in Retry-After.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl https://manage.corefinity.com/api/enterprise-copies/6201 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "copy": {
    "copied": {
      "at": "2026-11-03T12:41:07+00:00",
      "dangling_links": 0,
      "db_bytes": 10522669875,
      "duration_seconds": 2467,
      "files_bytes": 31876710400,
      "neutralised_at": "2026-11-03T12:40:12+00:00",
      "unreadable_files": 0
    },
    "copied_at": "2026-11-03T12:41:07+00:00",
    "copy_of": null,
    "created_at": "2026-11-03T12:00:00+00:00",
    "database_bytes": 10737418240,
    "error": null,
    "failure_reason": null,
    "files_bytes": 32212254720,
    "finishable": true,
    "finished_at": null,
    "id": 6201,
    "operation": {
      "id": 5141,
      "status": "completed",
      "step": "checked"
    },
    "phase": "presync",
    "source_environment_id": 1311,
    "state": "waiting",
    "step": "copied",
    "superseded_by": null,
    "target_cluster_id": 1017,
    "target_site_id": 1081,
    "unactivated_at": "2026-11-03T12:41:05+00:00"
  }
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT