Creates a portable session for a legacy file or an explicit Source tree selection.

POST

/api/workspace/file-protection/recovery-points/{recoveryPointId}/restore-sessions

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/recovery-points/example/restore-sessions"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"RecoveryItemId\": \"example\", \"Selection\": { \"Mode\": 1, \"ItemIds\": [ \"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/recovery-points/example/restore-sessions';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"RecoveryItemId":"example","Selection":{"Mode":1,"ItemIds":["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/recovery-points/example/restore-sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "RecoveryItemId": "example", "Selection": { "Mode": 1, "ItemIds": [ "example" ] } }'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

recoveryPointId

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

Creates an expiring portable restore session for one exact item.

object

RecoveryItemId

string

nullable

Selection

Identifiers are resolved only against the selected point’s complete inventory.

object

Mode

Output selection within a Source; it is not a cryptographic access boundary.

integer format: int32

Allowed values: 1 2 3 4

ItemIds

Array<string>

nullable

Responses

200

application/json

object

Data

Created restore session and portable descriptor.

object

SessionId

string

nullable

ExpiresAtUtc

string format: date-time

Descriptor

Explicit versioned union under the existing Descriptor JSON member.

object

SchemaVersion

integer format: int32

GatewayUrl

string format: uri

nullable

SessionId

string

nullable

SessionToken

string

nullable

SourceId

string

nullable

RecoveryPointId

string

nullable

ExpiresAtUtc

string format: date-time

WindowsDownloadUrl

string format: uri

nullable

LinuxDownloadUrl

string format: uri

nullable

CopyableCommand

string

nullable

RowVersion

string format: uuid

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

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