Get apiv1files

REST API for site file management.

list: GET /api/files/?site_id=X&category=Y create: POST /api/files/ (multipart) read: GET /api/files// update: PUT /api/files// (multipart) delete: DELETE /api/files// download: GET /api/files//download/

GET /api/v1/files/

cURL

cURL

curl --request GET \
  --url https://api.example.com/api/v1/files/ \
  --header 'Authorization: Bearer <token>'

200

{
  "count": 123,
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "site": "<string>",
      "name": "<string>",
      "file": "<string>",
      "uploaded_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "download_url": "<string>",
      "entity_uri": "<string>",
      "content_type": "<string>",
      "size_bytes": 4611686018427388000,
      "metadata": "<unknown>"
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit · integer

Number of results to return per page.

offset · integer

The initial index from which to return the results.

Response

200 - application/json

count · integer · required

Example:

123

results · object[] · required

Show child attributes

next · string<uri> | null

Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous · string<uri> | null

Example:

"http://api.example.org/accounts/?offset=200&limit=100"