Skip to content

Generate Download Url Endpoint

POST
/user/generate-download-url
 
curl --request POST \
  --url https://example.com/user/generate-download-url \
  --header 'Content-Type: application/json' \
  --header 'X-Tenzir-UserKey: <X-Tenzir-UserKey>' \
  --data '{ "tenant_id": "example", "expiration": 3600, "filename": "example", "usage": "nodes_upload_nodes_download" }'

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
GenerateDownloadUrlRequest
object
tenant_id
required
Tenant Id
string
expiration
Expiration
number
default: 3600
filename
Any of:
string
usage
UrlpairUsageIntention
string
default: frontend_upload_frontend_download
Allowed values: nodes_upload_nodes_download nodes_upload_frontend_download nodes_download_frontend_upload frontend_upload_frontend_download

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
GenerateDownloadUrlResponse
object
upload_url
required
Upload Url
string
download_url
required
Download Url
string
Example generated
{
  "upload_url": "example",
  "download_url": "example"
}

403

Section titled “403 ”

{"detail": "Invalid API Key"} {"detail": "Not permitted to access this tenant"}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}