cloudinex

v0.6.0

cloudinex v0.6.0 Cloudinex View Source

Cloudinex is an Elixir wrapper around the Cloudinary API.

The administrative API allows full control of all uploaded raw files and images, fetched social profile pictures, generated transformations and more.

The API is accessed using HTTPS to endpoints in the following format:

https://api.cloudinary.com/v1_1/:cloud_name/:action

Authentication is done using Basic Authentication over secure HTTP. Your Cloudinary API Key and API Secret are used for the authentication and can be found here. Configuration is handled via application variables:

  config :cloudinex,
        debug: false, #optional
        base_url: "https://api.cloudinary.com/v1_1/",
        api_key: "YOUR_API_KEY",
        secret: "YOUR_API_SECRET",
        cloud_name: "YOUR_CLOUD_NAME"

Request parameters are appended to the URL by passing in a keyword list of options.

All responses are decoded from JSON into Elixir maps.

Cloudinary Documentation

Link to this section Summary

Types

option()

Functions

create_transformation(name, transformation)

Create named transformation

create_upload_mapping(folder, template)

Create a new upload mapping folder and its template (URL)

create_upload_preset(name, unsigned, disallow_public_id, settings \\ [])

Create a new upload preset

delete_all_resources(options \\ [])

Delete all resources (of the relevant resource type and type), including derived resources (up to a maximum of 1000 original resources)

delete_derived_resources(derived_resource_ids, options \\ [])

Delete derived resources

delete_resource(public_id, options \\ [])

Deletes a single resource by its public id

delete_resources(hash, options \\ [])

Delete all resources (and their derivatives) with the given tag name (up to a maximum of 1000 original resources)

delete_resources_by_prefix(prefix, options \\ [])

Delete all resources, including derived resources, where the public ID starts with the given prefix (up to a maximum of 1000 original resources)

delete_resources_by_tag(tag, options \\ [])

Delete all resources (and their derivatives) with the given tag name (up to a maximum of 1000 original resources)

delete_transformation(id, options \\ [])

Delete transformation

delete_upload_mapping(folder)

Delete an upload mapping by folder name

delete_upload_preset(id, options \\ [])

Deletes upload preset

folders()

List all the root folders

folders(root_folder)

Lists the name and path of all the subfolders of a given root folder

ping!()

Test the reachability of the Cloudinary API with the ping method

ping()

Test the reachability of the Cloudinary API with the ping method

resource(public_id, options \\ [])

Details of a single resource

resource_types()

Returns available resource types

resources(options \\ [])

List resources by parameters

resources_by_context(key, value \\ nil, options \\ [])

Retrieve a list of resources with a specified context key. This method does not return deleted resources even if they have been backed up

resources_by_moderation(moderation_type, status, options \\ [])

List resources in moderation queues

resources_by_tag(tag, options \\ [])

Retrieve a list of resources with a specified tag. This method does not return deleted resources even if they have been backed up

restore_resource(public_ids, options \\ [])

Restore one or more resources from backup

tags(options \\ [])

List tags for a resource type

transformation(id, options \\ [])

Receive details of a single transformation

transformations(options \\ [])

Receive list of all transformations

update_access_mode(hash, access_mode, options \\ [])

This method updates the access_mode of resources of a specific resource type (default = image) according to the defined conditions. When access_mode = ‘authenticated’, uploaded resources of type ‘upload’ behave as if they are of type ‘authenticated’. The resource can later be made public by changing its access_mode to ‘public’, without having to update any image delivery URLs. In the case where public images are reverted to authenticated by changing their access_mode to ‘authenticated’, all the existing original and derived versions of the images are also invalidated on the CDN

update_resource(public_id, options \\ [])

Update one or more of the attributes associated with a specified resource. Note that you can also update many attributes of an existing resource using the explicit method, which is not rate limited

update_transformation(id, options \\ [])

Updates transformation

update_upload_mapping(folder, template)

Update an existing upload mapping folder with a new template (URL)

update_upload_preset(name, settings \\ [])

Updates upload preset

upload_mapping(folder)

Details of a single upload mapping

upload_mappings(options \\ [])

List all upload mappings by folder and its mapped template (URL)

upload_preset(preset_name)

Retrieves the details of an upload preset

upload_presets(options \\ [])

Lists upload presets

usage()

