XAxataio
Projects

Get project resource limits

Changed on

Retrieves the effective resource limits for the specified project, merging organization-level overrides with any project-specific overrides.

get/organizations/{organizationID}/projects/{projectID}/limits

Request

  • Base URL
    https://api.xata.tech
  • Auth
    OAuth 2
    Implicit: https://auth.xata.io/realms/xata/protocol/openid-connect/auth
    Scopes: project:read

Path parameters

organizationIDstring required

Unique identifier of the organization

projectIDstring required

Unique identifier of the project to get limits for

Response

Effective resource limits for the project

maxDescriptionLengthinteger required

Maximum character length allowed for branch descriptions

maxBranchesPerProjectinteger required

Maximum number of branches allowed per project

maxInstancesPerBranchinteger required

Maximum number of database instances allowed per branch

minInstancesPerBranchinteger required

Minimum number of database instances required per branch

maxAllowedInstanceTypeinteger required

Maximum VCPUs (in millicores) allowed per instance; instance types with a higher VCPUsRequest are unavailable

maxBranchesPerHourinteger required

Maximum number of branches that can be created in a rolling one-hour window

maxStorageGBPerBranchinteger required

Maximum storage in GiB (gigabytes) allowed per branch; 0 means no limit

Changes

  • 13e8257b7933Revision changes
    • info

      added the required property to the response with the status

  • 4f62c0eb12c5Revision changes
    • breaking

      the response's property type changed from string to integer for status

    • breaking

      removed the required property from the response with the status