Publishes a terminal Kopia snapshot result.

POST

/api/workspace/file-protection/agent/v1/commands/{commandId}:complete

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/file-protection/agent/v1/commands/example:complete"),
    Headers =
    {
        { "X-Moltaro-File-Protection-Agent", "<X-Moltaro-File-Protection-Agent>" },
    },
    Content = new StringContent("{ \"LeaseToken\": \"example\", \"Succeeded\": true, \"SnapshotId\": \"example\", \"RepositoryFingerprint\": \"example\", \"SnapshotDigestSha256\": \"example\", \"LogicalSizeBytes\": 1, \"SnapshotCreatedAtUtc\": \"2026-04-15T12:00:00Z\", \"Items\": [ { \"LogicalPath\": \"example\", \"IsDirectory\": true, \"SizeBytes\": 1, \"Sha256\": \"example\", \"RepositorySnapshot\": { \"RepositoryId\": \"example\", \"SnapshotId\": \"example\", \"RepositoryFingerprint\": \"example\" } } ], \"SafeErrorCode\": \"example\", \"SourceTree\": { \"SourceId\": \"example\", \"RepositoryBindingRevision\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"RepositoryId\": \"example\", \"RepositoryFingerprint\": \"example\", \"SnapshotId\": \"example\", \"RootKind\": 0, \"RootPath\": \"example\", \"CaptureStartedAtUtc\": \"2026-04-15T12:00:00Z\", \"CaptureCompletedAtUtc\": \"2026-04-15T12:00:00Z\" }, \"UnchangedRecoveryPointId\": \"example\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/file-protection/agent/v1/commands/example:complete';
const options = {
  method: 'POST',
  headers: {
    'X-Moltaro-File-Protection-Agent': '<X-Moltaro-File-Protection-Agent>',
    'Content-Type': 'application/json'
  },
  body: '{"LeaseToken":"example","Succeeded":true,"SnapshotId":"example","RepositoryFingerprint":"example","SnapshotDigestSha256":"example","LogicalSizeBytes":1,"SnapshotCreatedAtUtc":"2026-04-15T12:00:00Z","Items":[{"LogicalPath":"example","IsDirectory":true,"SizeBytes":1,"Sha256":"example","RepositorySnapshot":{"RepositoryId":"example","SnapshotId":"example","RepositoryFingerprint":"example"}}],"SafeErrorCode":"example","SourceTree":{"SourceId":"example","RepositoryBindingRevision":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","RepositoryId":"example","RepositoryFingerprint":"example","SnapshotId":"example","RootKind":0,"RootPath":"example","CaptureStartedAtUtc":"2026-04-15T12:00:00Z","CaptureCompletedAtUtc":"2026-04-15T12:00:00Z"},"UnchangedRecoveryPointId":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/file-protection/agent/v1/commands/example:complete \
  --header 'Content-Type: application/json' \
  --header 'X-Moltaro-File-Protection-Agent: <X-Moltaro-File-Protection-Agent>' \
  --data '{ "LeaseToken": "example", "Succeeded": true, "SnapshotId": "example", "RepositoryFingerprint": "example", "SnapshotDigestSha256": "example", "LogicalSizeBytes": 1, "SnapshotCreatedAtUtc": "2026-04-15T12:00:00Z", "Items": [ { "LogicalPath": "example", "IsDirectory": true, "SizeBytes": 1, "Sha256": "example", "RepositorySnapshot": { "RepositoryId": "example", "SnapshotId": "example", "RepositoryFingerprint": "example" } } ], "SafeErrorCode": "example", "SourceTree": { "SourceId": "example", "RepositoryBindingRevision": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "RepositoryId": "example", "RepositoryFingerprint": "example", "SnapshotId": "example", "RootKind": 0, "RootPath": "example", "CaptureStartedAtUtc": "2026-04-15T12:00:00Z", "CaptureCompletedAtUtc": "2026-04-15T12:00:00Z" }, "UnchangedRecoveryPointId": "example" }'

Requires TLS at the API connection. A workspace bearer token does not authenticate an Agent.

Send the enrolled device credential in the X-Moltaro-File-Protection-Agent header. Revoked or invalid credentials are rejected.

Authorizations

FileProtectionAgent

Parameters

Path Parameters

commandId

required

string

Request Body

Publishes the verified outcome of a Kopia snapshot.

object

LeaseToken

string

nullable

Succeeded

boolean

SnapshotId

string

nullable

RepositoryFingerprint

string

nullable

SnapshotDigestSha256

string

nullable

LogicalSizeBytes

integer format: int64

nullable

SnapshotCreatedAtUtc

string format: date-time

nullable

Items

Array<object>

nullable

Safe logical recovery metadata; no Kopia object/chunk keys are exposed.

object

LogicalPath

string

nullable

IsDirectory

boolean

SizeBytes

integer format: int64

Sha256

string

nullable

RepositorySnapshot

Verified single-file snapshot identity. This metadata is internal to the Agent protocol.

object

RepositoryId

string

nullable

SnapshotId

string

nullable

RepositoryFingerprint

string

nullable

SafeErrorCode

string

nullable

SourceTree

One shared tree identity, including an empty root; logical items never carry its password.

object

SourceId

string

nullable

RepositoryBindingRevision

string format: uuid

RepositoryId

string

nullable

RepositoryFingerprint

string

nullable

SnapshotId

string

nullable

RootKind

The type of the Kopia snapshot root, not the Source selector.

integer format: int32

Allowed values: 0 1

RootPath

string

nullable

CaptureStartedAtUtc

string format: date-time

CaptureCompletedAtUtc

string format: date-time

UnchangedRecoveryPointId

Existing baseline whose identical bytes were observed; no snapshot was uploaded.

string

nullable

Responses

200

application/json

object

Data

Outcome accepted by OMS after snapshot identity verification.

object

RunId

string

nullable

RecoveryPointId

string

nullable

State

Durable state of one manual protection run.

integer format: int32

Allowed values: 0 1 2 3 4 5 6

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": {
    "State": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}