Configures future scheduled protection.

PUT

/api/workspace/file-protection/sources/{sourceId}/schedule

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/file-protection/sources/example/schedule"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"Enabled\": true, \"CronExpression\": \"example\", \"TimeZoneId\": \"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/schedule';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"Enabled":true,"CronExpression":"example","TimeZoneId":"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 PUT \
  --url https://example.com/api/workspace/file-protection/sources/example/schedule \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Enabled": true, "CronExpression": "example", "TimeZoneId": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

sourceId

required

string

Query Parameters

access_token

string

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

Request Body

Replaces the future Source schedule without cancelling accepted work.

object

Enabled

boolean

CronExpression

string

nullable

TimeZoneId

string

nullable

RowVersion

string format: uuid

Example^generated

{
  "Enabled": true,
  "CronExpression": "example",
  "TimeZoneId": "example",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Replaces the future Source schedule without cancelling accepted work.

object

Enabled

boolean

CronExpression

string

nullable

TimeZoneId

string

nullable

RowVersion

string format: uuid

Example^generated

{
  "Enabled": true,
  "CronExpression": "example",
  "TimeZoneId": "example",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Replaces the future Source schedule without cancelling accepted work.

object

Enabled

boolean

CronExpression

string

nullable

TimeZoneId

string

nullable

RowVersion

string format: uuid

Example^generated

{
  "Enabled": true,
  "CronExpression": "example",
  "TimeZoneId": "example",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

application/json

object

Data

Safe logical protection source without a physical machine path.

object

string

nullable

DisplayName

string

nullable

AssignedAgentId

string

nullable

State

State of one logical protection source.

integer format: int32

Allowed values: 0 1 2 3

Tags

Array<string>

nullable

LogicalName

string

nullable

LatestSizeBytes

integer format: int64

nullable

LastSuccessfulProtectionAtUtc

string format: date-time

nullable

LatestRun

Safe manual run projection.

object

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

RowVersion

string format: uuid

Deletion

Safe removal progress. Cancellation ends when irreversible cleanup starts.

object

RequestedAtUtc

string format: date-time

NotBeforeUtc

string format: date-time

StartedAtUtc

string format: date-time

nullable

SafeErrorCode

string

nullable

ConfirmedKind

Source selector interpreted only by the local Agent.

integer format: int32

Allowed values: 0 1 2

KindFrozenAtUtc

Once used, a confirmed local kind cannot be changed by another configuration.

string format: date-time

nullable

AllowedActions

Current source-scoped permissions; commands still authorize every request.

Array<string>

nullable

Schedule

Source-owned schedule, independent of its configuring user’s account.

object

Enabled

boolean

CronExpression

string

nullable

TimeZoneId

string

nullable

NextRunAtUtc

string format: date-time

nullable

LastRunAtUtc

string format: date-time

nullable

LatestScheduleOccurrence

Latest durable schedule decision and its authorized operation.

object

string

nullable

DueAtUtc

string format: date-time

Outcome

string

nullable

RunId

string

nullable

Run

Safe manual run projection.

object

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

SignalSummary

Compact active signal summary for object grids.

object

Count

integer format: int32

Severity

integer format: int32

Allowed values: 1 2

PolicyKinds

Array<integer>

nullable

Allowed values: 0 1 2 3 4 5

Conditions

Array<object>

nullable

Exact active type/severity association for combined grid filters.

object

PolicyKind

integer format: int32

Allowed values: 0 1 2 3 4 5

Severity

integer format: int32

Allowed values: 1 2

Count

integer format: int32

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,
    "LatestRun": {
      "Kind": 0,
      "State": 0,
      "Origin": 0,
      "Outcome": 0
    },
    "ConfirmedKind": 0,
    "LatestScheduleOccurrence": {
      "Run": {
        "Kind": 0,
        "State": 0,
        "Origin": 0,
        "Outcome": 0
      }
    },
    "SignalSummary": {
      "Severity": 1,
      "PolicyKinds": [
        0
      ],
      "Conditions": [
        {
          "PolicyKind": 0,
          "Severity": 1
        }
      ]
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Configures future scheduled protection.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

Example^generated

Example^generated

Example^generated