Skip to content

Queues one idempotent manual protection run.

POST
/api/workspace/file-protection/sources/{sourceId}/runs
curl --request POST \
--url https://example.com/api/workspace/file-protection/sources/example/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "IdempotencyKey": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'
sourceId
required
string
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Requests one manual protection run for an already mapped source.

object
IdempotencyKey
string
nullable
RowVersion
string format: uuid
Examplegenerated
{
"IdempotencyKey": "example",
"RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

OK

Media typeapplication/json
object
Data

Safe manual run projection.

object
Id
string
nullable
SourceId
string
nullable
Kind

Supported backup command kinds. Restore is deliberately absent.

integer format: int32
Allowed values: 0
State

Durable state of one manual protection run.

integer format: int32
Allowed values: 0 1 2 3 4 5 6
ProcessedBytes
integer format: int64
TotalBytes
integer format: int64
nullable
RequestedAtUtc
string format: date-time
CompletedAtUtc
string format: date-time
nullable
SafeStatusCode
string
nullable
SafeErrorCode
string
nullable
RowVersion
string format: uuid
Origin

The authority which accepted a protection operation.

integer format: int32
Allowed values: 0 1
Outcome

Successful operation result; completion includes server verification or renewal.

integer format: int32
Allowed values: 0 1 2
AttemptCount
integer format: int32
StartedAtUtc
string format: date-time
nullable
NextAttemptAtUtc
string format: date-time
nullable
LastProgressAtUtc
string format: date-time
nullable
Wait

Observed blockers. A deadline applies only while waiting; useful work pauses the budget.

object
ObservedAtUtc
string format: date-time
RemainingSeconds
integer format: int64
DeadlineAtUtc
string format: date-time
nullable
Reasons
Array<string>
nullable
PreviousAccessExpiresAtUtc
string format: date-time
nullable
MaintenanceUntilUtc
string format: date-time
nullable
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": {
"Kind": 0,
"State": 0,
"Origin": 0,
"Outcome": 0
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}