> ## Documentation Index
> This page is part of the Image and Video APIs product. Fetch the complete documentation index for Image and Video APIs at: https://cloudinary.com/documentation/llms-image-and-video-apis.txt?referrer=docpage and then use it to discover all relevant pages before exploring further.
> If your task extends beyond this product, fetch the top-level index covering all Cloudinary products and topics at: https://cloudinary.com/documentation/llms.txt?referrer=docpage

# Admin API reference


[search_response_link]: #search_for_resources_sample_response

The Admin API is a **rate-limited** RESTful API that provides full control of all media assets (resources), upload presets, named transformations and other product environment entities.  
[Cloudinary's backend SDKs](backend_sdks) wrap these REST APIs, handle authentication, and enable you to perform these methods using your preferred programming language or framework. This reference provides both SDK and REST/cURL syntax and examples for each endpoint method.
> **See also**:
>
> For more on managing and analyzing your assets, refer to the [Manage and analyze](asset_management) guide.

> **TIP**:
>
> :title=Tips

> * You can open the Media Library to confirm that changes from your Admin API request, such as creating a new folder, applying tags, adding metadata, or setting moderation status, appear as expected. For more information, see the [Media Library for Developers](media_library_for_developers) page.  

> * Using [MediaFlows](https://console.cloudinary.com/mediaflows), Cloudinary’s drag-and-drop workflow builder for image and video, enables users to easily call admin API methods – including getting tags, contextual metadata, and usage data – in a low-code implementation. See MediaFlow’s documentation on admin API methods [here](mediaflows_block_reference#cloudinary_apis).

> * You can also browse and search assets directly from your IDE using the [Cloudinary VS Code Extension](cloudinary_vscode_extension). This eliminates context-switching between your code editor and browser, helping you stay focused on development.


## Endpoint index

Use this index to find Admin API endpoints. Each page includes the method syntax, parameters, and examples for that group of endpoints.

- **[Overview](admin_api_overview.md)**: Base URL format, Basic Authentication with your API key and secret, usage limits and how requests are counted, pagination, error handling, and EU/AP data center endpoints.
- **[config](admin_api_config.md)**: Enables you to get the details on your product environment configuration and current settings including information on the `folder_mode` (dynamic or fixed).
- **[folders](admin_api_folders.md)**: Enables you to manage your product environment's asset folders.
- **[folder_operations](admin_api_folder_operations.md)**: Enables you to grant or remove roles for a specific folder to a principal (user, group, or API key).
- **[metadata_fields](admin_api_metadata_fields.md)**: Enables you to manage the metadata fields available for your product environment.
- **[metadata_rules](admin_api_metadata_rules.md)**: Enables you to set up dependencies and hierarchical relationships between structured metadata fields and field options.
- **[people](admin_api_people.md)**: Enables you to retrieve and manage people-related data detected through Cloudinary's [People Search](dam_people_search) facial recognition feature.
- **[ping](admin_api_ping.md)**: Enables you to test the reachability of the Cloudinary API with the **ping** method.
- **[resources](admin_api_resources.md)**: Enables you to manage all the resources (assets) stored in your product environment. (24 sub-pages)
  - [Get resources](admin_api_resources_get_resources.md): Lists resources (assets) uploaded to your product environment.
  - [Get resources by asset folder](admin_api_resources_get_resources_by_asset_folder.md): Returns all assets stored directly in a specified asset folder, regardless of the `public_id` paths or `resource_type` of those assets. This method doesn't return assets stored in sub-folders of the specified folder.
  - [Get resources by asset IDs](admin_api_resources_get_resources_by_asset_ids.md): Returns details of the assets with the specified asset IDs. This enables you to get assets by their immutable identifiers, regardless of resource type, type, public ID, display name, or asset folder.
  - [Get resources by tag](admin_api_resources_get_resources_by_tag.md): Lists resources (assets) with a specified tag. This method doesn't return deleted assets even if they have been backed up.
  - [Get resources by context](admin_api_resources_get_resources_by_context.md): Retrieves resources (assets) with a specified contextual metadata key. This method doesn't return deleted assets even if they have been backed up.
  - [Get resources in moderation](admin_api_resources_get_resources_in_moderation.md): Retrieves resources (assets) with a particular status from a specified moderation type.
  - [Get details of a single resource by asset ID](admin_api_resources_get_details_of_a_single_resource_by_asset_id.md): Returns the details of the asset with the specified asset ID, including details on all derived assets.
  - [Get details of a single resource by public ID](admin_api_resources_get_details_of_a_single_resource_by_public_id.md): Retrieves details of the requested resource (asset), the date and time that specific changes were made to asset attributes, and details of all derived assets.
  - [Search for resources](admin_api_resources_search_for_resources.md): Search allows you fine control on filtering and retrieving information on all the resources (assets) in your product environment with the help of query expressions in a Lucene-like query language.
  - [Visual Search for resources](admin_api_resources_visual_search_for_resources.md): You can run a visual search by providing one of the following sources:
  - [Update details of an existing resource by asset ID](admin_api_resources_update_details_of_an_existing_resource_by_asset_id.md): Update one or more attributes of a specified resource (asset) by its asset ID. This enables you to update details of an asset by its unique and immutable identifier, regardless of public ID, display name, asset folder, resource type or deliver type.
  - [Update details of an existing resource by public ID](admin_api_resources_update_details_of_an_existing_resource_by_public_i.md): Update one or more attributes of a specified resource (asset) identified by its public ID. Note that you can also update many attributes of an existing asset using the [explicit](image_upload_api_reference#explicit_method") method, which is not ra...
  - [Restore resources by asset ID](admin_api_resources_restore_resources_by_asset_id.md): Restores one or more resources (assets) from [backup](backups_and_version_management) by their asset IDs.
  - [Restore resources by public ID](admin_api_resources_restore_resources_by_public_id.md): Restores one or more resources (assets), identified by the public ID, from [backup](backups_and_version_management).
  - [Update access mode (no longer supported)](admin_api_resources_update_access_mode_no_longer_supported.md): Update the access mode of resources (assets) by public ID, by tag, or by prefix. When `access_mode` = 'authenticated', uploaded resources of type 'upload' behave as if they're of type 'authenticated'.
  - [Add related assets by asset ID](admin_api_resources_add_related_assets_by_asset_id.md): Relates an asset to other assets by their asset IDs, an immutable identifier, regardless of public ID, display name, asset folder, resource type or deliver type.
  - [Add related assets by public ID](admin_api_resources_add_related_assets_by_public_id.md): Relates an asset to other assets by public IDs. This allows you to indicate that the asset is logically related to other assets in some way (e.g., similar content, or a peripheral asset like video/transcript, etc).
  - [Delete related assets by asset ID](admin_api_resources_delete_related_assets_by_asset_id.md): Unrelates the asset from other assets, specified by their asset IDs, an immutable identifier, regardless of public ID, display name, asset folder, resource type or deliver type.
  - [Delete related assets by public ID](admin_api_resources_delete_related_assets_by_public_id.md): Unrelates the asset from other assets, specified by public IDs. This is a bidirectional process, meaning that the asset will also be removed as a related\_asset from all the other assets specified.
  - [Delete resources by asset ID](admin_api_resources_delete_resources_by_asset_id.md): Deletes resources (assets) uploaded to your product environment by their asset IDs. This enables you to delete assets by their unique and immutable identifier, regardless of public ID, display name, asset folder, resource type or deliver type.
  - [Delete resources by public ID](admin_api_resources_delete_resources_by_public_id.md): Deletes resources (assets) uploaded to your product environment, identified by their public IDs.
  - [Delete resources by tags](admin_api_resources_delete_resources_by_tags.md): Deletes resources (assets) with a specified tag.
  - [Delete derived resources](admin_api_resources_delete_derived_resources.md): Deletes derived assets from your product environment.
  - [Delete backed up versions of a resource](admin_api_resources_delete_backed_up_versions_of_a_resource.md): Deletes backed up versions of an asset (resource) from your product environment.
- **[resources_last_access_reports](admin_api_resources_last_access_reports.md)**: Last access reports present a list of all the assets (resources) that have been accessed for the last time within a given time range. In addition, all last access reports automatically include any assets that were never accessed.
- **[streaming_profiles](admin_api_streaming_profiles.md)**: Enables you to list, get details of, create, modify, or delete built-in and custom [adaptive streaming profiles](adaptive_bitrate_streaming), which can be used to deliver your video using HLS and MPEG-DASH adaptive bitrate streaming.
- **[tags](admin_api_tags.md)**: Enables you to retrieve a list of all the tags currently used for a specified resource_type.
- **[transformations](admin_api_transformations.md)**: Enables you to manage stored transformations. See the [Image transformations](image_transformations) and [video transformations](video_manipulation_and_delivery) documentation for more information.
- **[triggers](admin_api_triggers.md)**: Enables you to manage event triggers and notifications within your product environment. Your product environment supports triggers up to a maximum determined by multiplying the number of unique event types by the limit of 30 notification URLs.
- **[upload_mappings](admin_api_upload_mappings.md)**: Dynamically retrieves assets from existing online locations and uploads the files to your product environment.
- **[upload_presets](admin_api_upload_presets.md)**: Enables you to centrally define image upload options instead of specifying them in each upload call.
- **[usage](admin_api_usage.md)**: Enables you to get a report on the status of your product environment **usage**, including storage, credits, bandwidth, requests, number of resources, and add-on usage. Note that numbers are updated periodically.
