# Cloudinary Integration via LowCodeAPI
## Overview
Image and video management
## Base Endpoint
```
https://api.lowcodeapi.com/cloudinary/
```
## Authentication
LowCodeAPI handles authentication automatically. You only need to:
1. **Sign up** at [https://cloudinary.com](https://cloudinary.com)
2. **Get your credentials** from [https://console.cloudinary.com/settings/api-keys](https://console.cloudinary.com/settings/api-keys)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests
The `api_token` is your LowCodeAPI authentication token. LowCodeAPI will automatically:
- Fetch your Cloudinary credentials
- Apply them to each request
**Auth Type**: API Key
## API Categories
- Cloud Storage
## Common Endpoints
### Category: Admin / Folders
#### Get root folders
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/folders`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/folders?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/folders?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#get_root_folders](https://cloudinary.com/documentation/admin_api#get_root_folders)
---
#### Get subfolders
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/folders/folder`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/folders/folder?cloud_name={cloud_name}&folder={folder}&...&api_token={api_token}
```
**Query Parameters**:
| `max_results` | number | No | Maximum number of results to return (up to 500). Default- 10. |
| `next_cursor` | String | No | When a request has more results to return than max_results; the next_cursor value is returned as part of the response. You can then specify this value as the next_cursor parameter of a following request. |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `folder` | string | The full path of the parent folder whose subfolders you want to return. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/folders/folder?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#get_subfolders](https://cloudinary.com/documentation/admin_api#get_subfolders)
---
#### Create folder
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/folders/folder`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/folders/folder?cloud_name={cloud_name}&folder={folder}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `folder` | string | The full path of the new asset folder. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/folders/folder?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#create_folder](https://cloudinary.com/documentation/admin_api#create_folder)
---
#### Delete folder
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/cloud_name/folders/folder`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/folders/folder?cloud_name={cloud_name}&folder={folder}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `folder` | string | The full path of the empty folder to delete. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/folders/folder?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#delete_folder](https://cloudinary.com/documentation/admin_api#delete_folder)
---
### Category: Structured metadata / Metadata
#### Get metadata field
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/metadata_fields`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_fields?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_fields?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/metadata_api#get_metadata_fields](https://cloudinary.com/documentation/metadata_api#get_metadata_fields)
---
#### Get a metadata field by external ID
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/metadata_fields/external_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_fields/external_id?cloud_name={cloud_name}&external_id={external_id}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `external_id` | string | The ID of the metadata field (included in the endpoint URL when using the REST API). |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_fields/external_id?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/metadata_api#get_a_metadata_field_by_external_id](https://cloudinary.com/documentation/metadata_api#get_a_metadata_field_by_external_id)
---
#### Create a metadata field
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/metadata_fields`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_fields?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `field` | object | Yes | The metadata field to add. For details see Metadata field structure. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_fields?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"field":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/metadata_api#create_a_metadata_field](https://cloudinary.com/documentation/metadata_api#create_a_metadata_field)
---
#### Restore entries in a metadata field datasource
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/metadata_fields/external_id/datasource_restore`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_fields/external_id/datasource_restore?cloud_name={cloud_name}&external_id={external_id}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `external_id` | string | The ID of the metadata field (included in the endpoint URL when using the REST API). |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `external_ids` | array | Yes | An array of IDs of datasource entries to restore (unblock). |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_fields/external_id/datasource_restore?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"external_ids":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/metadata_api#restore_entries_in_a_metadata_field_datasource](https://cloudinary.com/documentation/metadata_api#restore_entries_in_a_metadata_field_datasource)
---
#### Update a metadata field by external ID
**Method**: `PUT` | **LowCodeAPI Path**: `/v1_1/cloud_name/metadata_fields/external_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_fields/external_id?cloud_name={cloud_name}&external_id={external_id}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `external_id` | string | The ID of the metadata field (included in the endpoint URL when using the REST API). |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `field` | object | Yes | The metadata field to update. For details see Metadata field structure. |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_fields/external_id?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"field":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/metadata_api#update_a_metadata_field_by_external_id](https://cloudinary.com/documentation/metadata_api#update_a_metadata_field_by_external_id)
---
#### Update a metadata field datasource
**Method**: `PUT` | **LowCodeAPI Path**: `/v1_1/cloud_name/metadata_fields/external_id/datasource`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_fields/external_id/datasource?cloud_name={cloud_name}&external_id={external_id}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `external_id` | string | The ID of the metadata field (included in the endpoint URL when using the REST API). |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `entries` | object | Yes | The datasource enties to update. For details see Datasource values. |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_fields/external_id/datasource?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"entries":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/metadata_api#update_a_metadata_field_datasource](https://cloudinary.com/documentation/metadata_api#update_a_metadata_field_datasource)
---
#### Delete a metadata field by external ID
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/cloud_name/metadata_fields/external_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_fields/external_id?cloud_name={cloud_name}&external_id={external_id}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `external_id` | string | The ID of the metadata field (included in the endpoint URL when using the REST API). |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_fields/external_id?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/metadata_api#delete_a_metadata_field_by_external_id](https://cloudinary.com/documentation/metadata_api#delete_a_metadata_field_by_external_id)
---
#### Delete entries in a metadata field datasource
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/cloud_name/metadata_fields/external_id/datasource`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_fields/external_id/datasource?cloud_name={cloud_name}&external_id={external_id}&...&api_token={api_token}
```
**Query Parameters**:
| `external_ids` | array | Yes | An array of IDs of datasource entries to delete. |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `external_id` | string | The ID of the metadata field (included in the endpoint URL when using the REST API). |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_fields/external_id/datasource?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/metadata_api#delete_entries_in_a_metadata_field_datasource](https://cloudinary.com/documentation/metadata_api#delete_entries_in_a_metadata_field_datasource)
---
### Category: Structured metadata / Conditional metadata rules
#### Get metadata rules
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/metadata_rules`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_rules?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_rules?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/conditional_metadata_rules_api#get_metadata_rules](https://cloudinary.com/documentation/conditional_metadata_rules_api#get_metadata_rules)
---
#### Create a metadata rule
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/metadata_rules`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_rules?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `metadata_field_id` | string | Yes | The external_id of the metadata field that this rule applies to. |
| `condition` | object | Yes | The condition to evaluate. For details see Condition structure. |
| `result` | object | Yes | The result to apply in the case that the condition is met. For details see Result structure. |
| `name` | string | Yes | The name of the metadata rule. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_rules?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"metadata_field_id":"value","condition":"value","result":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/conditional_metadata_rules_api#create_a_metadata_rule](https://cloudinary.com/documentation/conditional_metadata_rules_api#create_a_metadata_rule)
---
#### Update a metadata rule by id
**Method**: `PUT` | **LowCodeAPI Path**: `/v1_1/cloud_name/metadata_rules/external_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_rules/external_id?cloud_name={cloud_name}&external_id={external_id}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `external_id` | string | The ID of the metadata rule (included in the endpoint URL when using the REST API). |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `metadata_field_id` | string | No | The external_id of the metadata field that this rule applies to. |
| `condition` | object | No | The condition to evaluate. For details see Condition structure. |
| `result` | object | No | The result to apply in the case that the condition is met. For details see Result structure. |
| `name` | string | No | The name of the metadata rule. |
| `state` | string | No | The current status of the rule; useful for inactivating a rule without deleting it. Possible values- active or inactive |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_rules/external_id?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"metadata_field_id":"value","condition":"value","result":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/conditional_metadata_rules_api#update_a_metadata_rule_by_id](https://cloudinary.com/documentation/conditional_metadata_rules_api#update_a_metadata_rule_by_id)
---
#### Delete a metadata rule by id
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/cloud_name/metadata_rules/external_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_rules/external_id?cloud_name={cloud_name}&external_id={external_id}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `external_id` | string | The ID of the metadata rule (included in the endpoint URL when using the REST API). |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/metadata_rules/external_id?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/conditional_metadata_rules_api#delete_a_metadata_rule_by_id](https://cloudinary.com/documentation/conditional_metadata_rules_api#delete_a_metadata_rule_by_id)
---
### Category: Admin / Ping
#### Pings Cloudinary servers
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/ping`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/ping?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/ping?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#ping](https://cloudinary.com/documentation/admin_api#ping)
---
### Category: Admin / Resources
#### Lists resources (assets) with a specified tag
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/resources/resource_type/tags/tag`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/tags/tag?cloud_name={cloud_name}&resource_type={resource_type}&tag={tag}&...&api_token={api_token}
```
**Query Parameters**:
| `max_results` | number | No | Maximum number of assets to return (maximum=500). Default- 10. |
| `next_cursor` | string | No | When a request has more results to return than max_results; the next_cursor value is returned as part of the response. You can then specify this value as the next_cursor parameter of the following request. |
| `direction` | string|number | No | Control the order of returned assets; according to the created_at date. Note- if a prefix is specified; this parameter is ignored and the results are sorted by public ID. Possible values- desc or -1 (default); asc or 1. |
| `tags` | boolean | No | Whether to include the list of tag names assigned to each asset. Default- false. |
| `context` | boolean | No | Whether to include key-value pairs of contextual metadata associated with each asset. Default- false. |
| `moderations` | boolean | No | Whether to include image moderation status of each asset. Default- false. |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of asset. Relevant as a parameter only when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Note- use video for all video and audio assets; such as .mp3. Possible values- image (default); raw; video. |
| `tag` | string | The assets to return that have this tag. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/tags/tag?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#get_resources_by_tag](https://cloudinary.com/documentation/admin_api#get_resources_by_tag)
---
#### Retrieves resources (assets) with a specified contextual metadata key
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/resources/resource_type/context`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/context?cloud_name={cloud_name}&resource_type={resource_type}&...&api_token={api_token}
```
**Query Parameters**:
| `key` | string | Yes | Only assets with this contextual metadata key are returned. |
| `value` | string | No | Only assets with this value for the contextual metadata key are returned. If this parameter is not provided; all assets with the specified contextual metadata key are returned; regardless of the actual value of the key. |
| `max_results` | number | No | Maximum number of assets to return (maximum=500). Default- 10. |
| `next_cursor` | string | No | When a request has more results to return than max_results; the next_cursor value is returned as part of the response. You can then specify this value as the next_cursor parameter of the following request. |
| `direction` | string|number | No | Control the order of returned assets; according to the created_at date. Note- if a prefix is specified; this parameter is ignored and the results are sorted by public ID. Possible values- desc or -1 (default); asc or 1. |
| `tags` | boolean | No | Whether to include the list of tag names assigned to each asset. Default- false. |
| `context` | boolean | No | Whether to include key-value pairs of contextual metadata associated with each asset. Default- false. |
| `moderations` | boolean | No | Whether to include image moderation status of each asset. Default- false. |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of asset. Relevant as a parameter only when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Note- use video for all video and audio assets; such as .mp3. Possible values- image (default); raw; video. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/context?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#get_resources_by_context](https://cloudinary.com/documentation/admin_api#get_resources_by_context)
---
#### Retrieves resources (assets) with a particular status from a specified moderation type
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/resources/resource_type/moderations/moderation_kind/status`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/moderations/moderation_kind/status?cloud_name={cloud_name}&resource_type={resource_type}&moderation_kind={moderation_kind}&status={status}&...&api_token={api_token}
```
**Query Parameters**:
| `max_results` | number | No | Maximum number of assets to return (maximum=500). Default- 10. |
| `next_cursor` | string | No | When a request has more results to return than max_results; the next_cursor value is returned as part of the response. You can then specify this value as the next_cursor parameter of the following request. |
| `direction` | string|number | No | Control the order of returned assets; according to the created_at date. Note- if a prefix is specified; this parameter is ignored and the results are sorted by public ID. Possible values- desc or -1 (default); asc or 1. |
| `tags` | boolean | No | Whether to include the list of tag names assigned to each asset. Default- false. |
| `context` | boolean | No | Whether to include key-value pairs of contextual metadata associated with each asset. Default- false. |
| `moderations` | boolean | No | Whether to include image moderation status of each asset. Default- false. |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of asset. Relevant as a parameter only when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Note- use video for all video and audio assets; such as .mp3. Possible values- image (default); raw; video. |
| `moderation_kind` | string | The type of moderation list to retrieve. Possible values- manual; webpurify; aws_rek; perception_point. |
| `status` | string | The moderation status of assets to retrieve. Possible values- pending; approved; rejected; queued; aborted.
Note- queued and aborted are relevant only when an asset is marked for multiple moderations. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/moderations/moderation_kind/status?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#get_resources_in_moderation](https://cloudinary.com/documentation/admin_api#get_resources_in_moderation)
---
#### Return details of the requested resource (asset) as well as all its derived assets
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/resources/resource_type/type/public_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/type/public_id?cloud_name={cloud_name}&resource_type={resource_type}&type={type}&public_id={public_id}&...&api_token={api_token}
```
**Query Parameters**:
| `colors` | boolean | No | Whether to include color information- predominant colors and histogram of 32 leading colors. Default- false. |
| `media_metadata` | boolean | No | Whether to include IPTC; XMP; and detailed Exif metadata in the response.
Default- false.
This parameter applies to both image and video asset types (including audio files). The exact set of metadata fields that gets returned for an asset depends on the asset type.
Note- Using this parameter also returns the asset's ETag value for all asset types; including raw. |
| `exif` | boolean | No | Deprecated. Use media_metadata instead. Default- false. |
| `image_metadata` | boolean | No | Deprecated. Use media_metadata instead. Default- false. |
| `faces` | boolean | No | Whether to include a list of coordinates of detected faces. Default- false. |
| `quality_analysis` | boolean | No | Whether to return quality analysis scores for the image. Default- false. |
| `accessibility_analysis` | boolean | No | Whether to return accessibility analysis scores for the image. Default- false. |
| `pages` | boolean | No | Whether to report the number of pages in multi-page documents (e.g.; PDF). Default- false. |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of asset. Relevant as a parameter only when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Note- use video for all video and audio assets; such as .mp3. Possible values- image (default); raw; video. |
| `type` | string | The delivery type; relevant as a parameter only when using the SDKs (the type is included in the endpoint URL when using the REST API). Possible values- upload; private; authenticated; facebook; twitter; gravatar; youtube; hulu; vimeo; animoto; worldstarhiphop; dailymotion; list. Default- upload |
| `public_id` | string | The public ID of the asset. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/type/public_id?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#get_the_details_of_a_single_resource](https://cloudinary.com/documentation/admin_api#get_the_details_of_a_single_resource)
---
#### Update one or more of the attributes associated with a specified resource (asset)
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/resources/resource_type/type/public_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/type/public_id?cloud_name={cloud_name}&resource_type={resource_type}&type={type}&public_id={public_id}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of asset. Relevant as a parameter only when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Note- use video for all video and audio assets; such as .mp3. Possible values- image (default); raw; video. |
| `type` | string | The delivery type; relevant as a parameter only when using the SDKs (the type is included in the endpoint URL when using the REST API). Possible values- upload; private; authenticated; facebook; twitter; gravatar; youtube; hulu; vimeo; animoto; worldstarhiphop; dailymotion. Default- all. |
| `public_id` | string | The public ID of the asset to update. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `display_name` | string | No | Relevant only for product environments using dynamic folder mode.
A user-friendly name for the asset.
Display names can have spaces and special characters; but can't include forward slashes (/). This name can be completely different than the asset's public id and its value doesn't impact the delivery URL in any way.
The display name is shown in user interface pages such as the Console Media Library; Cloudinary collections; and Cloudinary media portals.
Though not a best practice; it's possible for the same display name to be used for different assets; even in the same asset folder. |
| `unique_display_name` | boolean | No | Relevant only for product environments using dynamic folder mode.
If true; and you've passed a display_name that already exists within the same asset_folder or you specify a new asset_folder value (to move the asset) and the same display name already exists in the target asset folder; a random character suffix will be appended to the display name of this asset to ensure it's uniqueness within the asset folder.
Default- false |
| `asset_folder` | string | No | Relevant only for product environments using dynamic folder mode.
The folder where the asset is placed within the Cloudinary repository.
Setting this value in an update method moves the asset to the specified asset folder; but does not impact the asset’s public ID path. |
| `tags` | string | No | A comma-separated list of tag names to assign to the uploaded asset for later group reference. |
| `context` | string | No | A map (using the SDKs) or pipe-separated list (for REST API calls) of key-value pairs of contextual metadata to attach to an uploaded asset. The contextual metadata values of uploaded files can be retrieved using the Admin API. For example- `alt=My image |
| `metadata` | string | No | A map (supported for Java SDK only) or pipe-separated list (for REST API calls) of custom metadata fields (by external\_id) and the values to assign to each of them. For example- in_stock_id=50❘color_id=[\"green\";\"red\"].
SDKs- Supports maps.
Notes-
The =; " and ❘ characters can be supported as values when escaped with a prepended backslash (\).
For a multi-select field; you can set a maximum of 3000 different metadata values on an asset. |
| `face_coordinates` | string | No | List of coordinates of faces contained in an uploaded image. The specified coordinates are used for cropping uploaded images using the face or faces gravity mode. The specified coordinates override the automatically detected faces. Each face is specified by the X & Y coordinates of the top left corner and the width & height of the face. The coordinates are comma separated while faces are concatenated with a pipe (` |
| `custom_coordinates` | string | No | Coordinates of an interesting region contained in an uploaded image. The specified coordinates are used for cropping uploaded images using the custom gravity mode. The region is specified by the X & Y coordinates of the top left corner and the width & height of the region. For example- 85;120;220;310. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/type/public_id?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"display_name":"value","unique_display_name":"value","asset_folder":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#update_details_of_an_existing_resource](https://cloudinary.com/documentation/admin_api#update_details_of_an_existing_resource)
---
#### Restores one or more resources (assets) from backup
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/resources/resource_type/type/restore`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/type/restore?cloud_name={cloud_name}&resource_type={resource_type}&type={type}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The asset type of the requested assets. Relevant as a parameter only when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Note- use video for all video and audio assets; such as .mp3. Possible values- image (default); raw; video. |
| `type` | string | The delivery type of the requested assets; relevant as a parameter only when using the SDKs (the type is included in the endpoint URL when using the REST API). Possible values- upload; private; authenticated; Default- upload. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `public_ids` | array | Yes | The public IDs of (deleted or existing) backed up assets to restore (array of up to 100 public_ids). By default; the latest backed up version of the asset is restored. If the versions parameter is specified; the corresponding version of each public ID is restored. |
| `versions` | array | No | The version of each of the assets to restore. Specify the version_id for each public ID. Use the resource method to list details of backed up versions of an asset. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/type/restore?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"public_ids":"value","versions":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#restore_resources](https://cloudinary.com/documentation/admin_api#restore_resources)
---
#### Update the access_mode of resources (assets) by public_id(s), by tag, or by prefix
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/resources/resource_type/upload/update_access_mode`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/upload/update_access_mode?cloud_name={cloud_name}&resource_type={resource_type}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of asset. Relevant as a parameter only when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Note- use video for all video and audio assets; such as .mp3. Possible values- image (default); raw; video. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `access_mode` | string | Yes | The new access mode to be set. Possible values- public; authenticated. |
| `One of the following-
- public_ids` | array | Yes | Update all assets with the specified public IDs (array of up to 100 public_ids). |
| `- prefix` | string | Yes | Update all assets where the public ID starts with the specified prefix (up to a maximum of 100 matching original assets). |
| `- tag` | string | Yes | Update all assets with the specified tag (up to a maximum of 100 matching original assets). |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/upload/update_access_mode?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"access_mode":"value","One of the following- \n- public_ids":"value","- prefix":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#update_access_mode](https://cloudinary.com/documentation/admin_api#update_access_mode)
---
#### Relates an asset to other assets by public IDs
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/resources/related_assets/resource_type/type/public_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/related_assets/resource_type/type/public_id?cloud_name={cloud_name}&resource_type={resource_type}&type={type}&public_id={public_id}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of asset is included in the endpoint URL. Note- use video for all video and audio assets; such as .mp3. Possible values- image; raw; video. |
| `type` | string | The delivery type is included in the endpoint URL. Possible values- upload; private; authenticated. |
| `public_id` | string | The public ID of the asset to update. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `assets_to_relate` | array | Yes | Relates the asset to all the assets specified in this array of up to 10 assets; specified as resource_type/type/public_id. For example- ["image/upload/dog";"video/authenticated/cat"] |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/related_assets/resource_type/type/public_id?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"assets_to_relate":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#add_related_assets](https://cloudinary.com/documentation/admin_api#add_related_assets)
---
#### Unrelates related assets by public IDs
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/cloud_name/resources/related_assets/resource_type/type/public_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/related_assets/resource_type/type/public_id?cloud_name={cloud_name}&resource_type={resource_type}&type={type}&public_id={public_id}&...&api_token={api_token}
```
**Query Parameters**:
| `assets_to_unrelate` | array | Yes | Unrelates the asset from all the assets specified in this array of assets; specified as resource_type/type/public_id. For example- ["image/upload/dog";"video/authenticated/cat"] |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of asset is included in the endpoint URL. Note- use video for all video and audio assets; such as .mp3. Possible values- image; raw; video. |
| `type` | string | The delivery type is included in the endpoint URL. Possible values- upload; private; authenticated. |
| `public_id` | string | The public ID of the asset to update. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/related_assets/resource_type/type/public_id?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#delete_related_assets](https://cloudinary.com/documentation/admin_api#delete_related_assets)
---
#### Deletes resources by public IDs
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/cloud_name/resources/resource_type/type`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/type?cloud_name={cloud_name}&resource_type={resource_type}&type={type}&...&api_token={api_token}
```
**Query Parameters**:
| `public_ids` | array | Yes | delete all assets with the specified public IDs (array of up to 100 public_ids). |
| `prefix` | string | Yes | Delete all assets; including derived assets; where the public ID starts with the specified prefix (up to a maximum of 1000 original resources). |
| `all` | boolean | Yes | Delete all assets (of the relevant resource_type and type); including derived assets (up to a maximum of 1000 original resources). |
| `keep_original` | boolean | No | Whether to delete only the derived assets. Default- false. |
| `invalidate` | boolean | No | Whether to also invalidate the copies of the resource on the CDN. It usually takes between a few seconds and a few minutes for the invalidation to fully propagate through the CDN. There are also a number of other important considerations to keep in mind when invalidating files. Note that by default this parameter is not enabled- if you need this parameter enabled; please open a support request. Default- false. |
| `next_cursor` | string | No | When a deletion request has more than 1000 resources to delete; the response includes the partial boolean parameter set to true; as well as a next_cursor value. You can then specify this returned next_cursor value as a parameter of the following deletion request. |
| `transformations` | string | No | Only the derived assets matching this hash of transformation parameters will be deleted. |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of asset. Relevant as a parameter only when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Note- use video for all video and audio assets; such as .mp3. Possible values- image (default); raw; video. |
| `type` | string | The delivery type; relevant as a parameter only when using the SDKs (the type is included in the endpoint URL when using the REST API). Possible values- upload; private; fetch;authenticated; facebook; twitter; gravatar; youtube; hulu; vimeo; animoto; worldstarhiphop; dailymotion; list. Default- upload. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/type?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#delete_resources](https://cloudinary.com/documentation/admin_api#delete_resources)
---
#### Deletes resources by tags
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/cloud_name/resources/resource_type/tags/tag`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/tags/tag?cloud_name={cloud_name}&resource_type={resource_type}&tag={tag}&...&api_token={api_token}
```
**Query Parameters**:
| `keep_original` | boolean | No | Whether to delete only the derived assets. Default- false. |
| `invalidate` | boolean | No | Whether to also invalidate the copies of the resource on the CDN. It usually takes between a few seconds and a few minutes for the invalidation to fully propagate through the CDN. There are also a number of other important considerations to keep in mind when invalidating files. Note that by default this parameter is not enabled- if you need this parameter enabled; please open a support request. Default- false. |
| `next_cursor` | string | No | When a deletion request has more than 1000 resources to delete; the response includes the partial boolean parameter set to true; as well as a next_cursor value. You can then specify this returned next_cursor value as a parameter of the following deletion request. |
| `transformations` | string | No | Only the derived assets matching this hash of transformation parameters will be deleted. |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of asset. Relevant as a parameter only when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Note- use video for all video and audio assets; such as .mp3. Possible values- image (default); raw; video. |
| `tag` | string | Delete all assets (and their derivatives) with the specified tag name (up to a maximum of 1000 original assets). |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/resource_type/tags/tag?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#delete_resources_by_tags](https://cloudinary.com/documentation/admin_api#delete_resources_by_tags)
---
#### Deletes derived resources
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/cloud_name/derived_resources`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/derived_resources?cloud_name={cloud_name}&...&api_token={api_token}
```
**Query Parameters**:
| `derived_resource_ids` | array | Yes | Delete all assets with the specified derived_resource_ids IDs (array of up to 100 IDs). The derived asset IDs are returned when calling the Details of a single resource method. |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/derived_resources?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#delete_derived_resources](https://cloudinary.com/documentation/admin_api#delete_derived_resources)
---
### Category: Search / Search method
#### Find the specific assets in your product environment
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/resources/search`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/search?cloud_name={cloud_name}&...&api_token={api_token}
```
**Query Parameters**:
| `expression` | string | No | The (Lucene-like) string expression specifying the search query. If this parameter is not provided then all resources are listed (up to max_results). For details; see the expressions documentation. |
| `sort_by` | array | No | An array of string values representing a key value pair; where the key is the field to sort by and the value is the direction. Valid sort directions are asc or desc. If this parameter is not provided then the results are sorted by descending creation date. You can specify more than one sort_by parameter; results will be sorted according to the order of the fields provided.
Note- you can also sort the results by relevance if you set the key to score and give a sort direction as the value. Results are considered more relevant if the search term appears in multiple fields or in a more prominent field (e.g.; the public ID field). |
| `max_results` | number | No | Maximum number of assets to return (maximum=500). Default- 10. |
| `next_cursor` | string | No | When a request has more results to return than max_results; the next_cursor value is returned as part of the response. You can then specify this value as the next_cursor parameter of the following request. |
| `with_field` | string | No | The name of an additional asset attribute to include for each asset in the response. You can specify more than one with_field parameter. Possible value- context; tags; and for Tier 2 also metadata; image_metadata; and image_analysis. |
| `aggregate` | string | No | (Tier 2 only) The name of a field (attribute) for which an aggregation count should be calculated and returned in the response. You can specify more than one aggregate parameter. Supported values- resource_type; type; pixels (only the image assets in the response are aggregated); duration (only the video assets in the response are aggregated); format; and bytes. For aggregation fields without discrete values; the results are divided into categories. For example-
- bytes are divided into small (<500 kb); medium (500 kb - 5 mb); large (5 mb - 100 mb); and huge (>100 mb).
- Video duration is divided into short (< 3 minutes); medium (3-12 min); and long (> 12 min). |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resources/search?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/search_api#search_method](https://cloudinary.com/documentation/search_api#search_method)
---
### Category: Admin / Streaming profiles
#### Lists the List streaming profiles
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/streaming_profiles`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/streaming_profiles?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/streaming_profiles?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#get_adaptive_streaming_profiles](https://cloudinary.com/documentation/admin_api#get_adaptive_streaming_profiles)
---
#### Lists the details of a single streaming profile by name
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/streaming_profiles/name`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/streaming_profiles/name?cloud_name={cloud_name}&name={name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `name` | string | The name of the streaming profile to get the details of. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/streaming_profiles/name?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#get_details_of_a_single_streaming_profile](https://cloudinary.com/documentation/admin_api#get_details_of_a_single_streaming_profile)
---
#### Create a new streaming profile
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/streaming_profiles`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/streaming_profiles?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `name` | string | Yes | The identification name to assign to the new streaming profile. The name is case-insensitive and can contain alphanumeric characters; underscores (_) and hyphens (-). |
| `representations` | array | Yes | An array of structures that defines a custom streaming profile. |
| `transformation` | string | Yes | Specifies the transformation parameters for the representation. All video transformation parameters except video_sampling are supported. Common transformation parameters for representations include- width; height (or aspect_ratio); bit_rate; video_codec; audio_codec; sample_rate (or fps); etc. |
| `display_name` | string | No | A descriptive name for the profile. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/streaming_profiles?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"value","representations":"value","transformation":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#create_a_streaming_profile](https://cloudinary.com/documentation/admin_api#create_a_streaming_profile)
---
#### Update the specified existing streaming profile
**Method**: `PUT` | **LowCodeAPI Path**: `/v1_1/cloud_name/streaming_profiles/name`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/streaming_profiles/name?cloud_name={cloud_name}&name={name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `name` | string | The identification name to assign to the new streaming profile. The name is case-insensitive and can contain alphanumeric characters; underscores (_) and hyphens (-). |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `representations` | array | Yes | An array of structures that defines a custom streaming profile. |
| `transformation` | string | Yes | Specifies the transformation parameters for the representation. All video transformation parameters except video_sampling are supported. Common transformation parameters for representations include- width; height (or aspect_ratio); bit_rate; video_codec; audio_codec; sample_rate (or fps); etc. |
| `display_name` | string | No | A descriptive name for the profile. |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/streaming_profiles/name?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"representations":"value","transformation":"value","display_name":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#update_an_existing_streaming_profile](https://cloudinary.com/documentation/admin_api#update_an_existing_streaming_profile)
---
#### Deletes and reverts the specified streaming profiles
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/cloud_name/streaming_profiles/name`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/streaming_profiles/name?cloud_name={cloud_name}&name={name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `name` | string | The name of the streaming profile to delete or revert. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/streaming_profiles/name?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#delete_or_revert_the_specified_streaming_profile](https://cloudinary.com/documentation/admin_api#delete_or_revert_the_specified_streaming_profile)
---
### Category: Admin / Tags
#### List tags used for a specified resource_type
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/tags`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/tags?cloud_name={cloud_name}&...&api_token={api_token}
```
**Query Parameters**:
| `resource_type` | string | No | The type of asset. Relevant as a parameter only when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Note- use video for all video and audio assets; such as .mp3. Possible values- image (default); raw; video. |
| `prefix` | string | No | Find all tags that start with the specified prefix. |
| `max_results` | number | No | Maximum number of assets to return (up to 500). Default- 10. |
| `next_cursor` | string | No | When a request has more results to return than max_results; the next_cursor value is returned as part of the response. You can then specify this value as the next_cursor parameter of a following request. |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/tags?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#tags](https://cloudinary.com/documentation/admin_api#tags)
---
### Category: Admin / Transformations
#### List all transformations
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/transformations`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/transformations?cloud_name={cloud_name}&...&api_token={api_token}
```
**Query Parameters**:
| `max_results` | number | No | Maximum number of transformations to return (up to 500). Default- 10. |
| `next_cursor` | string | No | When a request has more results to return than max_results; the next_cursor value is returned as part of the response. You can then specify this value as the next_cursor parameter of a following request. |
| `named` | boolean | No | Whether to return only named (true) or unnamed (false) transformations. If this parameter is not included; both named and unnamed transformations will be returned. |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/transformations?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#get_transformations](https://cloudinary.com/documentation/admin_api#get_transformations)
---
#### List details of a single transformation specified by names or prameters
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/transformations/transformation`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/transformations/transformation?cloud_name={cloud_name}&transformation={transformation}&...&api_token={api_token}
```
**Query Parameters**:
| `max_results` | number | No | Maximum number of derived assets to return (up to 500). Default- 10. |
| `next_cursor` | string | No | When a request has more results to return than max_results; the next_cursor value is returned as part of the response. You can then specify this value as the next_cursor parameter of a following request. |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `transformation` | string | The name of the transformation or the transformation parameters.
Note If the derived assets do not have an extension; add "/" at the end of the transformation value- For example- f_webp;q_80;b_blue;w_200;h_200 becomes f_webp;q_80;b_blue;w_200;h_200/ |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/transformations/transformation?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#get_transformation_details](https://cloudinary.com/documentation/admin_api#get_transformation_details)
---
#### Create a new named transformation
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/transformations/name`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/transformations/name?cloud_name={cloud_name}&name={name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `name` | string | The name of the transformation. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `transformation` | string | Yes | The transformation parameters. |
| `allowed_for_strict` | boolean | No | Whether to allow this named transformation when strict transformations are enabled. Default- true. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/transformations/name?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"transformation":"value","allowed_for_strict":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#create_a_named_transformation](https://cloudinary.com/documentation/admin_api#create_a_named_transformation)
---
#### Update a specific transformation
**Method**: `PUT` | **LowCodeAPI Path**: `/v1_1/cloud_name/transformations/transformation`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/transformations/transformation?cloud_name={cloud_name}&transformation={transformation}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `transformation` | string | The name of the transformation or a listing of the transformation parameters. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `allowed_for_strict` | boolean | No | Whether to allow this named transformation when strict transformations are enabled. |
| `unsafe_update` | string | No | Required when modifying the transformation parameters of an existing named transformation. The new transformation definition for the named transformation.
Because the changed definition can be unsafe for (significantly change) assets in production; the change is applied only to newly generated derived assets that reference this named transformation.
To apply the change to existing derived assets using this named transformation; invalidate them so that they'll be regenerated with the new definition when next requested. |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/transformations/transformation?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"allowed_for_strict":"value","unsafe_update":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#update_transformation](https://cloudinary.com/documentation/admin_api#update_transformation)
---
#### Delete a specified transformation
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/cloud_name/transformations/transformation`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/transformations/transformation?cloud_name={cloud_name}&transformation={transformation}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `transformation` | string | The name of the transformation or the transformation parameters. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/transformations/transformation?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#delete_transformation](https://cloudinary.com/documentation/admin_api#delete_transformation)
---
### Category: Admin / Upload mappings
#### List all upload mappings by folder
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/upload_mappings`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_mappings?cloud_name={cloud_name}&...&api_token={api_token}
```
**Query Parameters**:
| `max_results` | number | No | Maximum number of assets to return (up to 500). Default- 10. |
| `next_cursor` | string | No | When a request has more results to return than max_results; the next_cursor value is returned as part of the response. You can then specify this value as the next_cursor parameter of a following request. |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_mappings?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#get_upload_mappings](https://cloudinary.com/documentation/admin_api#get_upload_mappings)
---
#### List the details of single upload mapping
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name//upload_mappings/folder`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name//upload_mappings/folder?cloud_name={cloud_name}&folder={folder}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `folder` | string | The name of the folder to map. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name//upload_mappings/folder?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#get_the_details_of_a_single_upload_mapping](https://cloudinary.com/documentation/admin_api#get_the_details_of_a_single_upload_mapping)
---
#### Create a new upload mapping folder and its template(URL)
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/upload_mappings`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_mappings?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `folder` | string | Yes | The name of the folder to map. |
| `template` | string | Yes | The URL prefix to be mapped to the folder; as part of options. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_mappings?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"folder":"value","template":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#create_an_upload_mapping](https://cloudinary.com/documentation/admin_api#create_an_upload_mapping)
---
#### Update an existing upload mapping folder with a new template (URL)
**Method**: `PUT` | **LowCodeAPI Path**: `/v1_1/cloud_name/upload_mappings`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_mappings?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `folder` | string | Yes | The name of the folder to map. |
| `template` | string | Yes | The URL prefix to be mapped to the folder; as part of options. |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_mappings?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"folder":"value","template":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#update_an_upload_mapping](https://cloudinary.com/documentation/admin_api#update_an_upload_mapping)
---
#### Delete an upload mapping by folder name
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/cloud_name/upload_mappings/folder`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_mappings/folder?cloud_name={cloud_name}&folder={folder}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `folder` | string | The name of the folder to map. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_mappings/folder?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#delete_an_upload_mapping](https://cloudinary.com/documentation/admin_api#delete_an_upload_mapping)
---
### Category: Admin / Upload presets
#### Lists the upload presets defined for your product environment
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/upload_presets`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_presets?cloud_name={cloud_name}&...&api_token={api_token}
```
**Query Parameters**:
| `max_results` | number | No | Maximum number of assets to return (up to 500). Default- 10. |
| `next_cursor` | string | No | When a request has more results to return than max_results; the next_cursor value is returned as part of the response. You can then specify this value as the next_cursor parameter of a following request. |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_presets?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#get_upload_presets](https://cloudinary.com/documentation/admin_api#get_upload_presets)
---
#### Lists the details of a single upload preset
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/upload_presets/name`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_presets/name?cloud_name={cloud_name}&name={name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `name` | string | The name of the upload preset. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_presets/name?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#get_the_details_of_a_single_upload_preset](https://cloudinary.com/documentation/admin_api#get_the_details_of_a_single_upload_preset)
---
#### Create a new upload preset
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/upload_presets`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_presets?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `name` | string | No | The name to assign to the new upload preset. If not specified; a random name is generated. If the name is of an existing preset; it will be overwritten. |
| `unsigned` | boolean | No | Whether this upload preset allows unsigned uploading to Cloudinary. Default- false. |
| `disallow_public_id` | boolean | No | Whether this upload preset disables assigning a public_id in the upload call. Default- false. |
| `live` | boolean | No | Whether to enable "live broadcast"; so that the upload preset can be used for live streaming.
Default- false |
| `use_asset_folder_as_public_id_prefix` | boolean | No | Relevant only for product environments using dynamic folders mode.
Whether to automatically apply the path specified in the asset_folder parameter (or the asset folder that's in focus when an asset is uploaded directly to a folder in the Cloudinary Console user interface) as a prefix to the specified or generated public_id value. This ensures that the public ID path will always match the initial asset folder.
This can help to retain the behavior that previously existed in fixed folder mode. However; keep in mind that even when this option is used during upload; an asset with a certain public ID path can later be moved to a completely different asset folder hierarchy without impacting the public ID. This option only ensures path matching for the initial upload.
Relevant only when public_id_prefix (or folder) has not been separately specified.
Default- false |
| `file` | file | No | The file to upload |
| `upload_preset` | string | No | Name of an upload preset that you defined for your Cloudinary product environment |
| `signature` | string | No | Used to authenticate the request and based on the parameters you use in the request |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_presets?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"value","unsigned":"value","disallow_public_id":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#create_an_upload_preset](https://cloudinary.com/documentation/admin_api#create_an_upload_preset)
---
#### Update an existing upload preset
**Method**: `PUT` | **LowCodeAPI Path**: `/v1_1/cloud_name/upload_presets/name`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_presets/name?cloud_name={cloud_name}&name={name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `name` | string | The name of the upload preset. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `unsigned` | boolean | No | Whether this upload preset allows unsigned uploading to Cloudinary. Default- false. |
| `disallow_public_id` | boolean | No | Whether this upload preset disables assigning a public_id in the upload call. Default- false. |
| `live` | boolean | No | Whether to enable "live broadcast"; so that the upload preset can be used for live streaming. |
| `file` | file | No | The file to upload |
| `upload_preset` | string | No | Name of an upload preset that you defined for your Cloudinary product environment |
| `signature` | string | No | Used to authenticate the request and based on the parameters you use in the request |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_presets/name?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"unsigned":"value","disallow_public_id":"value","live":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#update_an_upload_preset](https://cloudinary.com/documentation/admin_api#update_an_upload_preset)
---
#### Delete an existing upload preset
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/cloud_name/upload_presets/name`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_presets/name?cloud_name={cloud_name}&name={name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `name` | string | The name of the upload preset. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/upload_presets/name?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#delete_an_upload_preset](https://cloudinary.com/documentation/admin_api#delete_an_upload_preset)
---
### Category: Admin / Usages
#### Lists product environment usage details
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/usage`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/usage?cloud_name={cloud_name}&...&api_token={api_token}
```
**Query Parameters**:
| `date` | string | No | The date for the usage report. Must be within the last 3 months and specified in the format- yyyy-mm-dd. Default- the current date |
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/usage?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/admin_api#get_product_environment_usage_details](https://cloudinary.com/documentation/admin_api#get_product_environment_usage_details)
---
### Category: Media Optimizer / Cache invalidation
#### Invalidate all caches
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/invalidate`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/invalidate&api_token={api_token}
```
**Body Parameters**:
| `urls` | array | Yes | An array of up to 20 Media Optimizer URLs to invalidate. These URLs; and any derived media from the specified assets; are invalidated. Transformation parameters can be given in the URLs; but all derived assets are invalidated; regardless. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/invalidate?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"urls":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#invalidate_all_caches](https://cloudinary.com/documentation/media_optimizer_api#invalidate_all_caches)
---
### Category: Media Optimizer / Cache warmup
#### Warm up the cache
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cache_warm_up`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cache_warm_up&api_token={api_token}
```
**Body Parameters**:
| `url` | string | Yes | The Media Optimizer URL to cache. Any default (base) transformations specified in the relevant optimization profile are applied to the cached media. You can also specify other transformations; which are handled by your mapping function; as part of the URL. |
| `notification_url` | string | No | An HTTP or HTTPS URL to receive the response (a webhook) when the derived media is available on the cache. If not specified; the response is sent to the global Notification URL (if defined) in the Delivery Settings of your Cloudinary Console. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cache_warm_up?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"url":"value","notification_url":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#warm_up_the_cache](https://cloudinary.com/documentation/media_optimizer_api#warm_up_the_cache)
---
### Category: Media Optimizer / Domains
#### Get all domains
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/domains`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/domains&api_token={api_token}
```
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/domains&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#domains](https://cloudinary.com/documentation/media_optimizer_api#domains)
---
### Category: Media Optimizer / Mapping functions
#### Get all mapping functions
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/mapping_functions`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/mapping_functions&api_token={api_token}
```
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/mapping_functions&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#get_mapping_functions](https://cloudinary.com/documentation/media_optimizer_api#get_mapping_functions)
---
#### Get details of a mapping function
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/mapping_functions/id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/mapping_functions/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The ID of the mapping function. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/mapping_functions/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#get_mapping_function_details](https://cloudinary.com/documentation/media_optimizer_api#get_mapping_function_details)
---
#### Create a mapping function
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/mapping_functions`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/mapping_functions&api_token={api_token}
```
**Body Parameters**:
| `display_name` | string | Yes | The display name of the mapping function. |
| `code` | string | Yes | Custom code for the mapping function. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/mapping_functions?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"display_name":"value","code":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#create_a_mapping_function](https://cloudinary.com/documentation/media_optimizer_api#create_a_mapping_function)
---
#### Update a mapping function
**Method**: `PUT` | **LowCodeAPI Path**: `/v1_1/mapping_functions/id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/mapping_functions/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The ID of the mapping function. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `display_name` | string | No | The new display name of the mapping function. |
| `code` | string | No | The new custom code for the mapping function. |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/cloudinary/v1_1/mapping_functions/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"display_name":"value","code":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#update_a_mapping_function](https://cloudinary.com/documentation/media_optimizer_api#update_a_mapping_function)
---
#### Delete a mapping function
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/mapping_functions/id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/mapping_functions/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The ID of the mapping function to delete. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/mapping_functions/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#delete_a_mapping_function](https://cloudinary.com/documentation/media_optimizer_api#delete_a_mapping_function)
---
### Category: Media Optimizer / Media sources
#### Get all media sources
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/media_sources`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/media_sources&api_token={api_token}
```
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/media_sources&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#get_media_sources](https://cloudinary.com/documentation/media_optimizer_api#get_media_sources)
---
#### Get details of a media source
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/media_sources/id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/media_sources/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The ID of the media source. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/media_sources/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#get_media_source_details](https://cloudinary.com/documentation/media_optimizer_api#get_media_source_details)
---
#### Create a media source
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/media_sources`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/media_sources&api_token={api_token}
```
**Body Parameters**:
| `display_name` | string | Yes | The display name of the media source configuration. |
| `uri_type` | string | Yes | The type of media source.
Possible values- http; s3; gs; web; cloudinary |
| `config` | object | Yes | Configuration parameters required for the type of media source.
http- Not applicable.
s3 - see AWS S3 settings for details of each parameter-
s3_bucket_name
s3_bucket_folder
s3_access_key
s3_secret_key
s3_uri_template
gs - see Google storage settings for details of each parameter-
gs_bucket_name
gs_bucket_folder
gs_service_account_key
gs_uri_template
web - see Web address settings for details of each parameter-
web_uri_base
web_headers
web_uri_template
cloudinary - see Cloudinary settings for details of the parameter-
cld_cloud_name |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/media_sources?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"display_name":"value","uri_type":"value","config":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#create_a_media_source](https://cloudinary.com/documentation/media_optimizer_api#create_a_media_source)
---
#### Update a media source
**Method**: `PUT` | **LowCodeAPI Path**: `/v1_1/media_sources/id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/media_sources/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The ID of the media source configuration. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `display_name` | string | No | The new display name of the media source. |
| `uri_type` | string | No | The type of media source.
Possible values- http; s3; gs; web; cloudinary |
| `config` | object | No | Configuration parameters required for the type of media source.
http- Not applicable.
s3 - see AWS S3 settings for details of each parameter-
s3_bucket_name
s3_bucket_folder
s3_access_key
s3_secret_key
s3_uri_template
gs - see Google storage settings for details of each parameter-
gs_bucket_name
gs_bucket_folder
gs_service_account_key
gs_uri_template
web - see Web address settings for details of each parameter-
web_uri_base
web_headers
web_uri_template
cloudinary - see Cloudinary settings for details of the parameter-
cld_cloud_name |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/cloudinary/v1_1/media_sources/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"display_name":"value","uri_type":"value","config":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#update_a_media_source](https://cloudinary.com/documentation/media_optimizer_api#update_a_media_source)
---
#### Delete a media source
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/media_sources/id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/media_sources/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The ID of the media source to delete. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/media_sources/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#delete_a_media_source](https://cloudinary.com/documentation/media_optimizer_api#delete_a_media_source)
---
### Category: Media Optimizer / Optimization profiles
#### Get optimization profiles
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/delivery_profiles`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/delivery_profiles&api_token={api_token}
```
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/delivery_profiles&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#get_optimization_profiles](https://cloudinary.com/documentation/media_optimizer_api#get_optimization_profiles)
---
#### Get optimization profile details
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/delivery_profiles/id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/delivery_profiles/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The ID of the optimization profile. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/delivery_profiles/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#get_optimization_profile_details](https://cloudinary.com/documentation/media_optimizer_api#get_optimization_profile_details)
---
#### Create an optimization profile
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/delivery_profiles`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/delivery_profiles&api_token={api_token}
```
**Body Parameters**:
| `display_name` | string | Yes | The display name of the optimization profile. |
| `domain_id` | string | Yes | The ID of the domain name. |
| `mapping_function_id` | string | Yes | The ID of the mapping function. |
| `media_source_ids` | array | Yes | An array of media source IDs. |
| `path_prefix` | string | No | Part of the base URL that identifies media belonging to the optimization profile. |
| `default_transformation` | string | No | The name of the transformation to apply to all media in the profile. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/delivery_profiles?&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"display_name":"value","domain_id":"value","mapping_function_id":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#create_an_optimization_profile](https://cloudinary.com/documentation/media_optimizer_api#create_an_optimization_profile)
---
#### Update an optimization profile
**Method**: `PUT` | **LowCodeAPI Path**: `/v1_1/delivery_profiles/id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/delivery_profiles/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The ID of the optimization profile. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `display_name` | string | No | The new display name of the optimization profile. |
| `domain_id` | string | No | The ID of the domain name. |
| `mapping_function_id` | string | No | The ID of the mapping function. |
| `media_source_ids` | array | No | An array of media source IDs. |
| `path_prefix` | string | No | Part of the base URL that identifies media belonging to the optimization profile. |
| `default_transformation` | string | No | The name of the transformation to apply to all media in the profile. |
| `is_enabled` | boolean | No | The enabled status of the optimization profile. |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/cloudinary/v1_1/delivery_profiles/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"display_name":"value","domain_id":"value","mapping_function_id":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#update_an_optimization_profile](https://cloudinary.com/documentation/media_optimizer_api#update_an_optimization_profile)
---
#### Delete an optimization profile
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/delivery_profiles/id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/delivery_profiles/id?id={id}&api_token={api_token}
```
**Path Parameters**:
| `id` | string | The ID of the optimization profile to delete. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/delivery_profiles/id?id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#delete_an_optimization_profile](https://cloudinary.com/documentation/media_optimizer_api#delete_an_optimization_profile)
---
### Category: Media Optimizer / Ping
#### Ping Media Optimizer servers
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/ping`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/ping&api_token={api_token}
```
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/ping&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#ping](https://cloudinary.com/documentation/media_optimizer_api#ping)
---
### Category: Media Optimizer / Transformations
#### Get all transformations
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/transformations`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/transformations?...&api_token={api_token}
```
**Query Parameters**:
| `max_results` | number | No | Maximum number of transformations to return (up to 500). Default- 10. |
| `next_cursor` | string | No | When a request has more results to return than max_results; the next_cursor value is returned as part of the response. You can then specify this value as the next_cursor parameter of a following request. |
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/transformations?...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#get_transformations](https://cloudinary.com/documentation/media_optimizer_api#get_transformations)
---
#### Get details of a transformation
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/transformations/transformation_name`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/transformations/transformation_name?transformation_name={transformation_name}&api_token={api_token}
```
**Path Parameters**:
| `transformation_name` | string | The name of the transformation. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/transformations/transformation_name?transformation_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#get_transformation_details](https://cloudinary.com/documentation/media_optimizer_api#get_transformation_details)
---
#### Create a named transformation
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/transformations/transformation_name`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/transformations/transformation_name?transformation_name={transformation_name}&transformation={transformation}&api_token={api_token}
```
**Path Parameters**:
| `transformation_name` | string | The name of the transformation. |
| `transformation` | string | The transformation parameters. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/transformations/transformation_name?transformation_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#create_a_named_transformation](https://cloudinary.com/documentation/media_optimizer_api#create_a_named_transformation)
---
#### Update a transformation
**Method**: `PUT` | **LowCodeAPI Path**: `/v1_1/transformations/transformation_name`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/transformations/transformation_name?transformation_name={transformation_name}&api_token={api_token}
```
**Path Parameters**:
| `transformation_name` | string | The name of the transformation. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `transformation` | string | Yes | The new transformation parameters. |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/cloudinary/v1_1/transformations/transformation_name?transformation_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"transformation":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#update_a_transformation](https://cloudinary.com/documentation/media_optimizer_api#update_a_transformation)
---
#### Delete a transformation
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/transformations/transformation_name`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/transformations/transformation_name?transformation_name={transformation_name}&api_token={api_token}
```
**Path Parameters**:
| `transformation_name` | string | The name of the transformation or the transformation parameters. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/transformations/transformation_name?transformation_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#delete_a_transformation](https://cloudinary.com/documentation/media_optimizer_api#delete_a_transformation)
---
### Category: Media Optimizer / Usages
#### Get account usage details
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/usage`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/usage?...&api_token={api_token}
```
**Query Parameters**:
| `date` | string | No | The date for the usage report. Must be within the last three months and given in the format- dd-mm-yyyy. Default- the current date. |
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/usage?...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/media_optimizer_api#usage](https://cloudinary.com/documentation/media_optimizer_api#usage)
---
### Category: Provisioning / Product environments
#### Get product environments
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/sub_accounts/sub_account_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/sub_accounts/sub_account_id?account_id={account_id}&sub_account_id={sub_account_id}&...&api_token={api_token}
```
**Query Parameters**:
| `options` | object | No | See Configuration parameters. |
**Path Parameters**:
| `account_id` | string | The User account id. |
| `sub_account_id` | string | The ID of the product environment to get. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/sub_accounts/sub_account_id?account_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#get_product_environment](https://cloudinary.com/documentation/provisioning_api#get_product_environment)
---
#### Create product environment
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/sub_accounts`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/sub_accounts?account_id={account_id}&api_token={api_token}
```
**Path Parameters**:
| `account_id` | string | The User account id. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `name` | string | Yes | The display name as shown in the Cloudinary Console. |
| `cloud_name` | string | No | A case-insensitive string comprised of between 2-128 alphanumeric and hyphen characters; starting with a letter. Note that cloud names must be unique across all Cloudinary accounts. An error is returned if the requested name already exists. Default- a unique string automatically generated by Cloudinary. |
| `base_sub_account_id` | string | No | The ID of another product environment; from which to copy all of the following settings- Size limits; Timed limits; and Flags. The parameter is called base_account in some SDKs. |
| `custom_attributes` | object | No | Any custom attributes you want to associate with the product environment; as a map/hash of key/value pairs. |
| `options` | object | No | See Configuration parameters. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/sub_accounts?account_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"value","cloud_name":"value","base_sub_account_id":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#create_product_environment](https://cloudinary.com/documentation/provisioning_api#create_product_environment)
---
#### Update product environment
**Method**: `PUT` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/sub_accounts/sub_account_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/sub_accounts/sub_account_id?account_id={account_id}&sub_account_id={sub_account_id}&api_token={api_token}
```
**Path Parameters**:
| `account_id` | string | The User account id. |
| `sub_account_id` | string | The ID of the product environment to update. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `name` | string | No | The display name as shown in the Cloudinary Console. |
| `cloud_name` | string | No | A case-insensitive cloud name comprised of between 2-128 alphanumeric and hyphen characters; starting with a letter. Note that cloud names must be unique across all Cloudinary accounts. An error is returned if the requested name already exists. Note- Can only be changed for accounts with fewer than 1000 images. |
| `custom_attributes` | object | No | Any custom attributes you want to associate with the product environment; as a map/hash of key/value pairs. |
| `enabled` | boolean | No | Whether the product environment is enabled. Default- true |
| `options` | object | No | See Configuration parameters. |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/sub_accounts/sub_account_id?account_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"value","cloud_name":"value","custom_attributes":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#update_product_environment](https://cloudinary.com/documentation/provisioning_api#update_product_environment)
---
#### Delete product environment
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/sub_accounts/sub_account_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/sub_accounts/sub_account_id?account_id={account_id}&sub_account_id={sub_account_id}&...&api_token={api_token}
```
**Query Parameters**:
| `options` | object | No | See Configuration parameters. |
**Path Parameters**:
| `account_id` | string | The User account id. |
| `sub_account_id` | string | The ID of the product environment to delete. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/sub_accounts/sub_account_id?account_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#delete_product_environment](https://cloudinary.com/documentation/provisioning_api#delete_product_environment)
---
### Category: Provisioning / User group
#### Get user groups
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/user_groups`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/user_groups?account_id={account_id}&...&api_token={api_token}
```
**Query Parameters**:
| `options` | object | No | See Configuration parameters. |
**Path Parameters**:
| `account_id` | string | The User account id. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/user_groups?account_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#get_users](https://cloudinary.com/documentation/provisioning_api#get_users)
---
#### Get a user group
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/user_groups/group_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/user_groups/group_id?account_id={account_id}&group_id={group_id}&...&api_token={api_token}
```
**Query Parameters**:
| `options` | object | No | See Configuration parameters. |
**Path Parameters**:
| `account_id` | string | The User account id. |
| `group_id` | string | The ID of the user group to get. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/user_groups/group_id?account_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#get_user](https://cloudinary.com/documentation/provisioning_api#get_user)
---
#### Get the users in a user group
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/user_groups/group_id/users`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/user_groups/group_id/users?account_id={account_id}&group_id={group_id}&...&api_token={api_token}
```
**Query Parameters**:
| `options` | object | No | See Configuration parameters. |
**Path Parameters**:
| `account_id` | string | The User account id. |
| `group_id` | string | The ID of the user group. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/user_groups/group_id/users?account_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#get_user_group_users](https://cloudinary.com/documentation/provisioning_api#get_user_group_users)
---
#### Create a user group
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/user_groups`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/user_groups?account_id={account_id}&api_token={api_token}
```
**Path Parameters**:
| `account_id` | string | The User account id. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `name` | string | Yes | The name for the user group. |
| `options` | object | No | See Configuration parameters. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/user_groups?account_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"value","options":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#create_user_group](https://cloudinary.com/documentation/provisioning_api#create_user_group)
---
#### Add a user to a group
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/user_groups/group_id/users/user_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/user_groups/group_id/users/user_id?account_id={account_id}&group_id={group_id}&user_id={user_id}&api_token={api_token}
```
**Path Parameters**:
| `account_id` | string | The User account id. |
| `group_id` | string | The ID of the user group. |
| `user_id` | string | The ID of the user. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `options` | object | No | See Configuration parameters. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/user_groups/group_id/users/user_id?account_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"options":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#add_user_to_group](https://cloudinary.com/documentation/provisioning_api#add_user_to_group)
---
#### Update a user group
**Method**: `PUT` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/user_groups/group_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/user_groups/group_id?account_id={account_id}&group_id={group_id}&api_token={api_token}
```
**Path Parameters**:
| `account_id` | string | The User account id. |
| `group_id` | string | The ID of the user group to update. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `name` | string | Yes | The name for the user group. |
| `options` | object | No | See Configuration parameters. |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/user_groups/group_id?account_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"value","options":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#update_user_group](https://cloudinary.com/documentation/provisioning_api#update_user_group)
---
#### Delete a user group
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/user_groups/group_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/user_groups/group_id?account_id={account_id}&group_id={group_id}&...&api_token={api_token}
```
**Query Parameters**:
| `options` | object | No | See Configuration parameters. |
**Path Parameters**:
| `account_id` | string | The User account id. |
| `group_id` | string | The ID of the user group to delete. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/user_groups/group_id?account_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#delete_user_group](https://cloudinary.com/documentation/provisioning_api#delete_user_group)
---
#### Remove a user group
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/user_groups/group_id/users/user_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/user_groups/group_id/users/user_id?account_id={account_id}&group_id={group_id}&user_id={user_id}&...&api_token={api_token}
```
**Query Parameters**:
| `options` | object | No | See Configuration parameters. |
**Path Parameters**:
| `account_id` | string | The User account id. |
| `group_id` | string | The ID of the user group. |
| `user_id` | string | The ID of the user. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/user_groups/group_id/users/user_id?account_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#remove_user_from_group](https://cloudinary.com/documentation/provisioning_api#remove_user_from_group)
---
### Category: Provisioning / Users
#### Get users
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/users`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/users?account_id={account_id}&...&api_token={api_token}
```
**Query Parameters**:
| `pending` | boolean | No | Whether to only return pending users. Default- false (all users) |
| `ids` | array | No | A list (SDKs wrap as an array) of up to 100 user IDs. When provided; other parameters are ignored. |
| `prefix` | string | No | Returns users where the name begins with the specified case-insensitive string. |
| `sub_account_id` | string | No | Only returns users who have access to the specified account. |
| `options` | object | No | See Configuration parameters. |
**Path Parameters**:
| `account_id` | string | The User account id. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/users?account_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#get_users](https://cloudinary.com/documentation/provisioning_api#get_users)
---
#### Get user
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/users/user_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/users/user_id?account_id={account_id}&user_id={user_id}&...&api_token={api_token}
```
**Query Parameters**:
| `options` | object | No | See Configuration parameters. |
**Path Parameters**:
| `account_id` | string | The User account id. |
| `user_id` | string | The ID of the user to get. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/users/user_id?account_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#get_user](https://cloudinary.com/documentation/provisioning_api#get_user)
---
#### Create user
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/users`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/users?account_id={account_id}&api_token={api_token}
```
**Path Parameters**:
| `account_id` | string | The User account id. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `name` | string | Yes | The user's name. |
| `email` | string | Yes | A unique email address; which serves as the login name and notification address. |
| `role` | string | Yes | The role to assign. Possible values- master_admin; admin; billing; technical_admin; reports; media_library_admin; media_library_user |
| `sub_account_ids` | array | No | A comma-separated list (SDKs wrap as an array) of product environment IDs that this user can access. Note- This parameter is ignored if the role is specified as master_admin. Default- all product environments. |
| `enabled` | boolean | No | Whether the user is enabled. Default- true |
| `options` | object | No | See Configuration parameters. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/users?account_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"value","email":"value","role":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#create_user](https://cloudinary.com/documentation/provisioning_api#create_user)
---
#### Update user
**Method**: `PUT` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/sub_accounts/user_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/sub_accounts/user_id?account_id={account_id}&user_id={user_id}&api_token={api_token}
```
**Path Parameters**:
| `account_id` | string | The User account id. |
| `user_id` | string | The ID of the user to update. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `name` | string | No | The user's name. |
| `email` | string | No | A unique email address; which serves as the login name and notification address. |
| `role` | string | No | The role to assign. Possible values- master_admin; admin; billing; technical_admin; reports; media_library_admin; media_library_user |
| `sub_account_ids` | string | No | A comma-separated list (SDKs wrap as an array) of product environment IDs that this user can access. Note- This parameter is ignored if the role is specified as master_admin. |
| `enabled` | boolean | No | Whether the user is enabled. |
| `options` | object | No | See Configuration parameters. |
**Example Request**:
```bash
curl -X PUT "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/sub_accounts/user_id?account_id=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"value","email":"value","role":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#update_user](https://cloudinary.com/documentation/provisioning_api#update_user)
---
#### Delete user
**Method**: `DELETE` | **LowCodeAPI Path**: `/v1_1/accounts/account_id/users/user_id`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/users/user_id?account_id={account_id}&user_id={user_id}&...&api_token={api_token}
```
**Query Parameters**:
| `options` | object | No | See Configuration parameters. |
**Path Parameters**:
| `account_id` | string | The User account id. |
| `user_id` | string | The ID of the user to update. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X DELETE "https://api.lowcodeapi.com/cloudinary/v1_1/accounts/account_id/users/user_id?account_id=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/provisioning_api#delete_user](https://cloudinary.com/documentation/provisioning_api#delete_user)
---
### Category: Upload / Assets generation
#### Creates a collage from existing assets
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/image/create_collage`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/image/create_collage?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `manifest_json` | string | Yes | The collage specific manifest transformation as stringified JSON that specifies the assets to use as well as the dimensions and layout of the collage; color spacing and any image specific transformations. See the collage generation reference for full details on syntax. |
| `signature` | string | Yes | (Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests; the signature is automatically generated and added to the request. If you manually generate your own signed POST request; you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters. For more details; see manually generating signatures. |
| `upload_preset` | string | Yes | (Required for unsigned uploading / optional for signed uploading) Name of an upload preset that you defined for your Cloudinary product environment. An upload preset consists of upload parameters centrally managed using the Admin API or from the Upload page of your Console Settings. An upload preset may be marked as unsigned; which allows unsigned uploading directly from the browser and restricts the optional parameters to- public_id; folder; tags; context; face_coordinates and custom_coordinates. |
| `public_id` | string | No | The identifier that is used for accessing the image collage. The Public ID may contain a full path including folders separated by a slash (/).
If not specified; then the Public ID of the collage will be comprised of random characters.
Note- The Public ID value for collages should not include a file extension. |
| `transformation` | string | No | A transformation to apply to the collage after it has been generated. This parameter is given as a comma-separated list of transformations; and separated with a slash for chained transformations. |
| `overwrite` | boolean | No | Whether to overwrite existing assets with the same Public ID. When set to false; a response is returned immediately if an asset with the same Public ID was found.
When overwriting assets; if you include versions in your delivery URLs; you will need to update the URLs with the new version number to deliver the new asset. If you don't include versions; you will need to invalidate the old assets on the CDN server cache.
Default- true (when using unsigned upload; the default is false and cannot be changed to true).
Important- Depending on your product environment setup; overwriting an asset may clear the tags; contextual; and structured metadata values for that asset. If you have a Master admin role; you can change this behavior for your product environment in the Media Library Preferences pane; so that these field values are retained when new version assets overwrite older ones (unless you specify different values for the tags; context; or metadata parameters as part of your upload). |
| `tags` | string | No | A comma-separated list of tag names to assign to the collage for later group reference. For example- animal;dog. |
| `notification_url` | string | No | An HTTP or HTTPS URL to notify your application (a webhook) when the process has completed. If not specified; the response is sent to the global Notification URL (if defined) in the Upload settings of your Cloudinary Console. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/image/create_collage?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"manifest_json":"value","signature":"value","upload_preset":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/image_upload_api_reference#create_collage](https://cloudinary.com/documentation/image_upload_api_reference#create_collage)
---
#### Creates a slideshow from existing assets
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/resource_type/create_slideshow`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/create_slideshow?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/create_slideshow?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/image_upload_api_reference#create_slideshow](https://cloudinary.com/documentation/image_upload_api_reference#create_slideshow)
---
#### Creates a video from existing assets
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/video/create_video`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/video/create_video?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `manifest_json` | string | Yes | The video specific manifest transformation as stringified JSON that specifies the assets to use as well as tracks; clips; keyframes; durations; transitions and effects. See the video generation reference for full details on syntax. |
| `signature` | string | Yes | (Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests; the signature is automatically generated and added to the request. If you manually generate your own signed POST request; you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters. For more details; see manually generating signatures. |
| `upload_preset` | string | Yes | (Required for unsigned uploading / optional for signed uploading) Name of an upload preset that you defined for your Cloudinary product environment. An upload preset consists of upload parameters centrally managed using the Admin API or from the Upload page of your Console Settings. An upload preset may be marked as unsigned; which allows unsigned uploading directly from the browser and restricts the optional parameters to- public_id; folder; tags; context; face_coordinates and custom_coordinates. |
| `public_id` | string | No | The identifier that is used for accessing or delivering the video. The Public ID may contain a full path including folders separated by a slash (/).
If not specified; then the Public ID of the video will be comprised of random characters.
Note- The Public ID value for videos should not include a file extension. |
| `transformation` | string | No | A transformation to apply to the video after it has been generated. This parameter is given as a comma-separated list of transformations; and separated with a slash for chained transformations.
overwrite |
| `is returned immediately if an asset with the same Public ID was found.
When overwriting assets; if you include versions in your delivery URLs; you will need to update the URLs with the new version number to deliver the new asset. If you don't include versions; you will need to invalidate the old assets on the CDN server cache.
Default- true (when using unsigned upload; the default is false and cannot be changed to true).
Important- Depending on your product environment setup; overwriting an asset may clear the tags; contextual; and structured metadata values for that asset. If you have a Master admin role; you can change this behavior for your product environment in the Media Library Preferences pane; so that these field values are retained when new version assets overwrite older ones (unless you specify different values for the tags; context; or metadata parameters as part of your upload).` | string | No | |
| `tags` | string | No | A comma-separated list of tag names to assign to the video for later group reference. For example- animal;dog. |
| `notification_url` | string | No | An HTTP or HTTPS URL to notify your application (a webhook) when the process has completed. If not specified; the response is sent to the global Notification URL (if defined) in the Upload page of your Console Settings. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/video/create_video?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"manifest_json":"value","signature":"value","upload_preset":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/image_upload_api_reference#create_video](https://cloudinary.com/documentation/image_upload_api_reference#create_video)
---
#### Derives images for the individual pages in a muli-page file
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/image/explode`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/image/explode?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `public_id` | string | Yes | The identifier of the uploaded multi-page file (PDF or animated GIF).
Note- The public ID for images does not include a file extension. |
| `transformation` | string | Yes | A transformation to run on all the pages before storing them as derived images. This parameter is given as a comma-separated list of transformations; and separated with a slash for chained transformations.
At minimum; you must pass the page transformation with the value all. If you supply additional transformations; you must deliver the image using the same relative order of the page and the other transformations. If you use a different order when you deliver; then it is considered a different transformation; and will be generated on the fly as a new derived image.SDKs- Supports a hash of transformation parameters (or an array of hashes for chained transformations).
Note- When using the SDK for a dynamically-typed language; the transformation parameters can be specified directly without using this transformation parameter; as seen in the examples for Ruby; PHP; Python; and Node.js below. |
| `signature` | string | Yes | (Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests; the signature is automatically generated and added to the request. If you manually generate your own signed POST request; you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters. For more details; see manually generating signatures. |
| `type` | string | No | The specific file type of the asset. Valid values- upload; private and authenticated. Default- upload. |
| `format` | string | No | An optional format to convert the images before storing them in your Cloudinary product environment. Default- png. |
| `notification_url` | string | No | An HTTP or HTTPS URL to notify your application (a webhook) when the process has completed. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/image/explode?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"public_id":"value","transformation":"value","signature":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/image_upload_api_reference#explode](https://cloudinary.com/documentation/image_upload_api_reference#explode)
---
#### Creates a archive file from existing assets
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/resource_type/generate_archive`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/generate_archive?cloud_name={cloud_name}&resource_type={resource_type}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of assets to include. Only relevant as a parameter when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Valid values- image; raw; video; all. Default- image.
Notes-
Use the video resource type to request video assets as well as for audio files; such as .mp3.
When using the download_folders SDK method; the default is all. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `tags` | string | Yes | A comma-separated list of tag names. All assets with the specified tags are included in the archive. Up to 20 tags are supported. For example- animal;dogSDKs- Supports arrays. For example- ['animal'; 'dog'] |
| `public_ids` | string | Yes | A comma-separated list of public IDs for the specific assets to be included in the archive. Up to 1000 public IDs are supported. SDKs- Supports arrays. |
| `prefixes` | string | Yes | A comma-separated list of prefixes of public IDs (e.g.; folders). Setting this parameter to a slash (/) is a shortcut for including all assets in the product environment for the given resource_type and type (up to the max files limit). Up to 20 prefixes are supported.SDKs- Supports arrays. |
| `signature` | string | Yes | (Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests; the signature is automatically generated and added to the request. If you manually generate your own signed POST request; you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters. For more details; see manually generating signatures. |
| `type` | string | No | The specific file type of assets to include in the archive (upload/private/authenticated). If tags are specified as a filter then all types are included. Default- upload. |
| `transformations` | string | No | A transformation to run on all the derived assets before storing them in your Cloudinary product environment. This parameter is given as a comma-separated list of transformations; and separated with a slash for chained transformations. If this parameter is not specified then the original assets are included in the archive. If you are including multiple asset types in your archive; make sure the transformations you specify are supported for all assets that will be included in the archive.SDKs- Supports a hash of transformation parameters (or an array of hashes for chained transformations).
Note- When using the SDK for a dynamically-typed language; the transformation parameters can be specified directly without using the transformation parameter. |
| `mode` | string | No | (Only relevant when using the REST API - not for use with SDKs) Determines how to generate and deliver the archive-
download - generates and delivers the archive file without storing it in your product environment.
create - creates and stores it as a raw asset in your Cloudinary product environment (does not deliver the archive file itself; but returns a JSON response with the URLs for accessing the archive file).
create_and_download - creates; stores AND delivers the archive file.
Default- create. |
| `target_format` | string | No | (Only relevant when using the REST API or the 'archive' SDK methods - not for use with the 'zip' SDK methods)The format for the generated archive- zip or tgz. Default- zip. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/generate_archive?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"tags":"value","public_ids":"value","prefixes":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/image_upload_api_reference#generate_archive](https://cloudinary.com/documentation/image_upload_api_reference#generate_archive)
---
#### Generates animated images, videos, or PDFs from existing images
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/image/multi`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/image/multi?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `tag` | string | Yes | (Required if not using urls) The animated GIF or PDF is created from all images with this tag. |
| `signature` | string | Yes | (Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests; the signature is automatically generated and added to the request. If you manually generate your own signed POST request; you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters. For more details; see manually generating signatures. |
| `urls` | array | No | (Required if not using tag) The animated GIF or PDF is created from all image URLs in the array. |
| `transformation` | string | No | A transformation to run on all the derived assets before creating the animated image or PDF. This parameter is given as a comma-separated list of transformations; and separated with a slash for chained transformations. SDKs- Supports a hash of transformation parameters (or an array of hashes for chained transformations).
Note- When using the SDK for a dynamically-typed language; the transformation parameters can be specified directly without using the transformation parameter. |
| `async` | boolean | No | Tells Cloudinary whether to perform the animated image or PDF generation in the background (asynchronously). Default- false. |
| `format` | string | No | The file format of the result. Valid values- gif; png; webp; mp4; webm and pdf. Default- gif |
| `delay` | number | No | The delay in milliseconds between frames. Valid for animated images and video formats. |
| `notification_url` | string | No | An HTTP or HTTPS URL to notify your application (a webhook) when the process has completed. If not specified; the response is sent to the global Notification URL (if defined) in the Upload page of your Console Settings. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/image/multi?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"tag":"value","signature":"value","urls":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/image_upload_api_reference#multi](https://cloudinary.com/documentation/image_upload_api_reference#multi)
---
#### Creates a sprite from existing assets
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/image/sprite`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/image/sprite?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `tag` | string | Yes | (Required if not using urls) The sprite is created from all images with this tag. |
| `urls` | array | Yes | (Required if not using tag) The sprite is created from all image URLs in the array. |
| `signature` | string | Yes | (Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests; the signature is automatically generated and added to the request. If you manually generate your own signed POST request; you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters. For more details; see manually generating signatures. |
| `transformation` | string | No | A transformation to run on all the derived assets before creating the sprite. This parameter is given as a comma-separated list of transformations; and separated with a slash for chained transformations. SDKs- Supports a hash of transformation parameters (or an array of hashes for chained transformations).
Note- When using the SDK for a dynamically-typed language; the transformation parameters can be specified directly without using the transformation parameter. |
| `format` | string | No | An optional format to convert the sprite before saving it in your Cloudinary product environment. Default- png. |
| `async` | boolean | No | Tells Cloudinary whether to perform the sprite generation in the background (asynchronously). Default- false. |
| `notification_url` | string | No | An HTTP or HTTPS URL to notify your application (a webhook) when the process has completed. If not specified; the response is sent to the global Notification URL (if defined) in the Upload page of your Console Settings. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/image/sprite?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"tag":"value","urls":"value","signature":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/image_upload_api_reference#sprite](https://cloudinary.com/documentation/image_upload_api_reference#sprite)
---
#### Dynamically generates an image from a given textual string
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/image/text`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/image/text?cloud_name={cloud_name}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `text` | string | Yes | The text string to generate an image for. |
| `signature` | string | Yes | (Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests; the signature is automatically generated and added to the request. If you manually generate your own signed POST request; you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters. For more details; see manually generating signatures. |
| `public_id` | string | No | The identifier that is used for accessing the generated image. If not specified; a unique identifier is generated by Cloudinary.
Note- The public ID value for images and videos should not include a file extension. Include the file extension for raw files only. |
| `font_family` | string | No | The name of the font family. |
| `font_size` | number | No | Font size in points. Default- 12. |
| `font_color` | string | No | Name or RGB representation of the font's color. For example- red or #ff0000. Default- black. |
| `font_weight` | string | No | Whether to use a normal or a bold font. Default- normal. |
| `font_style` | string | No | Whether to use a normal or an italic font. Default- normal. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/image/text?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"text":"value","signature":"value","public_id":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/image_upload_api_reference#text](https://cloudinary.com/documentation/image_upload_api_reference#text)
---
### Category: Upload / Assets management
#### Uploads an assets to a Cloudinary product enviroment
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/resource_type/upload`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/upload?cloud_name={cloud_name}&resource_type={resource_type}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | Set the type of file you are uploading or use auto to automatically detect the file type. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `file` | file | Yes | The file to upload. It can be |
| `upload_preset` | string | Yes | (Required for unsigned uploading / optional for signed uploading) Name of an upload preset that you defined for your Cloudinary product environment. An upload preset consists of upload parameters centrally managed using the Admin API or from the Upload page of the Console Settings. An upload preset may be marked as unsigned; which allows unsigned uploading directly from the browser and restricts the optional parameters to |
| `signature` | string | Yes | (Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests; the signature is automatically generated and added to the request. If you manually generate your own signed POST request; you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters. For more details; see manually generating signatures. |
| `public_id` | string | No | The identifier that's used for accessing and delivering the uploaded asset.
If not specified; then the Public ID of the asset will either be comprised of random characters or will use the original file's filename; depending whether use_filename was set to true.
Notes-
The Public ID value for images and videos should not include a file extension. Include the file extension for raw files only.
Can be up to 255 characters; including non-English characters; periods (.); forward slashes (/); underscores (_); hyphens (-).
Public ID values cannot begin or end with a space or forward slash (/). Additionally; they cannot include the following characters- ? & # \ % < > + |
| `public_id_prefix` | string | No | Relevant only for product environments using dynamic folder mode.
A string or path that's automatically prepended to the public_id with a forward slash. The value can contain the same characters as the public_id including additional forward slashes. This prefix can be useful to provide context and improve the SEO of an asset's filename in the delivery URL; but the value does not impact the location where the asset is stored in the Media Library. |
| `display_name` | string | No | Relevant only for product environments using dynamic folder mode.
A user-friendly name for the asset.
Default- Same value as the public_id (or the last segment of the public ID if the public ID includes slashes).
Display names can have spaces and special characters; but can't include forward slashes (/). This name can be completely different than the asset's public id and its value doesn't impact the delivery URL in any way.
The display name is shown in user interface pages such as the Console Media Library; Cloudinary collections; and Cloudinary media portals.
Though not a best practice; it's possible for the same display name to be used for different assets; even in the same asset folder. |
| `asset_folder` | string | No | Relevant only for product environments using dynamic folder mode.
The folder where the asset is placed within the Cloudinary repository. This value does not impact the asset’s public ID path (unless the use_asset_folder_as_public_id_prefix option is applied).
Default- If not specified; the uploaded asset will be located in the root of your product environment asset repository; even if the public ID value includes slashes. |
| `folder` | string | No | Defines both the full path of the folder where the uploaded asset will be placed and also a path value that's prepended to public_id value with a forward slash.
Default- root folder.
Note- If Dynamic folders mode is enabled on your product environment; it's recommended to use the asset_folder parameter instead of folder to control where the asset will be placed. If you also want your public_id to include slashes and/or match the initial asset folder path; set the full path directly in the public_id value; set the path part of the public ID using the public_id_prefix parameter; or use an upload preset that has the use_asset_folder_as_public_id_prefix option applied. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/upload?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"file":"value","upload_preset":"value","signature":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/image_upload_api_reference#signed_upload_syntax](https://cloudinary.com/documentation/image_upload_api_reference#signed_upload_syntax)
---
#### Applies actions to alerady uploaded assets
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/resource_type/explicit`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/explicit?cloud_name={cloud_name}&resource_type={resource_type}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of asset. Only relevant as a parameter when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Valid values- image; raw; and video. Default- image.
Note- Use the video resource type for all video assets as well as for audio files; such as .mp3. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `public_id` | string | Yes | The identifier of the uploaded asset or the URL of the remote asset.
Note- The public ID value for images and videos should not include a file extension. Include the file extension for raw files only. |
| `type` | string | Yes | The delivery type of the asset. For a list of all possible delivery types; see Delivery types. |
| `signature` | string | Yes | (Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests; the signature is automatically generated and added to the request. If you manually generate your own signed POST request; you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters. For more details; see manually generating signatures. |
| `display_name` | string | No | Relevant only for product environments using dynamic folder mode.
A user-friendly name for the asset.
Display names can have spaces and special characters; but can't include forward slashes (/). This name can be completely different than the asset's public id and its value doesn't impact the delivery URL in any way.
The display name is shown in user interface pages such as the Console Media Library; Cloudinary collections; and Cloudinary media portals.
Though not a best practice; it's possible for the same display name to be used for different assets; even in the same asset folder. |
| `asset_folder` | string | No | Relevant only for product environments using dynamic folder mode.
The folder where the asset is placed within the Cloudinary repository.
Setting this value in an explicit method moves the asset to the specified asset folder; but does not impact the asset’s public ID path. |
| `eager` | string | No | A list of transformations to create for the uploaded asset; instead of lazily creating them when first accessed by your site's visitors (see the Transformation URL API Reference for more details on possible values). This option accepts either a single transformation or a pipe-separated list of transformations to create for the uploaded asset.
SDKs- Supports arrays. (In .NET SDK; parameter name is EagerTransforms.)
async |
| `eager_notification_url` | string | No | An HTTP or HTTPS URL to notify your application (a webhook) when the generation of eager transformations is completed. |
| `overwrite` | boolean | No | When applying eager for already existing video transformations; this setting indicates whether to force the existing derived video resources to be regenerated. Default for videos- false.
Note- When specifying existing eager transformations for images; corresponding derived images are always regenerated. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/explicit?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"public_id":"value","type":"value","signature":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/image_upload_api_reference#explicit](https://cloudinary.com/documentation/image_upload_api_reference#explicit)
---
#### Rename an assets
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/resource_type/rename`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/rename?cloud_name={cloud_name}&resource_type={resource_type}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of asset to rename. Only relevant as a parameter when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Valid values- image; raw; video. Default- image.
Note- Use the video resource type for all video assets as well as for audio files; such as .mp3. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `from_public_id` | string | Yes | The current identifier of the uploaded asset. |
| `to_public_id` | string | Yes | The new identifier to assign to the uploaded asset. |
| `signature` | string | Yes | (Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests; the signature is automatically generated and added to the request. If you manually generate your own signed POST request; you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters. For more details; see manually generating signatures. |
| `type` | string | No | The delivery type of the asset. Only relevant as a parameter when using the SDKs (the delivery type is included in the endpoint URL when using the REST API). Valid values- upload; private; authenticated. Default- upload. |
| `to_type` | string | No | The new delivery type for the asset. Valid values- upload; private; authenticated. Default- the asset's current type is unchanged. |
| `overwrite` | boolean | No | Whether to overwrite an existing asset with the target public ID. Default- false.
Important- Depending on your product environment setup; overwriting an asset may clear the tags; contextual; and structured metadata values for that asset. If you have a Master admin role; you can change this behavior for your product environment in the Media Library Preferences pane; so that these field values are retained when new version assets overwrite older ones (unless you specify different values for the tags; context; or metadata parameters as part of your upload). |
| `invalidate` | boolean | No | Whether to invalidate CDN cached copies of the asset (and all its transformed versions). Default- false.
It usually takes between a few seconds and a few minutes for the invalidation to fully propagate through the CDN. There are also a number of other important considerations when using the invalidate functionality |
| `context` | boolean | No | Whether to include contextual metadata for the asset in the response. Default- false. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/rename?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"from_public_id":"value","to_public_id":"value","signature":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/image_upload_api_reference#rename](https://cloudinary.com/documentation/image_upload_api_reference#rename)
---
#### Destroy an assets
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/resource_type/destroy`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/destroy?cloud_name={cloud_name}&resource_type={resource_type}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of asset to destroy. Only relevant as a parameter when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Valid values- image; raw; and video. Default- image.
Note- Use the video resource type for all video assets as well as for audio files; such as .mp3. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `public_id` | string | Yes | The identifier of the uploaded asset.
Note- The public ID value for images and videos should not include a file extension. Include the file extension for raw files only. |
| `signature` | string | Yes | (Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests; the signature is automatically generated and added to the request. If you manually generate your own signed POST request; you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters. For more details; see manually generating signatures. |
| `type` | string | No | The delivery type of the asset. Only relevant as a parameter when using the SDKs (the type is included in the endpoint URL when using the REST API). Default- upload. For a list of all possible delivery types; see Delivery types. |
| `invalidate` | boolean | No | If true; invalidates CDN cached copies of the asset (and all its transformed versions). Default- false.
It usually takes between a few seconds and a few minutes for the invalidation to fully propagate through the CDN. There are also a number of other important considerations when using the invalidate functionality. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/destroy?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"public_id":"value","signature":"value","type":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/image_upload_api_reference#destroy](https://cloudinary.com/documentation/image_upload_api_reference#destroy)
---
#### Gets a specific version of a backed-up assets
**Method**: `GET` | **LowCodeAPI Path**: `/v1_1/cloud_name/download_backup`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/download_backup?cloud_name={cloud_name}&...&api_token={api_token}
```
**Query Parameters**:
| `asset_id` | string | Yes | The identifier of the uploaded asset.
Note- This is returned in the response to various Admin API methods. |
| `version_id` | string | Yes | The identifier of a backed up version of the asset.
Note- To see details of backed up versions; including version_id; for a specific asset; use the resource method of the Admin API; setting the versions parameter to true. |
**Path Parameters**:
| `cloud_name` | string | Cloud Name. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Example Request**:
```bash
curl -X GET "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/download_backup?cloud_name=VALUE&...&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json"
```
**Official Documentation**: [https://cloudinary.com/documentation/image_upload_api_reference#download_backup](https://cloudinary.com/documentation/image_upload_api_reference#download_backup)
---
### Category: Upload / Metadata management
#### Remove Context
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/resource_type/context`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/context?cloud_name={cloud_name}&resource_type={resource_type}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of asset. Only relevant as a parameter when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Valid values- image; raw; and video. Default- image.
Note- Use the video resource type for all video assets as well as for audio files; such as .mp3. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `context` | string | Yes | (Only relevant when adding contextual metadata) A pipe-separated list of the key-value pairs of contextual metadata to attach to an uploaded asset. The contextual metadata values of uploaded files can be retrieved using the Admin API. For example- alt=My image❘caption=Profile imageNotes-
The = and ❘ characters can be supported as values when escaped with a prepended backslash (\).
Key values are limited to 1024 characters and an asset can have a maximum of 1000 contextual metadata key-value pairs.
SDKs- Supports maps. For example- ['alt'- 'My image'; 'caption'- 'Profile image'] |
| `public_ids` | array | Yes | An array of Public IDs of assets uploaded to Cloudinary. |
| `command` | string | Yes | (Only relevant when using the REST API - not for use with SDKs) The action to perform on assets- either add the specified contextual metadata; or remove_all the contextual metadata key-value pairs assigned. |
| `signature` | string | Yes | (Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests; the signature is automatically generated and added to the request. If you manually generate your own signed POST request; you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters. For more details; see manually generating signatures. |
| `type` | string | No | The delivery type of the asset. Only relevant as a parameter when using the SDKs (the delivery type is included in the endpoint URL when using the REST API). Default- upload. For a list of possible delivery types; see Delivery types. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/context?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"context":"value","public_ids":"value","command":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/image_upload_api_reference#removing_all_context_syntax](https://cloudinary.com/documentation/image_upload_api_reference#removing_all_context_syntax)
---
#### Adds values to metadata fields
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/resource_type/metadata`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/metadata?cloud_name={cloud_name}&resource_type={resource_type}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of asset. Only relevant as a parameter when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Valid values- image; raw; and video. Default- image.
Note- Use the video resource type for all video assets as well as for audio files; such as .mp3. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `metadata` | string | Yes | A pipe-separated list of custom metadata fields (by external_id) and the values to assign to each of them. For example- in_stock_id=50❘color_id=[\"green\";\"red\"].
SDKs- Supports maps.
Notes-
The =; " and ❘ characters can be supported as values when escaped with a prepended backslash (\).
For a multi-select field; you can set a maximum of 3000 different metadata values on an asset. |
| `public_ids` | array | Yes | An array of Public IDs of assets uploaded to Cloudinary. |
| `signature` | string | Yes | (Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests; the signature is automatically generated and added to the request. If you manually generate your own signed POST request; you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters. For more details; see manually generating signatures. |
| `type` | string | No | The delivery type. Valid values- upload; private and authenticated. Default- upload |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/metadata?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"metadata":"value","public_ids":"value","signature":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/image_upload_api_reference#metadata](https://cloudinary.com/documentation/image_upload_api_reference#metadata)
---
#### Manages the tags applied to your assets
**Method**: `POST` | **LowCodeAPI Path**: `/v1_1/cloud_name/resource_type/tags`
**Full URL**:
```
https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/tags?cloud_name={cloud_name}&resource_type={resource_type}&api_token={api_token}
```
**Path Parameters**:
| `cloud_name` | string | Cloud Name |
| `resource_type` | string | The type of asset. Only relevant as a parameter when using the SDKs (the resource_type is included in the endpoint URL when using the REST API). Valid values- image; raw; and video. Default- image.
Note- Use the video resource type for all video assets as well as for audio files; such as .mp3. |
**Note**: Path parameters are passed in the URL path. The LowCodeAPI path uses static parameter names, and the actual values are passed as query parameters with the same names.
**Body Parameters**:
| `tag` | string | Yes | The tag(s) to assign; remove; or replace. Not relevant when removing all tags. You can pass multiple tags as a single comma-separated list of tag names to assign. For example- animal;dog
SDKs- Supports arrays. For example- ['animal'; 'dog'] |
| `public_ids` | string | Yes | A list of public IDs for the assets you want to update. |
| `command` | string | Yes | (Only relevant when using the REST API or the .NET SDK - not for use with other SDKs) The action to perform on the assets- either add the given tag; remove the given tag; remove_all the tags assigned; or replace the given tag; which adds the given tag while removing all other tags assigned. |
| `signature` | string | Yes | (Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests; the signature is automatically generated and added to the request. If you manually generate your own signed POST request; you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters. For more details; see manually generating signatures.
Note This method supports a maximum of 1000 total operations (public_ids * tags <= 1000). |
| `type` | string | No | The delivery type of the asset. Only relevant as a parameter when using the SDKs (the delivery type is included in the endpoint URL when using the REST API). Default- upload. For a list of possible delivery types; see Delivery types. |
**Example Request**:
```bash
curl -X POST "https://api.lowcodeapi.com/cloudinary/v1_1/cloud_name/resource_type/tags?cloud_name=VALUE&&api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"tag":"value","public_ids":"value","command":"value"}'
```
**Official Documentation**: [https://cloudinary.com/documentation/image_upload_api_reference#tags](https://cloudinary.com/documentation/image_upload_api_reference#tags)
---
## Usage Examples
### Example 1: Basic Usage
Get started with Cloudinary API by making your first request.
```bash
# Your example code here
# This demonstrates basic usage
curl -X GET "https://api.lowcodeapi.com/cloudinary/?api_token=YOUR_API_TOKEN"
```
### Example 2: Advanced Usage
Explore more advanced features and parameters.
```bash
# Your example code here
# This demonstrates advanced usage
curl -X GET "https://api.lowcodeapi.com/cloudinary/?api_token=YOUR_API_TOKEN"
```
## Complete Endpoint Reference
For a complete list of all endpoints and their parameters, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/cloudinary/definition`
- **Official Provider Documentation**: [https://cloudinary.com/documentation/admin_api](https://cloudinary.com/documentation/admin_api)
## Rate Limits & Best Practices
- Check your Cloudinary account for specific rate limits
- Use appropriate error handling and retry logic
- Cache responses when appropriate to reduce API calls
## Error Handling
Standard HTTP status codes apply:
- `400` - Invalid request parameters
- `401` - Unauthorized (check your API key)
- `429` - Rate limit exceeded
- `500` - Internal server error