Get a report on the status of your Cloudinary account usage details, including storage, bandwidth, requests, number of resources, and add-on usage. Note that numbers are updated periodically

version()

Returns current version of library from Mix file

Link to this section Types

Link to this type option() View Source 
option() ::
  {:method, Tesla.Env.method()}
  | {:url, Tesla.Env.url()}
  | {:query, Tesla.Env.query()}
  | {:headers, Tesla.Env.headers()}
  | {:body, Tesla.Env.body()}
  | {:opts, Tesla.Env.opts()}

Link to this section Functions

Link to this function create_transformation(name, transformation) View Source 
create_transformation(name :: String.t(), transformation :: String.t()) ::
  map()

Create named transformation

  • :name - Name for transformation

  • :transformation - String representation of transformation parameters.

    API Docs

Link to this function create_upload_mapping(folder, template) View Source 
create_upload_mapping(folder :: String.t(), template :: String.t()) :: map()

Create a new upload mapping folder and its template (URL).

API Docs

Link to this function create_upload_preset(name, unsigned, disallow_public_id, settings \\ []) View Source 
create_upload_preset(
  name :: String.t(),
  unsigned :: boolean(),
  disallow_public_id :: boolean(),
  settings :: Keyword.t()
) :: map()

Create a new upload preset.

Parameters:

  • :name - The name to assign to the upload preset.
  • :unsigned - Boolean. Whether this upload preset allows unsigned uploading to Cloudinary.
  • :disallow_public_id - Boolean. Whether this upload preset disables assigning a public_id in the image upload call.

  • :settings - The upload actions to apply to the images uploaded with this preset.

    API Docs

Link to this function delete_all_resources(options \\ []) View Source 
delete_all_resources(options :: Keyword.t()) :: map()

Delete all resources (of the relevant resource type and type), including derived resources (up to a maximum of 1000 original resources).

  • :resource_type - Optional (String, default: image). The type of file. Possible values: image, raw, video. Relevant as a parameter only when using the SDKs (the resource type is included in the endpoint URL for direct calls to the HTTP API). Note: Use the video resource type for all video resources as well as for audio files, such as .mp3.
  • :keep_original - Optional (Boolean, default: false). If true, delete only the derived images of the matching resources.
  • :invalidate - Optional (Boolean, default: false). Whether to also invalidate the copies of the resource on the CDN. It usually takes a few minutes (although it might take up to an hour) 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.
  • :transformations - Optional. Only the derived resources matching this array of transformation parameters will be deleted.
  • :next_cursor - Optional. 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 the next_cursor parameter of the following deletion request.
Link to this function delete_derived_resources(derived_resource_ids, options \\ []) View Source 
delete_derived_resources(
  derived_resource_ids :: List.t(),
  options :: Keyword.t()
) :: map()

Delete derived resources

  • :derived_resource_ids - Delete all derived resources with the given IDs (an array of up to 100 derived_resource_ids). The derived resource IDs are returned when calling the Details of a single resource method.

    API Docs

Link to this function delete_resource(public_id, options \\ []) View Source 
delete_resource(public_id :: String.t(), options :: Keyword.t()) :: map()

Deletes a single resource by its public id

  • :resource_type - Optional (String, default: image). The type of file. Possible values: image, raw, video. Relevant as a parameter only when using the SDKs (the resource type is included in the endpoint URL for direct calls to the HTTP API). Note: Use the video resource type for all video resources as well as for audio files, such as .mp3.
  • :keep_original - Optional (Boolean, default: false). If true, delete only the derived images of the matching resources.
  • :invalidate - Optional (Boolean, default: false). Whether to also invalidate the copies of the resource on the CDN. It usually takes a few minutes (although it might take up to an hour) 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.
  • :transformations - Optional. Only the derived resources matching this array of transformation parameters will be deleted.
  • :next_cursor - Optional. 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 the next_cursor parameter of the following deletion request.
Link to this function delete_resources(hash, options \\ []) View Source 
delete_resources(hash :: Map.t(), options :: Keyword.t()) :: map()

