API SpecificationUpload Aliases
Create upload alias
Creates a shareable alias link for an upload with optional access restrictions like password, expiry, use limits, and allowed users.
Authorization
OAuth2 upl:bucket:manageAuthorizationBearer <token>
OAuth 2.0 authorization
In: header
Scope: upl:bucket:manage
Header Parameters
Connect-Protocol-Version*number
Define the version of the Connect protocol
Value in
1Connect-Timeout-Ms?number
Define the timeout, in ms
Request Body
application/json
bucketRef?|
uploadId?string
ID of the upload to create alias for
Format
uuidpath?string|null
Path for the alias (optional, defaults to upload's path)
slug?string|null
Slug for the alias (optional, auto-generated if not provided)
password?string|null
Password to protect the alias (optional)
expiresAt?string
When the alias expires (optional, null = never)
Format
date-timemaxUses?integer|null
Maximum number of uses (optional, null = unlimited)
Format
int32allowedUserIds?
User IDs that are allowed to access (optional, empty = anyone)
[key: string]?never
Response Body
application/json
application/json
curl -X POST "https://uploads-api.xeonr.io/uplim.api.v1.UploadAliasService/CreateUploadAlias" \ -H "Connect-Protocol-Version: 1" \ -H "Content-Type: application/json" \ -d '{}'{
"alias": {
"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": {}
}
]
}