Object Storage

get

Authorizations

bearer

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Query parameters

afterstringOptional

limitnumberOptional

Responses

200Success

application/json

get

/v1/object-storages

HTTPcURLJavaScriptPython

GET /v1/object-storages HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "paging": {
    "next": {
      "after": "text"
    }
  },
  "data": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}

get

Authorizations

bearer

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Path parameters

objectStorageIdstringRequired

Responses

200Success

application/json

idstringRequired

Unique ID

namestringRequired

The name of the object storage

get

/v1/object-storages/{objectStorageId}

HTTPcURLJavaScriptPython

GET /v1/object-storages/{objectStorageId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "text",
  "name": "text"
}

post

Authorizations

bearer

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Path parameters

objectStorageIdstringRequired

Query parameters

pathstringOptional

Responses

200Success

application/json

filePathstringRequired

The path within the storage where the file has been stored

sizeKbnumberRequired

The stored file size in kb

storagestringRequired

The Object Storage Id on which the file has been uploaded

post

/v1/object-storages/{objectStorageId}/upload

HTTPcURLJavaScriptPython

POST /v1/object-storages/{objectStorageId}/upload HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "filePath": "text",
  "sizeKb": 1,
  "storage": "text"
}

get

Authorizations

bearer

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Path parameters

objectStorageIdstringRequired

Query parameters

pathstringRequired

Responses

200Success

No content

get

/v1/object-storages/{objectStorageId}/download

HTTPcURLJavaScriptPython

GET /v1/object-storages/{objectStorageId}/download?path=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

No content