Delete all resources (and their derivatives) with the given tag name (up to a maximum of 1000 original resources).

  • :resource_type - Optional (String, default: image). The type of file. Possible values: image, raw, video. Relevant as a parameter only when using the SDKs (the resource type is included in the endpoint URL for direct calls to the HTTP API). Note: Use the video resource type for all video resources as well as for audio files, such as .mp3.
  • :keep_original - Optional (Boolean, default: false). If true, delete only the derived images of the matching resources.
  • :invalidate - Optional (Boolean, default: false). Whether to also invalidate the copies of the resource on the CDN. It usually takes a few minutes (although it might take up to an hour) 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.
  • :transformations - Optional. Only the derived resources matching this array of transformation parameters will be deleted.
  • :next_cursor - Optional. 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 the next_cursor parameter of the following deletion request.
Link to this function delete_resources_by_prefix(prefix, options \\ []) View Source 
delete_resources_by_prefix(prefix :: String.t(), options :: Keyword.t()) ::
  map()

Delete all resources, including derived resources, where the public ID starts with the given prefix (up to a maximum of 1000 original resources).

  • :resource_type - Optional (String, default: image). The type of file. Possible values: image, raw, video. Relevant as a parameter only when using the SDKs (the resource type is included in the endpoint URL for direct calls to the HTTP API). Note: Use the video resource type for all video resources as well as for audio files, such as .mp3.
  • :keep_original - Optional (Boolean, default: false). If true, delete only the derived images of the matching resources.
  • :invalidate - Optional (Boolean, default: false). Whether to also invalidate the copies of the resource on the CDN. It usually takes a few minutes (although it might take up to an hour) 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.
  • :transformations - Optional. Only the derived resources matching this array of transformation parameters will be deleted.
  • :next_cursor - Optional. 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 the next_cursor parameter of the following deletion request.
Link to this function delete_resources_by_tag(tag, options \\ []) View Source 
delete_resources_by_tag(tag :: String.t(), options :: Keyword.t()) :: map()

Delete all resources (and their derivatives) with the given tag name (up to a maximum of 1000 original resources).

  • :resource_type - Optional (String, default: image). The type of file. Possible values: image, raw, video. Relevant as a parameter only when using the SDKs (the resource type is included in the endpoint URL for direct calls to the HTTP API). Note: Use the video resource type for all video resources as well as for audio files, such as .mp3.
  • :keep_original - Optional (Boolean, default: false). If true, delete only the derived images of the matching resources.
  • :invalidate - Optional (Boolean, default: false). Whether to also invalidate the copies of the resource on the CDN. It usually takes a few minutes (although it might take up to an hour) 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.
  • :transformations - Optional. Only the derived resources matching this array of transformation parameters will be deleted.

  • :next_cursor - Optional. 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 the next_cursor parameter of the following deletion request.

    API Docs

Link to this function delete_transformation(id, options \\ []) View Source 
delete_transformation(id :: String.t(), options :: Keyword.t()) :: map()

Delete transformation

Note: Deleting a transformation also deletes all the derived images based on this transformation (up to 1000). The method returns an error if there are more than 1000 derived images based on this transformation.

API Docs

Link to this function delete_upload_mapping(folder) View Source 
delete_upload_mapping(folder :: String.t()) :: map()

Delete an upload mapping by folder name.

API Docs

Link to this function delete_upload_preset(id, options \\ []) View Source 
delete_upload_preset(id :: String.t(), options :: Keyword.t()) :: map()

Deletes upload preset

API Docs

Link to this function folders() View Source 
folders() :: map()

List all the root folders

API Docs

Link to this function folders(root_folder) View Source 
folders(root_folder :: String.t()) :: map()

Lists the name and path of all the subfolders of a given root folder.

API Docs

Link to this function ping!() View Source 
ping!() :: map()

Test the reachability of the Cloudinary API with the ping method.

  iex> Cloudinex.ping!
  %{"status" => "ok"}

API Docs

Link to this function ping() View Source 
ping() :: {atom(), map()}

Test the reachability of the Cloudinary API with the ping method.

  iex> Cloudinex.ping
  {:ok, %{"status" => "ok"}}

API Docs

Link to this function resource(public_id, options \\ []) View Source 
resource(public_id :: String.t(), options :: Keyword.t()) :: map()

Details of a single resource

Return details of the requested resource as well as all its derived resources. Note that if you only need details about the original resource, you can also use the upload or explicit methods, which are not rate limited.

  • :public_id - Required. (String). The public ID of the resource
  • :resource_type - Optional (String, default: image). The type of file. Possible values: image, raw, video. Relevant as a parameter only when using the SDKs (the resource type is included in the endpoint URL for direct calls to the HTTP API). Note: Use the video resource type for all video resources as well as for audio files, such as .mp3.
  • :type - Optional (String, default: upload). The storage type, for example, upload, private, authenticated, facebook, etc. Relevant as a parameter only when using the SDKs (the type is included in the endpoint URL for direct calls to the HTTP API).
  • :colors - Optional (Boolean, default: false). If true, include color information: predominant colors and histogram of 32 leading colors.
  • :image_metadata - Optional (Boolean, default: false). If true, include colorspace, ETag, IPTC, XMP, and detailed Exif metadata of the uploaded photo. Note: retrieves video metadata if the resource is a video file.
  • :exif - Optional (Boolean, default: false). If true, include image metadata (e.g., camera details). Deprecated. Please use image_metadata instead.
  • :faces - Optional (Boolean, default: false). If true, include a list of coordinates of detected faces.
  • :pages - Optional (Boolean, default: false). If true, report the number of pages in multi-page documents (e.g., PDF)
  • :phash - Optional (Boolean, default: false). If true, include the perceptual hash (pHash) of the uploaded photo for image similarity detection.
  • :coordinates - Optional (Boolean, default: false). If true, include previously specified custom cropping coordinates and faces coordinates.
  • :max_results - Optional. The number of derived images to return. Default=10. Maximum=100.

  • :next_cursor - Optional. If there are more derived images 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 listing request.

    API Docs

Link to this function resource_types() View Source 
resource_types() :: {atom(), map()}

Returns available resource types

  iex> Cloudinex.resource_types
  {:ok, %{"resource_types" => ["image"]}}
Link to this function resources(options \\ []) View Source 
resources(options :: Keyword.t()) :: map()

List resources by parameters

  • :resource_type - Optional (String, default: image). The type of file. Possible values: image, raw, video. Relevant as a parameter only when using the SDKs (the resource type is included in the endpoint URL for direct calls to the HTTP API). Note: Use the video resource type for all video resources as well as for audio files, such as .mp3.
  • :type - Optional (String, default: all). The storage type, for example, upload, private, authenticated, facebook, etc. Relevant as a parameter only when using the SDKs (the type is included in the endpoint URL for direct calls to the HTTP API).
  • :prefix - Optional. (String). Find all resources with a public ID that starts with the given prefix. The resources are sorted by public ID in the response.
  • :public_ids - Optional. (String, comma-separated list of public IDs). List resources with the given public IDs (up to 100).
  • :max_results - Optional. (Integer, default=10. maximum=500). Max number of resources to return.
  • :next_cursor - Optional. When a listing 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 listing request.
  • :start_at - Optional. (Timestamp string). List resources that were created since the given timestamp. Supported if no prefix or public IDs were specified.
  • :direction - Optional. (String/Integer, “asc” (or 1), “desc” (or -1), default: “desc” according to the created_at date). Control the order of returned resources. Note that if a prefix is specified, this parameter is ignored and the results are sorted by public ID.
  • :tags - Optional (Boolean, default: false). If true, include the list of tag names assigned each resource.
  • :context - Optional (Boolean, default: false). If true, include key-value pairs of context associated with each resource.
  • :moderations - Optional (Boolean, default: false). If true, include image moderation status of each listed resource. 
  iex> Cloudinex.resources
  {:ok,
   %{"next_cursor" => "c3e05e720779a7aba3953abfc1017e5b",
     "resources" => [
      %{"bytes" => 745895,
        "created_at" => "2017-08-29T20:30:06Z",
        "format" => "png",
        "height" => 720,
        "public_id" => "zfqp6sjepkrkyrxnflpr",
        "resource_type" => "image",
        "secure_url" => "https://res.cloudinary.com/demo/image/upload/v1504038606/zfqp6sjepkrkyrxnflpr.png",
        "type" => "upload",
        "url" => "http://res.cloudinary.com/demo/image/upload/v1504038606/zfqp6sjepkrkyrxnflpr.png",
        "version" => 1504038606,
        "width" => 720}
      ]
    }
  }

API Docs

