Validates separate customer access before activating it for the existing S3 binding.

POST

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

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/credentials"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"AccessKey\": \"example\", \"SecretKey\": \"example\", \"ProjectId\": \"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/admin/file-protection/recovery/credentials';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"AccessKey":"example","SecretKey":"example","ProjectId":"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/admin/file-protection/recovery/credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "AccessKey": "example", "SecretKey": "example", "ProjectId": "example", "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

Customer-created S3 access for the existing bound storage. Never changes bucket or endpoint.

object

AccessKey

string

nullable

SecretKey

string

nullable

ProjectId

string

nullable

RowVersion

string format: uuid

nullable

Example^generated

{
  "AccessKey": "example",
  "SecretKey": "example",
  "ProjectId": "example",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Customer-created S3 access for the existing bound storage. Never changes bucket or endpoint.

object

AccessKey

string

nullable

SecretKey

string

nullable

ProjectId

string

nullable

RowVersion

string format: uuid

nullable

Example^generated

{
  "AccessKey": "example",
  "SecretKey": "example",
  "ProjectId": "example",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Customer-created S3 access for the existing bound storage. Never changes bucket or endpoint.

object

AccessKey

string

nullable

SecretKey

string

nullable

ProjectId

string

nullable

RowVersion

string format: uuid

nullable

Example^generated

{
  "AccessKey": "example",
  "SecretKey": "example",
  "ProjectId": "example",
  "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

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"
}

Validates separate customer access before activating it for the existing S3 binding.

Authorizations

Parameters

Query Parameters

Request Body

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

Example

400

Example

Example

403

Examplegenerated

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated