Xeonr Developer Docs
UplApiBuckets

Create bucket

POST
/uplim.api.v1.BucketsService/CreateBucket

Creates a new storage bucket with the specified configuration and destination settings.

Authorization

OAuth2 upl:bucket:manage
AuthorizationBearer <token>

OAuth 2.0 authorization

In: header

Scope: upl:bucket:manage

Header Parameters

Connect-Protocol-Version?number

Define the version of the Connect protocol

Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

bucketName?string

Name for the new bucket

Formathostname
Length3 <= length <= 64
aliases?aliases

Optional aliases for the bucket

Items0 <= items <= 8
description?string

Optional description of the bucket

Lengthlength <= 128
destination?string

Destination for the bucket enum.defined_only = true

Value in"BUCKET_DESTINATION_UNSPECIFIED" | "BUCKET_DESTINATION_DEFAULT" | "BUCKET_DESTINATION_S3_BUCKET" | "BUCKET_DESTINATION_S3_SERVER" | "BUCKET_DESTINATION_UPLIM_LITE"
destinationConfig?|
portalConfig?|null

Portal configuration for the bucket

slug?string|null

Permanent identifier for the bucket (DNS label, immutable, becomes the S3 bucket name). Omit to have one generated — never an error to leave unset. May not begin with "uplint-" (reserved for generated names).

Formathostname
Length2 <= length <= 64
private?boolean|null

Create the bucket private: no anonymous traffic, sharing only through presigned URLs and share links. Defaults to false. validate:skip a bool has no bounds

cors?|null

Optional CORS configuration. Omit to use the cdn_mode-derived default.

ownerTeam?string|null

Create the bucket owned by this team (urn:xeonr:auth:team:) instead of by the caller. Requires the caller to hold the upl "admin" team role in that team. Omit for a personal bucket.

Lengthlength <= 128
integrationBucketTypeId?string|null

Required when type = BUCKET_TYPE_INTEGRATION. Links the bucket to an IntegrationBucketType.

Formatuuid
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://uploads-api.xeonr.io/uplim.api.v1.BucketsService/CreateBucket" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "bucket": {
    "bucketId": "string",
    "bucketName": "string",
    "url": "string",
    "uploadCount": "string",
    "usedSpaceBytes": "string",
    "totalSpaceBytes": "string",
    "aliases": [
      "string"
    ],
    "isPrimary": true,
    "createdAt": "2023-01-15T01:30:15.01Z",
    "updatedAt": "2023-01-15T01:30:15.01Z",
    "type": "BUCKET_TYPE_UNSPECIFIED",
    "destination": "BUCKET_DESTINATION_UNSPECIFIED",
    "destinationConfig": {
      "s3Bucket": {
        "bucketName": "example.com",
        "region": "string",
        "roleArn": "string"
      }
    },
    "primaryAlias": "string",
    "portalConfig": {
      "cdnMode": true
    },
    "integrationBucketTypeId": "64e6bf6c-205f-4993-b9eb-3e0601207a25",
    "slug": "string",
    "private": true,
    "ownerTeam": "string",
    "ownerTeamSlug": "string",
    "cors": {
      "rules": [
        {
          "id": "string",
          "allowedOrigins": [
            "string"
          ],
          "allowedMethods": [
            "string"
          ],
          "allowedHeaders": [
            "string"
          ],
          "exposeHeaders": [
            "string"
          ],
          "maxAgeSeconds": 86400
        }
      ]
    },
    "policyJson": "string",
    "lifecycleRuleCount": 0
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}