Link to this function resources_by_context(key, value \\ nil, options \\ []) View Source 
resources_by_context(
  key :: String.t(),
  value :: String.t(),
  options :: Keyword.t()
) :: map()

Retrieve a list of resources with a specified context key. This method does not return deleted resources even if they have been backed up.

  • :resource_type - Optional (String, default: image). The type of file. Possible values: image, raw, video. Relevant as a parameter only when using the SDKs (the resource type is included in the endpoint URL for direct calls to the HTTP API). Note: Use the video resource type for all video resources as well as for audio files, such as .mp3.
  • :value - Optional. (String). Only resources with this value for the context key are returned. If this parameter is not provided, all resources with the given context key are returned, regardless of the actual value of the key.
  • :max_results - Optional. (Integer, default=10. maximum=500). Max number of resources to return.
  • :next_cursor - Optional. When a listing 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 listing request.
  • :direction - Optional. (String/Integer, “asc” (or 1), “desc” (or -1), default: “desc” by creation date). Control the order of returned resources.
  • :tags - Optional (Boolean, default: false). If true, include the list of tag names assigned each resource.

  • :context- Optional (Boolean, default: false). If true, include all key-value pairs of context associated with each resource.

    API Docs

Link to this function resources_by_moderation(moderation_type, status, options \\ []) View Source 
resources_by_moderation(
  moderation_type :: String.t(),
  status :: String.t(),
  options :: Keyword.t()
) :: map()

List resources in moderation queues

  • :moderation_type - (String: “manual”, “webpurify”, “aws_rek”, or “metascan”). Type of image moderation queue to list.

  • :status - (String: “pending”, “approved”, “rejected”). Moderation status of resources.

  • :resource_type - Optional (String, default: image). The type of file. Possible values: image, raw, video. Relevant as a parameter only when using the SDKs (the resource type is included in the endpoint URL for direct calls to the HTTP API). Note: Use the video resource type for all video resources as well as for audio files, such as .mp3.

  • :max_results - Optional. (Integer, default=10. maximum=500). Max number of resources to return.

  • :next_cursor - Optional. When a listing 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 listing request.

  • :direction - Optional. (String/Integer, “asc” (or 1), “desc” (or -1), default: “desc” by creation date). Control the order of returned resources.

  • :tags - Optional (Boolean, default: false). If true, include the list of tag names assigned each resource.

  • :context - Optional (Boolean, default: false). If true, include key-value pairs of context associated with each resource.

  • :moderations - Optional (Boolean, default: false). If true, include image moderation status of each listed resource.

    API Docs

Link to this function resources_by_tag(tag, options \\ []) View Source 
resources_by_tag(tag :: String.t(), options :: Keyword.t()) :: map()

Retrieve a list of resources with a specified tag. This method does not return deleted resources even if they have been backed up.

  • :resource_type - Optional (String, default: image). The type of files for which you want to retrieve tags. Possible values: image, raw, video. Note: Use the video resource type for all video resources as well as for audio files, such as .mp3. Relevant as a parameter only when using the SDKs (the resource type is included in the endpoint URL for direct calls to the HTTP API).
  • :max_results - Optional. (Integer, default=10. maximum=500). Max number of resources to return.
  • :next_cursor - Optional. When a listing 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 listing request.
  • :direction - Optional. (String/Integer, “asc” (or 1), “desc” (or -1), default: “desc” by creation date). Control the order of returned resources.
  • :tags - Optional (Boolean, default: false). If true, include the list of tag names assigned each resource.
  • :context - Optional (Boolean, default: false). If true, include key-value pairs of context associated with each resource.

  • :moderations - Optional (Boolean, default: false). If true, include image moderation status of each listed resource.

    API Docs

Link to this function restore_resource(public_ids, options \\ []) View Source 
restore_resource(public_ids :: List.t(), options :: Keyword.t()) :: map()

Restore one or more resources from backup

  • :resource_type - Optional (String, default: image). The type of file. Possible values: image, raw, video. Relevant as a parameter only when using the SDKs (the resource type is included in the endpoint URL for direct calls to the HTTP API). Note: Use the video resource type for all video resources as well as for audio files, such as .mp3.
  • :type - Optional (String, default: upload). The storage type, for example, upload, private, authenticated, facebook, etc. Relevant as a parameter only when using the SDKs (the type is included in the endpoint URL for direct calls to the HTTP API).

  • :public_ids - The public IDs of (deleted or existing) backed up resources to restore. Reverts to the latest backed up version of the resource.

    API Docs

