Creates or adopts a customer-owned Hetzner Protection Repository.

POST

/api/workspace/admin/file-protection/repository/setup-customer-owned

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/repository/setup-customer-owned"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"IdempotencyKey\": \"example\", \"ExpectedModuleRowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"RepositoryRowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"Region\": \"example\", \"AccessKey\": \"example\", \"SecretKey\": \"example\", \"ProvisioningMode\": 0, \"ExistingBucketName\": \"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/admin/file-protection/repository/setup-customer-owned';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"IdempotencyKey":"example","ExpectedModuleRowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","RepositoryRowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","Region":"example","AccessKey":"example","SecretKey":"example","ProvisioningMode":0,"ExistingBucketName":"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/admin/file-protection/repository/setup-customer-owned \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "IdempotencyKey": "example", "ExpectedModuleRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "RepositoryRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "Region": "example", "AccessKey": "example", "SecretKey": "example", "ProvisioningMode": 0, "ExistingBucketName": "example" }'

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

Creates or adopts a customer-owned Hetzner repository.

object

IdempotencyKey

string

nullable

ExpectedModuleRowVersion

string format: uuid

RepositoryRowVersion

string format: uuid

nullable

Region

string

nullable

AccessKey

string

nullable

SecretKey

string

nullable

ProvisioningMode

integer format: int32

Allowed values: 0 1

ExistingBucketName

string

nullable

Responses

200

application/json

object

Data

File Protection module administration detail.

object

Summary

File Protection lifecycle summary.

object

ModuleKey

string

nullable

DisplayName

string

nullable

Description

string

nullable

IsEnabled

boolean

ConfigurationState

integer format: int32

Allowed values: 0 1 2 3 4 5

EnabledAtUtc

string format: date-time

nullable

DisabledAtUtc

string format: date-time

nullable

DisabledReason

string

nullable

RowVersion

string format: uuid

nullable

AllowedActions

Allowed lifecycle actions for the current module state.

object

CanEnable

boolean

CanReconcileSecurity

boolean

CanDisable

boolean

Readiness

Capability-specific readiness of the installed File Protection foundation.

object

IsOperationallyHealthy

boolean

IsFullyReady

boolean

Capabilities

Array<object>

nullable

Availability of one delivered File Protection capability.

object

Key

integer format: int32

Allowed values: 0 1 2 3 4

IsAvailable

boolean

BlockerKeys

Array<string>

nullable

Blockers

Array<object>

nullable

One safe, machine-readable readiness problem.

object

Code

string

nullable

SuggestedAction

string

nullable

Contract

Installed public automation contract identity.

object

PackageId

string

nullable

ContractVersion

string

nullable

AssemblyVersion

string

nullable

Repository

Safe Protection Repository state visible to workspace administrators.

object

string

nullable

OwnershipMode

integer format: int32

Allowed values: 0 1 2

Provider

integer format: int32

Allowed values: 0

ProvisioningMode

integer format: int32

Allowed values: 0 1

State

integer format: int32

Allowed values: 0 1 2

Region

string

nullable

BucketName

string

nullable

ObjectLockMode

integer format: int32

Allowed values: 0

DefaultRetentionDays

integer format: int32

LastValidatedAtUtc

string format: date-time

nullable

LastErrorCode

string

nullable

RowVersion

string format: uuid

CanResumeSetup

boolean

CanChangeSetup

boolean

CanRepairCredentials

boolean

CanReconcile

boolean

RepositorySetup

Deployment-authorized repository setup choices.

object

ManagedStorageAvailable

boolean

CustomerOwnedStorageAvailable

boolean

Regions

Array<object>

nullable

Supported customer-owned Hetzner region.

object

Key

string

nullable

DisplayName

string

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

