Folder metadata management

Metadata is a set of properties (key-value pairs) that can be set for folders to improve asset categorisation and search.

Interacting with the metadata can be achieved with the following APIs:

Set/change folder metadata

PUT /v4/folder/{folder_uuid}/meta

API permissions

DIR_META_CHANGE

Body

{
    "meta": {
        "key1": "hello",
        "key2": [
            "something",
            "else"
        ]
    }
}

Please note that any current metadata of the folder will be deleted. If you would like to just set/change a key-value pair, you can use the set a key-value pair method.

Try it out

Request

Copy-paste the cURL request in your Terminal or click on the API Explorer tab to see the API in action.

host: 'https://api.filerobot.com' path: "fudqadtm/v4/folder/{folder_uuid}/meta" headers: X-Filerobot-Key: 19692813e7364ef8ad6a6504d50a12ca variables: folder_uuid: 565c65f0-223f-5a35-adf1-f71d24c851e4 parameters: secret_key: ad9cf204-6c07-4256-b663-5a058655f48c body: | { "meta": { "test": "test meta" } } theme: clouds-midnight editor_theme: clouds_midnight method: PUT render: curl_tab: true

Response

{
    "status": "success",
    "action": "folder_meta_updated",
    "folder_uuid": "c7776493-566b-59e8-9e9c-a58282d85b35",
    "meta": {
        "test": "test meta"
    }
}

Delete folder metadata

DELETE /v4/folder/{folder_uuid}/meta

API permissions

DIR_META_CHANGE

Try it out

Request

Copy-paste the cURL request in your Terminal or click on the API Explorer tab to see the API in action.

host: 'https://api.filerobot.com' path: "fudqadtm/v4/folder/{folder_uuid}/meta" headers: X-Filerobot-Key: 19692813e7364ef8ad6a6504d50a12ca variables: folder_uuid: 565c65f0-223f-5a35-adf1-f71d24c851e4 parameters: secret_key: ad9cf204-6c07-4256-b663-5a058655f48c theme: clouds-midnight editor_theme: clouds_midnight method: DELETE render: curl_tab: true

Response

{
    "status": "success",
    "action": "folder_meta_deleted",
    "folder_uuid": "c7776493-566b-59e8-9e9c-a58282d85b35",
    "meta": {}
}

Set/change a key-value pair

PUT /v4/folder/{folder_uuid}/meta/{key}/{value}

API permissions

DIR_META_CHANGE

Try it out

Request

Copy-paste the cURL request in your Terminal or click on the API Explorer tab to see the API in action.

host: 'https://api.filerobot.com' path: "fudqadtm/v4/folder/{folder_uuid}/meta/{meta_name}/{meta_value}" headers: X-Filerobot-Key: 19692813e7364ef8ad6a6504d50a12ca variables: folder_uuid: 565c65f0-223f-5a35-adf1-f71d24c851e4 meta_name: my-key meta_value: my-value parameters: secret_key: ad9cf204-6c07-4256-b663-5a058655f48c theme: clouds-midnight editor_theme: clouds_midnight method: PUT render: curl_tab: true

Response

{
    "status": "success",
    "action": "meta_value_updated",
    "folder_uuid": "c7776493-566b-59e8-9e9c-a58282d85b35",
    "meta": {
        "test": "test value for meta"
    }
}

Delete a key-value pair

DELETE /v4/folder/{folder_uuid}/meta/{key}

API Permissions

DIR_META_CHANGE

Try it out

Request

Copy-paste the cURL request in your Terminal or click on the API Explorer tab to see the API in action.

host: 'https://api.filerobot.com' path: "fudqadtm/v4/folder/{folder_uuid}/meta/{meta_name}" headers: X-Filerobot-Key: 19692813e7364ef8ad6a6504d50a12ca variables: folder_uuid: 565c65f0-223f-5a35-adf1-f71d24c851e4 meta_name: my-key parameters: secret_key: ad9cf204-6c07-4256-b663-5a058655f48c theme: clouds-midnight editor_theme: clouds_midnight method: DELETE render: curl_tab: true

Response

{
    "status": "success",
    "action": "meta_value_deleted",
    "folder_uuid": "c7776493-566b-59e8-9e9c-a58282d85b35",
    "meta": {}
}

The response contains the remaining metadata of the respective folder.