✔️ Feedback sent!

0.1.2
OAS 3.0.3

Cloudinary Account Provisioning API

Download OpenAPI Document

Accounts with provisioning API access can create and manage their product environments, users and user groups using the RESTful Provisioning API.

Provisioning API access is available upon request for accounts on an Enterprise plan.

The API uses Basic Authentication over HTTPS. Your Provisioning Key and Provisioning Secret are used for the authentication. These credentials (as well as your ACCOUNT_ID) are located in the Cloudinary Console under Settings > Account > Provisioning API Access.

The Provisioning API has dedicated SDKs for the following languages:

Useful links:

Base URL
Basic Authentication (basicAuth)
Client Libraries
Shell
Ruby
Node.js
PHP
Python
More
cURL Shell

Product Environments​

Manage the product environments (sub-accounts) of your main account.

Endpoints
GET/sub_accountsPOST/sub_accountsGET/sub_accounts/{sub_account_id}PUT/sub_accounts/{sub_account_id}DELETE/sub_accounts/{sub_account_id}

Get product environments​

Return an array of all product environments, or if conditions are specified, return the relevant product environments.

Query Parameters
  • enabled
    boolean

    Whether to only return enabled product environments (true) or disabled product environments (false). Default: all product environments are returned (both enabled and disabled).

  • ids
    array string[]

    A list of up to 100 product environment IDs. When provided, other parameters are ignored.

  • cloud_names
    array string[]

    A list of up to 100 product environment cloud names.

  • prefix
    string

    Returns product environments where the name begins with the specified case-insensitive string.

Responses
  • 200Successful operation.
    application/json
  • 400Bad request.
    application/json
  • 401Authorization required.
    application/json
  • 403Not allowed.
    application/json
  • 404Not found.
    application/json
  • 409Already exists.
    application/json
  • 420Max usage rate exceeded.
    application/json
GET/sub_accounts
Shell cURL
curl --request GET \
  --url https://api.cloudinary.com/v1_1/provisioning/accounts/ACCOUNT_ID/sub_accounts \
  --header 'Authorization: Basic'

{
  "sub_accounts": [
    {
      "cloud_name": "product1",
      "name": "Product1 Application",
      "enabled": true,
      "id": "abcde1fghij2klmno3pqrst4uvwxy5z",
      "api_access_keys": [
        {
          "key": "123456789012345",
          "secret": "asdf1JKL2xyz3ABc4s3c5reT01DfaKez",
          "enabled": true
        }
      ],
      "created_at": "2016-09-27T08:00:16Z",
      "updated_at": "2016-09-27T08:00:16Z"
    },
    {
      "cloud_name": "product2",
      "name": "Product2 Application",
      "enabled": true,
      "id": "0aaaaa1bbbbb2ccccc3ddddd4eeeee5f",
      "api_access_keys": [
        {
          "key": "543210987654321",
          "secret": "T415i5mYs3cr3TkeYN0tR3a77y0o0",
          "enabled": true
        }
      ],
      "created_at": "2016-03-15T11:44:48Z",
      "updated_at": "2016-03-15T11:44:48Z"
    }
  ]
}
Get product environments sample response

Create product environment​

Create a new product environment. Any users that have access to all product environments will also automatically have access to the new product environment.

Body
application/json

Product environment details

name
required
string

The display name for the product environment.

ExampleProduct3 Application
cloud_name
string

The Cloudinary cloud name (optional, default is auto-generated).

Exampleproduct3
base_sub_account_id
string

The ID of another product environment to copy settings from (optional).

Example0aaaaa1bbbbb2ccccc3ddddd4eeeee5f
custom_attributes
object

Custom attributes associated with the product environment (optional).

Responses
  • 200Product environment created successfully
    application/json
  • 400Bad request.
    application/json
  • 401Authorization required.
    application/json
  • 403Not allowed.
    application/json
  • 409Already exists.
    application/json
  • 420Max usage rate exceeded.
    application/json
POST/sub_accounts
Shell cURL
curl --request POST \
  --url https://api.cloudinary.com/v1_1/provisioning/accounts/ACCOUNT_ID/sub_accounts \
  --header 'Authorization: Basic' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Product3 Application",
  "cloud_name": "product3",
  "base_sub_account_id": "0aaaaa1bbbbb2ccccc3ddddd4eeeee5f",
  "custom_attributes": {}
}'

{
  "cloud_name": "product3",
  "name": "Product3 Application",
  "enabled": false,
  "id": "555asdf0000zxcvb3456qwerty",
  "api_access_keys": [
    {
      "key": "135792468054321",
      "secret": "w4aTi5Y0u6k3YN0773lL1nGyUt0Da8",
      "enabled": true
    }
  ],
  "created_at": "2016-09-27T11:15:35Z",
  "updated_at": "2016-09-27T11:15:35Z"
}
Product environment sample response 3

Get product environment​

Retrieve a specific product environment.

Path Parameters
  • sub_account_id
    required
    string

    The ID of the product environment.

Responses
  • 200Successful operation
    application/json
  • 400Bad request.
    application/json
  • 401Authorization required.
    application/json
  • 404Not found.
    application/json
  • 420Max usage rate exceeded.
    application/json
GET/sub_accounts/{sub_account_id}
Shell cURL
curl --request GET \
  --url https://api.cloudinary.com/v1_1/provisioning/accounts/ACCOUNT_ID/sub_accounts/abcde1fghij2klmno3pqrst4uvwxy5z \
  --header 'Authorization: Basic'

