✔️ 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 Account API Key and Account API Secret (previously referred to as Provisioning API keys) are used for the authentication. These credentials (as well as your ACCOUNT_ID) are located in the Cloudinary Console under Settings > Account API Keys.

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

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^' '"^!` `