{
  "Data": {
    "Summary": {
      "ConfigurationState": 0
    },
    "Readiness": {
      "Capabilities": [
        {
          "Key": 0
        }
      ]
    },
    "Repository": {
      "OwnershipMode": 0,
      "Provider": 0,
      "ProvisioningMode": 0,
      "State": 0,
      "ObjectLockMode": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

File Protection module administration detail.

object

Summary

File Protection lifecycle summary.

object

ModuleKey

string

nullable

DisplayName

string

nullable

Description

string

nullable

IsEnabled

boolean

ConfigurationState

integer format: int32

Allowed values: 0 1 2 3 4 5

EnabledAtUtc

string format: date-time

nullable

DisabledAtUtc

string format: date-time

nullable

DisabledReason

string

nullable

RowVersion

string format: uuid

nullable

AllowedActions

Allowed lifecycle actions for the current module state.

object

CanEnable

boolean

CanReconcileSecurity

boolean

CanDisable

boolean

Readiness

Capability-specific readiness of the installed File Protection foundation.

object

IsOperationallyHealthy

boolean

IsFullyReady

boolean

Capabilities

Array<object>

nullable

Availability of one delivered File Protection capability.

object

Key

integer format: int32

Allowed values: 0 1 2 3 4

IsAvailable

boolean

BlockerKeys

Array<string>

nullable

Blockers

Array<object>

nullable

One safe, machine-readable readiness problem.

object

Code

string

nullable

SuggestedAction

string

nullable

Contract

Installed public automation contract identity.

object

PackageId

string

nullable

ContractVersion

string

nullable

AssemblyVersion

string

nullable

Repository

Safe Protection Repository state visible to workspace administrators.

object

string

nullable

OwnershipMode

integer format: int32

Allowed values: 0 1 2

Provider

integer format: int32

Allowed values: 0

ProvisioningMode

integer format: int32

Allowed values: 0 1

State

integer format: int32

Allowed values: 0 1 2

Region

string

nullable

BucketName

string

nullable

ObjectLockMode

integer format: int32

Allowed values: 0

DefaultRetentionDays

integer format: int32

LastValidatedAtUtc

string format: date-time

nullable

LastErrorCode

string

nullable

RowVersion

string format: uuid

CanResumeSetup

boolean

CanChangeSetup

boolean

CanRepairCredentials

boolean

CanReconcile

boolean

RepositorySetup

Deployment-authorized repository setup choices.

object

ManagedStorageAvailable

boolean

CustomerOwnedStorageAvailable

boolean

Regions

Array<object>

nullable

Supported customer-owned Hetzner region.

object

Key

string

nullable

DisplayName

string

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

{
  "Data": {
    "Summary": {
      "ConfigurationState": 0
    },
    "Readiness": {
      "Capabilities": [
        {
          "Key": 0
        }
      ]
    },
    "Repository": {
      "OwnershipMode": 0,
      "Provider": 0,
      "ProvisioningMode": 0,
      "State": 0,
      "ObjectLockMode": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

application/json

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

409

Conflict

application/json

object

Data

File Protection module administration detail.

object

Summary

File Protection lifecycle summary.

object

ModuleKey

string

nullable

DisplayName

string

nullable

Description

string

nullable

IsEnabled

boolean

ConfigurationState

integer format: int32

Allowed values: 0 1 2 3 4 5

EnabledAtUtc

string format: date-time

nullable

DisabledAtUtc

string format: date-time

nullable

DisabledReason

string

nullable

RowVersion

string format: uuid

nullable

AllowedActions

Allowed lifecycle actions for the current module state.

object

CanEnable

boolean

CanReconcileSecurity

boolean

CanDisable

boolean

Readiness

Capability-specific readiness of the installed File Protection foundation.

object

IsOperationallyHealthy

boolean

IsFullyReady

boolean

Capabilities

Array<object>

nullable

Availability of one delivered File Protection capability.

object

Key

integer format: int32

Allowed values: 0 1 2 3 4

IsAvailable

boolean

BlockerKeys

Array<string>

nullable

Blockers

Array<object>

nullable

One safe, machine-readable readiness problem.

object

Code

string

nullable

SuggestedAction

string

nullable

Contract

Installed public automation contract identity.

object

PackageId

string

nullable

ContractVersion

string

nullable

AssemblyVersion

string

nullable

Repository

Safe Protection Repository state visible to workspace administrators.

object

string

nullable

OwnershipMode

integer format: int32

Allowed values: 0 1 2

Provider

integer format: int32

Allowed values: 0

ProvisioningMode

integer format: int32

Allowed values: 0 1

State

integer format: int32

Allowed values: 0 1 2

Region

string

nullable

BucketName

string

nullable

ObjectLockMode

integer format: int32

Allowed values: 0

DefaultRetentionDays

integer format: int32

LastValidatedAtUtc

string format: date-time

nullable

LastErrorCode

string

nullable

RowVersion

string format: uuid

CanResumeSetup

boolean

CanChangeSetup

boolean

CanRepairCredentials

boolean

CanReconcile

boolean

RepositorySetup

Deployment-authorized repository setup choices.

object

ManagedStorageAvailable

boolean

CustomerOwnedStorageAvailable

boolean

Regions

Array<object>

nullable

Supported customer-owned Hetzner region.

object

Key

string

nullable

DisplayName

string

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

{
  "Data": {
    "Summary": {
      "ConfigurationState": 0
    },
    "Readiness": {
      "Capabilities": [
        {
          "Key": 0
        }
      ]
    },
    "Repository": {
      "OwnershipMode": 0,
      "Provider": 0,
      "ProvisioningMode": 0,
      "State": 0,
      "ObjectLockMode": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Creates or adopts a customer-owned Hetzner Protection Repository.

Authorizations

Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

409

Example

Example^generated