Queues one idempotent manual protection run.
POST
/api/workspace/file-protection/sources/{sourceId}/runs
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/sources/example/runs"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"IdempotencyKey\": \"example\", \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" }") { 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/sources/example/runs';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"IdempotencyKey":"example","RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'};
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/sources/example/runs \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "IdempotencyKey": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”sourceId
required
string
Query Parameters
Section titled “Query Parameters”access_token
string
Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Requests one manual protection run for an already mapped source.
object
IdempotencyKey
string
RowVersion
string format: uuid
Examplegenerated
{ "IdempotencyKey": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Requests one manual protection run for an already mapped source.
object
IdempotencyKey
string
RowVersion
string format: uuid
Examplegenerated
{ "IdempotencyKey": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Requests one manual protection run for an already mapped source.
object
IdempotencyKey
string
RowVersion
string format: uuid
Examplegenerated
{ "IdempotencyKey": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Responses
Section titled “Responses”OK
Media typeapplication/json
object
Data
Safe manual run projection.
object
Id
string
SourceId
string
Kind
Supported backup command kinds. Restore is deliberately absent.
integer format: int32
State
Durable state of one manual protection run.
integer format: int32
ProcessedBytes
integer format: int64
TotalBytes
integer format: int64
RequestedAtUtc
string format: date-time
CompletedAtUtc
string format: date-time
SafeStatusCode
string
SafeErrorCode
string
RowVersion
string format: uuid
Origin
The authority which accepted a protection operation.
integer format: int32
Outcome
Successful operation result; completion includes server verification or renewal.
integer format: int32
AttemptCount
integer format: int32
StartedAtUtc
string format: date-time
NextAttemptAtUtc
string format: date-time
LastProgressAtUtc
string format: date-time
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
Reasons
Array<string>
PreviousAccessExpiresAtUtc
string format: date-time
MaintenanceUntilUtc
string format: date-time
Errors
Array<object>
object
Code
required
string
Message
required
string
Target
string
Field
string
Metadata
object
key
additional properties
string
Type
integer format: int32
Severity
integer format: int32
Warnings
Array<object>
object
Code
required
string
Message
required
string
Target
string
Field
string
Metadata
object
key
additional properties
string
Type
integer format: int32
Severity
integer format: int32
Success
boolean
Example
{ "Data": { "Kind": 0, "State": 0, "Origin": 0, "Outcome": 0 }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}