{
  "cloud_name": "product1",
  "name": "Product1 Application",
  "enabled": true,
  "id": "abcde1fghij2klmno3pqrst4uvwxy5z",
  "api_access_keys": [
    {
      "key": "123456789012345",
      "secret": "asdf1JKL2xyz3ABc4s3c5reT01DfaKez",
      "enabled": true
    }
  ],
  "created_at": "2016-09-27T08:00:16Z",
  "updated_at": "2016-09-27T08:00:16Z"
}
Product environment sample response 1

Update product environment​

Update the details of a product environment.

Path Parameters
  • sub_account_id
    required
    string

    The ID of the product environment.

Body
application/json

Updated product environment details

name
string

The display name for the product environment.

ExampleProduct1 Application
cloud_name
string

The Cloudinary cloud name. An error is returned if the requested name already exists. Note: Can only be changed for accounts with fewer than 1000 images.

Exampleproduct1
custom_attributes
object

Custom attributes associated with the product environment.

enabled
boolean

Whether the product environment is enabled. Default: true.

Responses
  • 200Product environment updated successfully
    application/json
  • 400Bad request.
    application/json
  • 401Authorization required.
    application/json
  • 403Not allowed.
    application/json
  • 404Not found.
    application/json
  • 409Already exists.
    application/json
  • 420Max usage rate exceeded.
    application/json
PUT/sub_accounts/{sub_account_id}
Shell cURL
curl --request PUT \
  --url https://api.cloudinary.com/v1_1/provisioning/accounts/ACCOUNT_ID/sub_accounts/abcde1fghij2klmno3pqrst4uvwxy5z \
  --header 'Authorization: Basic' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Product1 Application",
  "cloud_name": "product1",
  "custom_attributes": {}
}'

{
  "cloud_name": "product1",
  "name": "Product1 Application",
  "enabled": true,
  "id": "abcde1fghij2klmno3pqrst4uvwxy5z",
  "api_access_keys": [
    {
      "key": "123456789012345",
      "secret": "asdf1JKL2xyz3ABc4s3c5reT01DfaKez",
      "enabled": true
    }
  ],
  "created_at": "2016-09-27T08:00:16Z",
  "updated_at": "2016-09-27T08:00:16Z"
}
Product environment sample response 1

Delete product environment​

Delete a specific product environment.

Path Parameters
  • sub_account_id
    required
    string

    The ID of the product environment.

Responses
  • 200Product environment deleted successfully
    application/json
  • 400Bad request.
    application/json
  • 401Authorization required.
    application/json
  • 403Not allowed.
    application/json
  • 404Not found.
    application/json
  • 420Max usage rate exceeded.
    application/json
DELETE/sub_accounts/{sub_account_id}
Shell cURL
curl --request DELETE \
  --url https://api.cloudinary.com/v1_1/provisioning/accounts/ACCOUNT_ID/sub_accounts/abcde1fghij2klmno3pqrst4uvwxy5z \
  --header 'Authorization: Basic'

{
  "message": "ok"
}

Product environment deleted successfully

Access Keys​

Manage the access keys, which include an API key and secret pair, for your product environment (sub-account).

Endpoints
GET/sub_accounts/{sub_account_id}/access_keysPOST/sub_accounts/{sub_account_id}/access_keysDELETE/sub_accounts/{sub_account_id}/access_keysPUT/sub_accounts/{sub_account_id}/access_keys/{key}DELETE/sub_accounts/{sub_account_id}/access_keys/{key}

Users​

Manage the users for your account.

Endpoints
GET/usersPOST/usersGET/users/{user_id}PUT/users/{user_id}DELETE/users/{user_id}

User Groups​

Manage the groups for the users in your account

Endpoints
GET/user_groupsPOST/user_groupsGET/user_groups/{group_id}PUT/user_groups/{group_id}DELETE/user_groups/{group_id}GET/user_groups/{group_id}/usersPOST/user_groups/{group_id}/users/{user_id}DELETE/user_groups/{group_id}/users/{user_id}

Models

enabled
ids
Value
cloud_names
Value
prefix
Value
Response
.,,uod8B8bou,,. ..,uod8BBBBBBBBBBBBBBBBRPFT?l!i:. ||||||||||||||!?TFPRBBBBBBBBBBBBBBB8m=, |||| '""^^!!||||||||||TFPRBBBVT!:...! |||| '""^^!!|||||?!:.......! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! ||||, ||||.........` |||||!!-._ ||||.......;. ':!|||||||||!!-._ ||||.....bBBBBWdou,. bBBBBB86foi!|||||||!!-..:|||!..bBBBBBBBBBBBBBBY! ::!?TFPRBBBBBB86foi!||||||||!!bBBBBBBBBBBBBBBY..! :::::::::!?TFPRBBBBBB86ftiaabBBBBBBBBBBBBBBY....! :::;`"^!:;::::::!?TFPRBBBBBBBBBBBBBBBBBBBY......! ;::::::...''^::::::::::!?TFPRBBBBBBBBBBY........! .ob86foi;::::::::::::::::::::::::!?TFPRBY..........` .b888888888886foi;:::::::::::::::::::::::..........` .b888888888888888888886foi;::::::::::::::::...........b888888888888888888888888888886foi;:::::::::......`!Tf998888888888888888888888888888888886foi;:::....` '"^!|Tf9988888888888888888888888888888888!::..` '"^!|Tf998888888888888888888888889!! '` '"^!|Tf9988888888888888888!!` iBBbo. '"^!|Tf998888888889!` WBBBBbo. '"^!|Tf9989!` YBBBP^' '"^!` `