Link to this function tags(options \\ []) View Source 
tags(options :: Keyword.t()) :: map()

List tags for a resource type

  • :resource_type - Optional (String, default: image). The type of file for which to retrieve the tags. Possible values: image, raw, video. Relevant as a parameter only when using the SDKs (the resource type is included in the endpoint URL for direct calls to the HTTP API). Note: Use the video resource type for all video resources as well as for audio files, such as .mp3.
  • :prefix - Optional. Find all tags that start with the given prefix.
  • :max_results - Optional. Max number of tags to return. Default=10. Maximum=500.

  • :next_cursor - Optional. When a listing 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 listing request.

    API Docs

Link to this function transformation(id, options \\ []) View Source 
transformation(id :: String.t(), options :: Keyword.t()) :: map()

Receive details of a single transformation

  • :max_results - Optional. Max number of transformations to return. Default=10. Maximum=500.

  • :next_cursor - Optional. When a listing 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 listing request.

    API Docs

Link to this function transformations(options \\ []) View Source 
transformations(options :: Keyword.t()) :: map()

Receive list of all transformations

  • :max_results - Optional. Max number of transformations to return. Default=10. Maximum=500.

  • :next_cursor - Optional. When a listing 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 listing request.

    API Docs

Link to this function update_access_mode(hash, access_mode, options \\ []) View Source

This method updates the access_mode of resources of a specific resource type (default = image) according to the defined conditions. When access_mode = ‘authenticated’, uploaded resources of type ‘upload’ behave as if they are of type ‘authenticated’. The resource can later be made public by changing its access_mode to ‘public’, without having to update any image delivery URLs. In the case where public images are reverted to authenticated by changing their access_mode to ‘authenticated’, all the existing original and derived versions of the images are also invalidated on the CDN:

Required Parameters:

  • :access_mode - The new access mode to be set (“public” or “authenticated”).

    One of the following:

  • :public_ids - Update all resources with the given public IDs (array of up to 100 public_ids). prefix - Update all resources where the public ID starts with the given prefix (up to a maximum of 100 matching original resources).

  • :tag - Update all resources with the given tag (up to a maximum of 100 matching original resources).

    Optional Parameters:

  • :resource_type - Optional (String, default: image). The type of file. Possible values: image, raw, video. Relevant as a parameter only when using the SDKs (the resource type is included in the endpoint URL for direct calls to the HTTP API). Note: Use the video resource type for all video resources as well as for audio files, such as .mp3.

  • :next_cursor - Optional. When an update request has more than 100 resources to update, the response includes a next_cursor value. You can then specify this returned next_cursor value as the next_cursor parameter of the following update request.

Link to this function update_resource(public_id, options \\ []) View Source 
update_resource(public_id :: String.t(), options :: Keyword.t()) :: map()

Update one or more of the attributes associated with a specified resource. Note that you can also update many attributes of an existing resource using the explicit method, which is not rate limited

  • :public_id - Required. (String). The public ID of the resource to update.
  • :resource_type - Optional (String, default: image). The type of file. Possible values: image, raw, video. Relevant as a parameter only when using the SDKs (the resource type is included in the endpoint URL for direct calls to the HTTP API). Note: Use the video resource type for all video resources as well as for audio files, such as .mp3.
  • :type - Optional (String, default: upload). The storage type, for example, upload, private, authenticated, facebook, etc. Relevant as a parameter only when using the SDKs (the type is included in the endpoint URL for direct calls to the HTTP API).
  • :tags - (Optional). A comma-separated list of tag names to assign to the uploaded image for later group reference.
  • :context - (Optional). A pipe separated list of key-value pairs of general textual context metadata to attach to an uploaded resource. The context values of uploaded files are available for fetching using the Admin API. For example: “alt=My image|caption=Profile Photo”.
  • :face_coordinates - (Optional). List of coordinates of faces contained in an uploaded image. The given 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 ‘|’. For example: “10,20,150,130|213,345,82,61”.
  • :custom_coordinates - (Optional). Coordinates of an interesting region contained in an uploaded image. The given 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”.
  • :moderation_status - (Optional. String: “approved”, “rejected”). Manually set image moderation status or override previously automatically moderated images by approving or rejecting.
  • :auto_tagging (0.0 to 1.0 Decimal number) - (Optional). Whether to assign tags to an image according to detected scene categories with confidence score higher than the given value.
  • :detection - (Optional). Set to ‘adv_face’ to automatically extract advanced face attributes of photos using the Advanced Facial Attributes Detection add-on.
  • :ocr - (Optional). Set to ‘adv_ocr’ to extract all text elements in an image as well as the bounding box coordinates of each detected element using the OCR Text Detection and Extraction add-on.
  • :raw_convert - (Optional). Set to ‘aspose’ to automatically convert Office documents to PDF files and other image formats using the Aspose Document Conversion add-on.
  • :categorization - (Optional). Set to ‘imagga_tagging’ to automatically detect scene categories of photos using the Imagga Auto Tagging add-on.

  • :background_removal - (Optional). Set to ‘remove_the_background’ (or ‘pixelz’ - the new name of the company) to automatically clear the background of an uploaded photo using the Remove-The-Background Editing add-on.

    API Docs

