UNunkeyed
workspace

Get workspace limits

Changed on

Get every limit of your workspace, with the current value against each limit that has one.

Use this before an operation that a limit can reject, for example to see how many custom domains or log drains remain, or how much CPU, memory, and disk a new deployment can still reserve.

The request takes no parameters. Each limit has a limit, which is null when unlimited, and a current value when the limit has one. Billable operations count the current calendar month in UTC. The Compute limits are present only when the workspace has a Compute plan.

Required Permissions

Your root key must have the following permission:

  • unkey:v1:<workspace_id>:limits#read
post/v2/workspace.getLimits

Request

  • Base URL
    https://api.unkey.com
  • URL
    https://api.unkey.com/v2/workspace.getLimits
  • Auth
    HTTP bearer

Response

The workspace limits and the current values against them.

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "apiBillableOperationsCountMaxPerMonth": {
      "limit": 5,
      "current": 1
    },
    "apiRequestsCountMaxPerMinute": {
      "limit": 5,
      "current": 1
    },
    "logsRetentionDaysMax": {
      "limit": 5,
      "current": 1
    },
    "logsAuditRetentionDaysMax": {
      "limit": 5,
      "current": 1
    },
    "logdrainsMax": {
      "limit": 5,
      "current": 1
    },
    "cpuCoresMax": {
      "limit": 5,
      "current": 1
    },
    "cpuCoresMaxPerInstance": {
      "limit": 5,
      "current": 1
    },
    "memoryMibMax": {
      "limit": 5,
      "current": 1
    },
    "memoryMibMaxPerInstance": {
      "limit": 5,
      "current": 1
    },
    "storageMibMax": {
      "limit": 5,
      "current": 1
    },
    "storageMibMaxPerInstance": {
      "limit": 5,
      "current": 1
    },
    "buildsConcurrentMax": {
      "limit": 5,
      "current": 1
    },
    "autoscalingReplicasMax": {
      "limit": 5,
      "current": 1
    },
    "customDomainsMax": {
      "limit": 5,
      "current": 1
    }
  }
}

Changes