Resources

Upload, list, move, rename, and delete CMS resources.

Resources are uploaded media and files, such as images, PDFs, and videos, that CMS items can reference. They live in resource folders configured in the Online Editor.

GET /cms/resources

List entries in a resource folder.

Field
Value

Auth

Required

Role

Any API key user

Query string:

Name
Type
Description

folder

int

Resource folder index. Defaults to 0.

subpath

string

Optional subfolder to list.

Response:

{
  "folder": { "index": 0, "label": "Uploads" },
  "subpath": "",
  "dirs": [
    { "name": "blog", "type": "dir" }
  ],
  "files": [
    {
      "name": "hero.jpg",
      "size": 120938,
      "url": "/assets/hero.jpg",
      "modified": 1714000000,
      "is_image": true
    }
  ],
  "license": { "valid": true }
}

POST /cms/resources

Upload a file with multipart/form-data.

Field
Value

Auth

Required

Role

Any API key user

Form fields:

Name
Type
Description

file

file

Required uploaded file bytes.

folder

int

Resource folder index. Defaults to 0.

subpath

string

Optional destination subfolder.

The JSON API does not accept base64 resource uploads. See Uploads for worked examples.

Response:

PATCH /cms/resources

Rename or move a file.

Field
Value

Auth

Required

Role

Any API key user

Rename body:

Move body:

DELETE /cms/resources

Delete a file.

Field
Value

Auth

Required

Role

Any API key user

Body:

POST /cms/resources/folders

Create a subfolder inside a resource folder.

Field
Value

Auth

Required

Role

Any API key user

Body:

Last updated

Was this helpful?