Skip to content

Quota

All operations require authentication.

2 operationsv2/publicCloud/project
Agent setup

Get the project quotaProduction

GET
/v2/publicCloud/project/{projectId}/quota

Returns the project quota. When the region query parameter is set, the response narrows targetSpec.regions and currentState.regions to that single region. Omit it to get all regions.

Path parameters

projectId
required
string

Project ID

Query parameters

region
string

Optional region filter

Response

200Quotasuccessful operation
checksum
read-only
string

Computed hash representing the current target specification value

createdAt
read-only
stringdate-time

Creation date of the quota

currentState
read-only
QuotaCurrentState

Current state of the quota

currentTasks
read-only
CurrentTask[]

Ongoing asynchronous tasks related to the quota

id
read-only
string

Project ID this quota belongs to

resourceStatus
read-only
ResourceStatusEnum

Quota readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
QuotaTargetSpec

Last target specification of the quota

updatedAt
read-only
stringdate-time

Last update date of the quota

400objectError 400 response
409objectError 409 response

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/quota \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "availableProfiles": [ { "compute": { "cores": 0, "instances": 0, "memory": 0 }, "keyManager": { "containers": 0, "secrets": 0 }, "keypair": { "keypairs": 0 }, "loadbalancer": { "healthMonitors": 0, "l7Policies": 0, "l7Rules": 0, "listeners": 0, "loadbalancers": 0, "members": 0, "pools": 0 }, "name": "string", "network": { "floatingIps": 0, "gateways": 0, "networks": 0, "securityGroupRules": 0, "securityGroups": 0, "subnets": 0 }, "share": { "backupSizeTotal": 0, "backups": 0, "shares": 0, "sizeTotal": 0, "snapshots": 0 }, "volume": { "backupSizeTotal": 0, "backups": 0, "sizeTotal": 0, "snapshots": 0, "volumes": 0 } } ], "preventAutomaticQuotaUpgrade": true, "regions": [ { "location": { "availabilityZone": "string", "region": "string" }, "profile": "string", "usage": { "compute": { "cores": { "limit": null, "unit": null, "used": null }, "instances": { "limit": null, "unit": null, "used": null }, "memory": { "limit": null, "unit": null, "used": null } }, "keyManager": { "containers": { "limit": null, "unit": null, "used": null }, "secrets": { "limit": null, "unit": null, "used": null } }, "keypair": { "keypairs": { "limit": null, "unit": null, "used": null } }, "loadbalancer": { "healthMonitors": { "limit": null, "unit": null, "used": null }, "l7Policies": { "limit": null, "unit": null, "used": null }, "l7Rules": { "limit": null, "unit": null, "used": null }, "listeners": { "limit": null, "unit": null, "used": null }, "loadbalancers": { "limit": null, "unit": null, "used": null }, "members": { "limit": null, "unit": null, "used": null }, "pools": { "limit": null, "unit": null, "used": null } }, "network": { "floatingIps": { "limit": null, "unit": null, "used": null }, "gateways": { "limit": null, "unit": null, "used": null }, "networks": { "limit": null, "unit": null, "used": null }, "securityGroupRules": { "limit": null, "unit": null, "used": null }, "securityGroups": { "limit": null, "unit": null, "used": null }, "subnets": { "limit": null, "unit": null, "used": null } }, "share": { "backupSizeTotal": { "limit": null, "unit": null, "used": null }, "backups": { "limit": null, "unit": null, "used": null }, "perShareSize": { "limit": null, "unit": null }, "shareNetworks": { "limit": null, "unit": null, "used": null }, "shares": { "limit": null, "unit": null, "used": null }, "sizeTotal": { "limit": null, "unit": null, "used": null }, "snapshotSizeTotal": { "limit": null, "unit": null, "used": null }, "snapshots": { "limit": null, "unit": null, "used": null } }, "volume": { "backupSizeTotal": { "limit": null, "unit": null, "used": null }, "backups": { "limit": null, "unit": null, "used": null }, "perVolumeSize": { "limit": null, "unit": null }, "sizeTotal": { "limit": null, "unit": null, "used": null }, "snapshots": { "limit": null, "unit": null, "used": null }, "volumes": { "limit": null, "unit": null, "used": null } } } } ] }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "string", "resourceStatus": "CREATING", "targetSpec": { "preventAutomaticQuotaUpgrade": true, "regions": [ { "location": { "availabilityZone": "string", "region": "string" }, "profile": "string" } ] }, "updatedAt": "2024-01-01T12:00:00Z"}

Update the project quotaProduction

PUT
/v2/publicCloud/project/{projectId}/quota

