Xeonr Developer Docs
API SpecificationUploads

Create upload

POST
/uplim.api.v1.BucketUploadsService/CreateUpload

Finalizes an upload after the file has been uploaded to the presigned URL. Supports creating new uploads, replacing existing ones, or upserting by path.

Authorization

OAuth2 upl:uploads:create
AuthorizationBearer <token>

OAuth 2.0 authorization

In: header

Scope: upl:uploads:create

Header Parameters

Connect-Protocol-Version*number

Define the version of the Connect protocol

Value in1
Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

bucketRef?|

Reference to the bucket

uploadRequestId?string

Unique identifier for the upload request

filename?string

Name of the file to be uploaded

tags?tags

Tags to associate with the upload

uploadedBy?string

User who uploaded the file

slug?string|null

Optional slug for the upload (only used for new uploads)

dynamicSlug?integer|null

Optional dynamic slug for the upload (only used for new uploads)

Formatint32
partEtags?

List of part ETags for multipart uploads

allowAnyExtension?boolean
defaultSlugExtension?string|null
private?boolean|null

Private access for this upload. If null, inherits from parent folder.

directory?stringDeprecated

Deprecated: use target.create.directory instead

create*

Create a new upload in this directory

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://uploads-api.xeonr.io/uplim.api.v1.BucketUploadsService/CreateUpload" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "create": {}  }'
{
  "upload": {
    "uploadId": "string",
    "filename": "string",
    "path": "string",
    "slug": "string",
    "url": "string",
    "contentUrl": "string",
    "sizeBytes": 0,
    "type": "UPLOAD_TYPE_UNSPECIFIED",
    "tags": [
      "string"
    ],
    "oauthClientId": "6d6c655c-ec4d-46c8-93fc-cca588313cab",
    "oauthApplicationId": "6e68418e-eaad-4fd1-af9d-e9521eee4cbc",
    "allowAnyExtension": true,
    "defaultSlugExtension": "string",
    "generatedDescription": "string",
    "metaUploads": [
      {
        "type": {
          "type": "MetaUploadType_UNSPECIFIED",
          "n": 0,
          "filename": "string"
        },
        "metadataId": "string",
        "uploadUrl": "string",
        "downloadUrl": "string"
      }
    ],
    "private": true,
    "aliases": [
      {
        "aliasId": "string",
        "uploadId": "string",
        "path": "string",
        "slug": "string",
        "url": "string",
        "hasPassword": true,
        "expiresAt": "2023-01-15T01:30:15.01Z",
        "maxUses": 0,
        "useCount": 0,
        "allowedUserIds": [
          0
        ],
        "createdAt": "2023-01-15T01:30:15.01Z"
      }
    ]
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}