Skip to content

File Service API & Model Documentation (0.2.7)

Ruckus Network Technical Documents

Overview

Rate Limit

For the File REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 200 calls can be made per second.
  • Each second 100 calls will be returned to be used.
Download OpenAPI description
Download PDF
Languages
Servers
Generated server url

http://localhost/

File

Manage upload or download files.

Operations

Get Upload URL

Request

Get a URL with which to upload a file.

Bodyapplication/jsonrequired
fileExtensionstring
application/json
{
  "fileExtension": "string"
}

Responses

OK

Body*/*
fileIdstring
signedUrlstring

A signed URL is a URL that provides limited permission and time to make a request.

Get Download URL

Request

Get the URL from which to download this file.

Path
fileIdstringrequired
No request payload

Responses

Returns: Redirect (302) with the file signed url in 'Location' header

Headers
Locationany

The File Signed URL

Body*/*
string

Get File Download URL

Request

Get the URL from which to download this file.

Path
fileIdstringrequired
No request payload

Responses

Returns: the file signed url

Body*/*
fileIdstring
signedUrlstring

A signed URL is a URL that provides limited permission and time to make a request.