Updates the project quota region by region. Each region listed in targetSpec.regions is added or updated, and the regions you omit are left unchanged, so raising the quota of one region does not require restating the others. Unlike the other update routes of this API, this list is merged, not replaced. preventAutomaticQuotaUpgrade is required.

Path parameters

projectId
required
string

Project ID

Request body (required)

checksum
string

Optional concurrency-control checksum. When supplied, it must match the resource's current checksum or the request is rejected with a 409 checksum-mismatch conflict. When omitted or empty, the concurrency check is skipped and the write is forced (last-write-wins).

targetSpec
required
QuotaUpdateTargetSpec

Update specification

Response

200Quotasuccessful operation
checksum
read-only
string

Computed hash representing the current target specification value

createdAt
read-only
stringdate-time

Creation date of the quota

currentState
read-only
QuotaCurrentState

Current state of the quota

currentTasks
read-only
CurrentTask[]

Ongoing asynchronous tasks related to the quota

id
read-only
string

Project ID this quota belongs to

resourceStatus
read-only
ResourceStatusEnum

Quota readiness in the system

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
QuotaTargetSpec

Last target specification of the quota

updatedAt
read-only
stringdate-time

Last update date of the quota

400objectError 400 response
409objectError 409 response

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/quota \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "availableProfiles": [ { "compute": { "cores": 0, "instances": 0, "memory": 0 }, "keyManager": { "containers": 0, "secrets": 0 }, "keypair": { "keypairs": 0 }, "loadbalancer": { "healthMonitors": 0, "l7Policies": 0, "l7Rules": 0, "listeners": 0, "loadbalancers": 0, "members": 0, "pools": 0 }, "name": "string", "network": { "floatingIps": 0, "gateways": 0, "networks": 0, "securityGroupRules": 0, "securityGroups": 0, "subnets": 0 }, "share": { "backupSizeTotal": 0, "backups": 0, "shares": 0, "sizeTotal": 0, "snapshots": 0 }, "volume": { "backupSizeTotal": 0, "backups": 0, "sizeTotal": 0, "snapshots": 0, "volumes": 0 } } ], "preventAutomaticQuotaUpgrade": true, "regions": [ { "location": { "availabilityZone": "string", "region": "string" }, "profile": "string", "usage": { "compute": { "cores": { "limit": null, "unit": null, "used": null }, "instances": { "limit": null, "unit": null, "used": null }, "memory": { "limit": null, "unit": null, "used": null } }, "keyManager": { "containers": { "limit": null, "unit": null, "used": null }, "secrets": { "limit": null, "unit": null, "used": null } }, "keypair": { "keypairs": { "limit": null, "unit": null, "used": null } }, "loadbalancer": { "healthMonitors": { "limit": null, "unit": null, "used": null }, "l7Policies": { "limit": null, "unit": null, "used": null }, "l7Rules": { "limit": null, "unit": null, "used": null }, "listeners": { "limit": null, "unit": null, "used": null }, "loadbalancers": { "limit": null, "unit": null, "used": null }, "members": { "limit": null, "unit": null, "used": null }, "pools": { "limit": null, "unit": null, "used": null } }, "network": { "floatingIps": { "limit": null, "unit": null, "used": null }, "gateways": { "limit": null, "unit": null, "used": null }, "networks": { "limit": null, "unit": null, "used": null }, "securityGroupRules": { "limit": null, "unit": null, "used": null }, "securityGroups": { "limit": null, "unit": null, "used": null }, "subnets": { "limit": null, "unit": null, "used": null } }, "share": { "backupSizeTotal": { "limit": null, "unit": null, "used": null }, "backups": { "limit": null, "unit": null, "used": null }, "perShareSize": { "limit": null, "unit": null }, "shareNetworks": { "limit": null, "unit": null, "used": null }, "shares": { "limit": null, "unit": null, "used": null }, "sizeTotal": { "limit": null, "unit": null, "used": null }, "snapshotSizeTotal": { "limit": null, "unit": null, "used": null }, "snapshots": { "limit": null, "unit": null, "used": null } }, "volume": { "backupSizeTotal": { "limit": null, "unit": null, "used": null }, "backups": { "limit": null, "unit": null, "used": null }, "perVolumeSize": { "limit": null, "unit": null }, "sizeTotal": { "limit": null, "unit": null, "used": null }, "snapshots": { "limit": null, "unit": null, "used": null }, "volumes": { "limit": null, "unit": null, "used": null } } } } ] }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "string", "resourceStatus": "CREATING", "targetSpec": { "preventAutomaticQuotaUpgrade": true, "regions": [ { "location": { "availabilityZone": "string", "region": "string" }, "profile": "string" } ] }, "updatedAt": "2024-01-01T12:00:00Z"}