Link to this function update_transformation(id, options \\ []) View Source 
update_transformation(id :: String.t(), options :: Keyword.t()) :: map()

Updates transformation

  • :allowed_for_strict - Boolean. Whether this transformation is allowed when Strict Transformations are enabled.

  • :unsafe_update - Optional. Allows updating an existing named transformation without updating all associated derived images (the new settings of the named transformation only take effect from now on).

    API Docs

Link to this function update_upload_mapping(folder, template) View Source 
update_upload_mapping(folder :: String.t(), template :: String.t()) :: map()

Update an existing upload mapping folder with a new template (URL).

Parameters:

  • :folder - The name of the mapped folder.

  • :template - The new URL to be mapped to the folder.

    API Docs

Link to this function update_upload_preset(name, settings \\ []) View Source 
update_upload_preset(name :: String.t(), settings :: Keyword.t()) :: map()

Updates upload preset.

Parameters:

  • :name - The name to assign to the upload preset.
  • :unsigned - Boolean. Whether this upload preset allows unsigned uploading to Cloudinary.
  • :disallow_public_id - Boolean. Whether this upload preset disables assigning a public_id in the image upload call.

  • :settings - The upload actions to apply to the images uploaded with this preset.

    API Docs

Link to this function upload_mapping(folder) View Source 
upload_mapping(folder :: String.t()) :: map()

Details of a single upload mapping

Retrieve the mapped template (URL) of a given upload mapping folder.

API Docs

Link to this function upload_mappings(options \\ []) View Source 
upload_mappings(options :: Keyword.t()) :: map()

List all upload mappings by folder and its mapped template (URL).

  • :max_results - Optional. Max number of upload mappings to return. Default=10. Maximum=500.

  • :next_cursor - Optional. When a listing 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 listing request.

    API Docs

Link to this function upload_preset(preset_name) View Source 
upload_preset(preset_name :: String.t()) :: map()

Retrieves the details of an upload preset.

API Docs

Link to this function upload_presets(options \\ []) View Source 
upload_presets(options :: Keyword.t()) :: map()

Lists upload presets

Parameters:

  • :max_results - Optional. Max number of upload presets to return. Default=10. Maximum=500.

  • :next_cursor - Optional. When a listing 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 listing request.

    API Docs

Link to this function usage() View Source 
usage() :: map()

Get a report on the status of your Cloudinary account usage details, including storage, bandwidth, requests, number of resources, and add-on usage. Note that numbers are updated periodically

  iex> a = Cloudinex.usage
  %{"bandwidth" => %{"limit" => 6442450944, "usage" => 6357564,
  "used_percent" => 0.1}, "derived_resources" => 174,
  "last_updated" => "2017-09-17",
  "objects" => %{"limit" => 125000, "usage" => 256, "used_percent" => 0.2},
  "plan" => "Free", "requests" => 248, "resources" => 82,
  "storage" => %{"limit" => 2671771648, "usage" => 29788466,
  "used_percent" => 1.11},
  "transformations" => %{"limit" => 7500, "usage" => 78,
  "used_percent" => 1.04}}

  iex> a.bandwidth.limit
  6442450944

API Docs

Link to this function version() View Source 
version() :: String.t()

Returns current version of library from Mix file