Skip to main content
POST
/
api
/
repositories
/
cURL
curl --request POST \
  --url https://{server}/api/repositories/ \
  --header 'Content-Type: application/json' \
  --cookie sessionid= \
  --data '
{
  "name": "<string>",
  "capacity": 1,
  "address": "<string>",
  "bucket": "<string>",
  "region": "<string>",
  "endpoint": "<string>",
  "access_key_id": "<string>",
  "secret_access_key": "<string>",
  "access_grant": "<string>",
  "irsa_role_arn": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "address": "<string>",
  "capacity": 0,
  "usage_bytes": 123,
  "asset_content_count": 123,
  "access_key_id_masked": "<string>",
  "provider": "<string>",
  "provisioning_error": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "is_active": true,
  "bucket": "<string>",
  "region": "<string>",
  "endpoint": "<string>",
  "irsa_role_arn": "<string>"
}

Authorizations

​
sessionid
string
cookie
required

Body

Write-side fields for Repository create + partial update.

Two callable paths depending on SPAWNER_BACKEND:

  • Legacy (SPAWNER_BACKEND=none): admin supplies address pointing at an already-running repo-agent. bucket / region / endpoint / keys are ignored.
  • Console-managed (SPAWNER_BACKEND=docker or kubernetes): admin supplies bucket / region / endpoint / access_key_id / secret_access_key. address is read-only — the Console computes it once the spawn succeeds.

The view picks the path.

​
name
string
required
Maximum string length: 255
​
type
enum<string>
required
  • s3 - S3
  • storj - Storj
  • posix - POSIX
Available options:
s3,
storj,
posix
​
capacity
integer
required
Required range: x >= 0
​
address
string
Maximum string length: 1024
​
bucket
string
Maximum string length: 255
​
region
string
Maximum string length: 64
​
endpoint
string
Maximum string length: 1024
​
access_key_id
string
write-only
Maximum string length: 255
​
secret_access_key
string
write-only
Maximum string length: 1024
​
access_grant
string
write-only
​
irsa_role_arn
string
Maximum string length: 2048

Response

201 - application/json
​
id
string<uuid>
required
read-only
​
name
string
required
Maximum string length: 255
​
type
enum<string>
required
  • s3 - S3
  • storj - Storj
  • posix - POSIX
Available options:
s3,
storj,
posix
​
address
string
required
Maximum string length: 1024
​
capacity
integer<int64>
required
Required range: -9223372036854776000 <= x <= 9223372036854776000
​
usage_bytes
integer<int64>
required
read-only
​
asset_content_count
integer<int64>
required
read-only
​
access_key_id_masked
string | null
required
read-only
​
provider
string
required
read-only
​
provisioning_status
enum<string>
required
  • pending - Pending
  • ready - Ready
  • failed - Failed
Available options:
pending,
ready,
failed
​
provisioning_error
string
required
read-only
​
created_at
string<date-time>
required
read-only
​
updated_at
string<date-time>
required
read-only
​
is_active
boolean
​
bucket
string
Maximum string length: 255
​
region
string
Maximum string length: 64
​
endpoint
string
Maximum string length: 1024
​
irsa_role_arn
string
Maximum string length: 2048