Imports a complete kit into an unused installation: identity only or a recovery-only S3 catalog.

POST

/api/workspace/admin/file-protection/recovery/import

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/admin/file-protection/recovery/import"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new MultipartFormDataContent
    {
        new StringContent("")
        {
            Headers =
            {
                ContentType = new MediaTypeHeaderValue("application/octet-stream"),
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "Kit",
                    FileName = "file",
                }
            }
        },
        new StringContent("0")
        {
            Headers =
            {
                ContentType = new MediaTypeHeaderValue("text/plain"),
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "Mode",
                }
            }
        },
        new StringContent("2489E9AD-2EE2-8E00-8EC9-32D5F69181C0")
        {
            Headers =
            {
                ContentType = new MediaTypeHeaderValue("text/plain"),
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "RowVersion",
                }
            }
        },
    },
};
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/admin/file-protection/recovery/import';
const form = new FormData();
form.append('Kit', 'file');
form.append('Mode', '0');
form.append('RowVersion', '2489E9AD-2EE2-8E00-8EC9-32D5F69181C0');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

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/admin/file-protection/recovery/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form Kit=@file \
  --form Mode=0 \
  --form RowVersion=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Authorizations

WorkspaceBearer

Parameters

Query Parameters

access_token

string

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

Request Body

multipart/form-data

object

Kit

required

Recovery kit ZIP exported by the source installation, at most 128 KiB.

string format: binary

Mode

Identity re-use keeps this application’s binding; catalog import creates a recovery-only installation.

integer format: int32

Allowed values: 0 1

RowVersion

Current recovery row version when the installation already stores recovery access.

string format: uuid

Responses

200

object

Data

Redacted state and current retained-history coverage.

object

Ready

boolean

ReasonCode

string

nullable

MaskedAccessKey

string

nullable

ProjectId

string

nullable

IdentityFingerprint

string

nullable

RetainedPoints

integer format: int32

PreparedPoints

integer format: int32

RecoveryOnly

boolean

CanImportIdentity

boolean

RowVersion

string format: uuid

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

object

Data

Redacted state and current retained-history coverage.

object

Ready

boolean

ReasonCode

string

nullable

MaskedAccessKey

string

nullable

ProjectId

string

nullable

IdentityFingerprint

string

nullable

RetainedPoints

integer format: int32

PreparedPoints

integer format: int32

RecoveryOnly

boolean

CanImportIdentity

boolean

RowVersion

string format: uuid

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

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

object

Data

Redacted state and current retained-history coverage.

object

Ready

boolean

ReasonCode

string

nullable

MaskedAccessKey

string

nullable

ProjectId

string

nullable

IdentityFingerprint

string

nullable

RetainedPoints

integer format: int32

PreparedPoints

integer format: int32

RecoveryOnly

boolean

CanImportIdentity

boolean

RowVersion

string format: uuid

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

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

400

Bad Request

object

Data

Redacted state and current retained-history coverage.

object

Ready

boolean

ReasonCode

string

nullable

MaskedAccessKey

string

nullable

ProjectId

string

nullable

IdentityFingerprint

string

nullable

RetainedPoints

integer format: int32

PreparedPoints

integer format: int32

RecoveryOnly

boolean

CanImportIdentity

boolean

RowVersion

string format: uuid

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

object

Data

Redacted state and current retained-history coverage.

object

Ready

boolean

ReasonCode

string

nullable

MaskedAccessKey

string

nullable

ProjectId

string

nullable

IdentityFingerprint

string

nullable

RetainedPoints

integer format: int32

PreparedPoints

integer format: int32

RecoveryOnly

boolean

CanImportIdentity

boolean

RowVersion

string format: uuid

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

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

object

Data

Redacted state and current retained-history coverage.

object

Ready

boolean

ReasonCode

string

nullable

MaskedAccessKey

string

nullable

ProjectId

string

nullable

IdentityFingerprint

string

nullable

RetainedPoints

integer format: int32

PreparedPoints

integer format: int32

RecoveryOnly

boolean

CanImportIdentity

boolean

RowVersion

string format: uuid

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

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

403

Forbidden

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

Imports a complete kit into an unused installation: identity only or a recovery-only S3 catalog.

Authorizations

Parameters

Query Parameters

Request Body

Responses

200

Example

Example

400

Example

Example

403

Examplegenerated

Examplegenerated

Example^generated

Example^generated