Home
Version 3
Organization Quota Definitions API

Organization Quota Definitions API

Creating a Organization Quota Definition

POST /v2/quota_definitions

Request

Route

POST /v2/quota_definitions

Body

Name Description Default Valid Values Example Values
name The name for the Organization Quota Definition.
  • gold_quota
non_basic_services_allowed If an organization can have non basic services
  • true
  • false
total_services How many services an organization can have. (-1 represents an unlimited amount)
  • -1
  • 5
  • 201
total_service_keys How many service keys an organization can have. (-1 represents an unlimited amount) -1
  • -1
  • 5
  • 201
total_routes How many routes an organization can have. (-1 represents an unlimited amount)
  • -1
  • 10
  • 23
total_reserved_route_ports How many routes an organization can have that use a reserved port. These routes count toward total_routes. (-1 represents an unlimited amount) 0
  • -1
  • 10
  • 20
total_private_domains How many private domains an organization can have. (-1 represents an unlimited amount) -1
  • -1
  • 10
  • 23
memory_limit How much memory in megabyte an organization can have.
  • 5120
  • 9999
instance_memory_limit The maximum amount of memory in megabyte an application instance can have. (-1 represents an unlimited amount) -1
  • -1
  • 10240
  • 9999
trial_db_allowed If an organization can have a trial db.
app_instance_limit How many app instances an organization can create. (-1 represents an unlimited amount) -1
  • -1
  • 10
  • 23
app_task_limit The number of tasks that can be run per app. (-1 represents an unlimited amount) -1
  • -1
  • 10
{
  "name": "gold_quota",
  "non_basic_services_allowed": true,
  "total_services": -1,
  "total_routes": 4,
  "memory_limit": 5120,
  "instance_memory_limit": 10240,
  "app_instance_limit": 10,
  "app_task_limit": 5,
  "total_reserved_route_ports": 3
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzMSIsImVtYWlsIjoiZW1haWwtMjI2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTl9.OI-5vwwN6P9WSntLafBO0woaa2gI6KpTl38WlHlh9eE
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/quota_definitions" -d '{
  "name": "gold_quota",
  "non_basic_services_allowed": true,
  "total_services": -1,
  "total_routes": 4,
  "memory_limit": 5120,
  "instance_memory_limit": 10240,
  "app_instance_limit": 10,
  "app_task_limit": 5,
  "total_reserved_route_ports": 3
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzMSIsImVtYWlsIjoiZW1haWwtMjI2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTl9.OI-5vwwN6P9WSntLafBO0woaa2gI6KpTl38WlHlh9eE" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "0a3df5cb-122e-4849-a6b1-abb70d1b1296",
    "url": "/v2/quota_definitions/0a3df5cb-122e-4849-a6b1-abb70d1b1296",
    "created_at": "2016-06-08T16:41:39Z",
    "updated_at": null
  },
  "entity": {
    "name": "gold_quota",
    "non_basic_services_allowed": true,
    "total_services": -1,
    "total_routes": 4,
    "total_private_domains": -1,
    "memory_limit": 5120,
    "trial_db_allowed": false,
    "instance_memory_limit": 10240,
    "app_instance_limit": 10,
    "app_task_limit": 5,
    "total_service_keys": -1,
    "total_reserved_route_ports": 3
  }
}

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/quota_definitions/0a3df5cb-122e-4849-a6b1-abb70d1b1296
X-VCAP-Request-ID: 33771965-0f77-4d44-8b06-b096e9e2a663
Content-Length: 594
X-Content-Type-Options: nosniff