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

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.

Response

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

Delete folder metadata

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.

Response

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

Set/change a key-value pair

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.

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

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.

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.