API by area

Projects, quotas and regions

43 endpoints. Paths are relative to https://api.sandscale.dev; values in braces are ones you fill in.

API reference · Authentication · Errors

MethodPathWhat it does
GET/api/v1/compute/capabilitiesList capabilities
GET/api/v1/orgs/{orgID}/quota-templatesList the quota templates of an org
GET/api/v1/orgs/{orgID}/quota-templates/{name}Get one quota template
POST/api/v1/orgs/{orgID}/quota-templates/{tier}Act on one quota template
GET/api/v1/orgs/{orgID}/quotasList the quotas of an org
POST/api/v1/orgs/{orgID}/quotasCreate a quota for an org
GET/api/v1/orgs/{orgID}/quotas/{quotaID}Get one quota
PUT/api/v1/orgs/{orgID}/quotas/{quotaID}Replace one quota
DELETE/api/v1/orgs/{orgID}/quotas/{quotaID}Delete one quota
GET/api/v1/orgs/{orgID}/quotas/{quotaID}/forecastForecast of a quota
GET/api/v1/orgs/{orgID}/quotas/{quotaID}/usageUsage of a quota
GET/api/v1/orgs/{orgID}/quotas/alertsList alerts
POST/api/v1/orgs/{orgID}/quotas/alerts/{alertID}/acknowledgeAcknowledge an alert
POST/api/v1/orgs/{orgID}/quotas/checkCreate a check
GET/api/v1/orgs/{orgID}/quotas/poolsList pools
POST/api/v1/orgs/{orgID}/quotas/poolsCreate a pool
GET/api/v1/orgs/{orgID}/quotas/reportList report
GET/api/v1/orgs/{orgID}/quotas/requestsList requests
POST/api/v1/orgs/{orgID}/quotas/requestsCreate a request
POST/api/v1/orgs/{orgID}/quotas/requests/{requestID}/approveApprove a request
POST/api/v1/orgs/{orgID}/quotas/requests/{requestID}/rejectReject a request
GET/api/v1/projectsList projects
POST/api/v1/projectsCreate a project
GET/api/v1/projects/{id}Get one project
PATCH/api/v1/projects/{id}Update one project
GET/api/v1/projects/{id}/activityAnswers the project's activity over the last days days (1 to 365, default 30): the people, devices, apps and tools, models and repositories active in it, with counts of what was done and decided. Counts only: no command, path, file name or content.
POST/api/v1/projects/{id}/archiveArchive a project
GET/api/v1/projects/{id}/governance-mapAnswers every control that applies to the project:
GET/api/v1/projects/{id}/membersList the members of a project
POST/api/v1/projects/{id}/membersCreate a member for a project
DELETE/api/v1/projects/{id}/members/{userID}Delete one member
GET/api/v1/projects/{id}/policiesList the policies of a project
POST/api/v1/projects/{id}/policiesCreate a policy for a project
POST/api/v1/projects/{id}/repositoriesBinds a repository to the project: {"repository": "<address or key>"}.
GET/api/v1/projects/{id}/resourcesAnswers the resources linked to a project or sub-project, by kind: the ones whose home is the node and the ones of the projects above it shared to their subtree, which its members use.
GET/api/v1/projects/{id}/runsAnswers a page of the project's runs, newest first:
GET/api/v1/projects/{id}/vault-pathsLists the Vault path bindings of a project (brief 22, gap 269):
POST/api/v1/projects/{id}/vault-pathsBinds a path prefix of a Vault mount to a project or sub-project; the secrets under it become the project's resources:
DELETE/api/v1/projects/{id}/vault-paths/{pathID}Removes a Vault path binding of the project; the secrets under it become account-level:
GET/api/v1/projects/repository-sightingsLists the repositories the organization's devices were seen working in: those no project binds, or every one with all=true.
POST/api/v1/projects/repository-sightings/projectCreates a project for a sighted repository: {"repository", "parent_id"?}.
POST/api/v1/regions/{region}/assertionAssertion a region
GET/api/v1/regions/accessThe region list decided for the caller. On the global plane each live region is allowed or not by the account's opt status and policies, with the reason and the policy's name; on a regional cell, and while region sign-in is not configured, it is the list every caller gets (the global plane decides again when the region is opened).

Endpoints

GET /api/v1/compute/capabilities

List capabilities

Permission
api:access
Response
200: object of any
Errors
400: invalid_org_id; 401: unauthorized

GET /api/v1/orgs/{orgID}/quota-templates

List the quota templates of an org

Permission
api:access
Path parameters
orgID
Response
200: QuotaTemplate

GET /api/v1/orgs/{orgID}/quota-templates/{name}

Get one quota template

Permission
api:access
Path parameters
orgID, name
Response
200: QuotaTemplate

POST /api/v1/orgs/{orgID}/quota-templates/{tier}

Act on one quota template

Permission
quotas:manage
Path parameters
orgID, tier
Response
201: object of any
Errors
400: validation_error; 401: unauthorized; 403: self_approval; 404: not_found; 409: conflict; 503: unavailable

GET /api/v1/orgs/{orgID}/quotas

List the quotas of an org

Permission
api:access
Path parameters
orgID
Query parameters
active_only, resource_type, scope, user_id
Response
200: ResourceQuota

POST /api/v1/orgs/{orgID}/quotas

Create a quota for an org

Permission
quotas:manage
Path parameters
orgID
Request body
createQuotaRequest
Response
201: ResourceQuota
Errors
400: validation_error; 401: unauthorized; 403: self_approval; 404: not_found; 409: conflict; 503: unavailable

GET /api/v1/orgs/{orgID}/quotas/{quotaID}

Get one quota

Permission
api:access
Path parameters
orgID, quotaID
Response
200: ResourceQuota

PUT /api/v1/orgs/{orgID}/quotas/{quotaID}

Replace one quota

Permission
quotas:manage
Path parameters
orgID, quotaID
Request body
updateQuotaRequest
Response
200: ResourceQuota
Errors
400: validation_error; 403: self_approval; 404: not_found; 409: conflict; 503: unavailable

DELETE /api/v1/orgs/{orgID}/quotas/{quotaID}

Delete one quota

Permission
quotas:manage
Path parameters
orgID, quotaID
Errors
400: validation_error; 403: self_approval; 404: not_found; 409: conflict; 503: unavailable

GET /api/v1/orgs/{orgID}/quotas/{quotaID}/forecast

Forecast of a quota

Permission
api:access
Path parameters
orgID, quotaID
Query parameters
lookback_days
Response
200: ForecastResult

GET /api/v1/orgs/{orgID}/quotas/{quotaID}/usage

Usage of a quota

Permission
api:access
Path parameters
orgID, quotaID
Response
200: QuotaUsage

GET /api/v1/orgs/{orgID}/quotas/alerts

List alerts

Permission
api:access
Path parameters
orgID
Query parameters
unacked_only
Response
200: QuotaAlert

POST /api/v1/orgs/{orgID}/quotas/alerts/{alertID}/acknowledge

Acknowledge an alert

Permission
quotas:manage
Path parameters
orgID, alertID
Errors
400: validation_error; 401: unauthorized; 403: self_approval; 404: not_found; 409: conflict; 503: unavailable

POST /api/v1/orgs/{orgID}/quotas/check

Create a check

Permission
api:access
Path parameters
orgID
Request body
checkQuotaRequest
Response
200: QuotaCheck

GET /api/v1/orgs/{orgID}/quotas/pools

List pools

Permission
api:access
Path parameters
orgID
Response
200: QuotaPool

POST /api/v1/orgs/{orgID}/quotas/pools

Create a pool

Permission
quotas:manage
Path parameters
orgID
Request body
createPoolRequest
Response
201: QuotaPool
Errors
400: validation_error; 401: unauthorized; 403: self_approval; 404: not_found; 409: conflict; 503: unavailable

GET /api/v1/orgs/{orgID}/quotas/report

List report

Permission
billing:read
Path parameters
orgID
Response
200: UsageReport

GET /api/v1/orgs/{orgID}/quotas/requests

List requests

Permission
api:access
Path parameters
orgID
Query parameters
status
Response
200: QuotaRequest

POST /api/v1/orgs/{orgID}/quotas/requests

Create a request

Permission
api:access
Path parameters
orgID
Request body
requestIncreaseRequest
Response
201: QuotaRequest
Errors
400: validation_error; 401: unauthorized; 403: self_approval; 404: not_found; 409: conflict; 503: unavailable

POST /api/v1/orgs/{orgID}/quotas/requests/{requestID}/approve

Approve a request

Permission
quotas:manage
Path parameters
orgID, requestID
Request body
approveRejectRequest
Errors
400: invalid_body, validation_error; 401: unauthorized; 403: self_approval; 404: not_found; 409: conflict; 503: unavailable

POST /api/v1/orgs/{orgID}/quotas/requests/{requestID}/reject

Reject a request

Permission
quotas:manage
Path parameters
orgID, requestID
Request body
approveRejectRequest
Errors
400: invalid_body, validation_error; 401: unauthorized; 403: self_approval; 404: not_found; 409: conflict; 503: unavailable

GET /api/v1/projects

List projects

Permission
projects:use
Query parameters
status
Response
200: object of any
Errors
401: unauthorized; 403: forbidden; 503: authorization_unavailable, unavailable

POST /api/v1/projects

Create a project

Permission
directory.nodes:create
Request body
object
Response
201: object of any
Errors
400: invalid_json, validation_error; 401: unauthorized; 403: forbidden; 409: conflict; 415: content_type; 503: unavailable

GET /api/v1/projects/{id}

Get one project

Permission
directory.nodes:read
Path parameters
id
Response
200: object of any
Errors
400: validation_error; 401: unauthorized; 403: forbidden; 404: not_found; 503: unavailable

PATCH /api/v1/projects/{id}

Update one project

Permission
directory.nodes:update
Path parameters
id
Request body
object of any
Response
200: object of any
Errors
400: invalid_json, validation_error; 401: unauthorized; 403: forbidden; 404: not_found; 415: content_type; 503: unavailable

GET /api/v1/projects/{id}/activity

Answers the project's activity over the last days days (1 to 365, default 30): the people, devices, apps and tools, models and repositories active in it, with counts of what was done and decided. Counts only: no command, path, file name or content.

Permission
projects.runs:read
Path parameters
id
Response
200: Activity
Errors
400: invalid_query, project_mismatch; 401: unauthorized; 403: not_project_member; 404: project_not_found; 409: project_inactive

POST /api/v1/projects/{id}/archive

Archive a project

Permission
directory.nodes:archive
Path parameters
id
Response
200: object of any
Errors
400: validation_error; 401: unauthorized; 403: forbidden; 404: not_found; 503: unavailable

GET /api/v1/projects/{id}/governance-map

Answers every control that applies to the project:

Permission
projects.governance:read
Path parameters
id
Response
200: GovernanceMap
Errors
400: project_mismatch; 401: unauthorized; 403: not_project_member; 404: project_not_found; 409: project_inactive

GET /api/v1/projects/{id}/members

List the members of a project

Permission
directory.members:read
Path parameters
id
Response
200: object of any
Errors
400: validation_error; 401: unauthorized; 403: forbidden; 404: not_found; 503: unavailable

POST /api/v1/projects/{id}/members

Create a member for a project

Permission
directory.members:manage
Path parameters
id
Request body
object
Response
200: object of any
Errors
400: invalid_json, validation_error; 401: unauthorized; 403: forbidden; 404: not_found; 415: content_type; 503: unavailable

DELETE /api/v1/projects/{id}/members/{userID}

Delete one member

Permission
directory.members:manage
Path parameters
id, userID
Response
200: object of any
Errors
400: validation_error; 401: unauthorized; 403: forbidden; 404: not_found; 503: unavailable

GET /api/v1/projects/{id}/policies

List the policies of a project

Permission
policies.governance:use
Path parameters
id
Response
200: object of any
Errors
400: validation_error; 401: unauthorized; 403: forbidden; 404: not_found; 503: unavailable

POST /api/v1/projects/{id}/policies

Create a policy for a project

Permission
projects:policy
Path parameters
id
Request body
object
Response
200: object of any
Errors
400: invalid_json, unsupported_policy_type, validation_error; 401: unauthorized; 403: forbidden; 404: not_found; 415: content_type; 503: unavailable

POST /api/v1/projects/{id}/repositories

Binds a repository to the project: {"repository": "<address or key>"}.

Permission
directory.nodes:update
Path parameters
id
Request body
object
Response
200: object of any
Errors
400: invalid_json, project_mismatch; 401: unauthorized; 403: not_project_member; 404: project_not_found, repository_not_sighted; 409: project_inactive, repository_linked; 415: content_type; 422: invalid_repository

GET /api/v1/projects/{id}/resources

Answers the resources linked to a project or sub-project, by kind: the ones whose home is the node and the ones of the projects above it shared to their subtree, which its members use.

Permission
projects:read
Path parameters
id
Response
200: ProjectResources
Errors
400: project_mismatch; 401: unauthorized; 403: not_project_member; 404: project_not_found; 409: project_inactive

GET /api/v1/projects/{id}/runs

Answers a page of the project's runs, newest first:

Permission
projects.runs:read
Path parameters
id
Query parameters
cursor
Response
200: RunsPage
Errors
400: invalid_query, project_mismatch; 401: unauthorized; 403: not_project_member; 404: project_not_found; 409: project_inactive

GET /api/v1/projects/{id}/vault-paths

Lists the Vault path bindings of a project (brief 22, gap 269):

Permission
projects:read
Path parameters
id
Response
200: object of any
Errors
400: project_mismatch; 401: unauthorized; 403: not_project_member; 404: project_not_found; 409: project_inactive; 503: authorization_unavailable

POST /api/v1/projects/{id}/vault-paths

Binds a path prefix of a Vault mount to a project or sub-project; the secrets under it become the project's resources:

Permission
projects:manage
Path parameters
id
Request body
VaultPathInput
Response
201: object of any
Errors
400: invalid_json, project_mismatch, validation_error; 401: unauthorized; 403: forbidden, not_project_member; 404: not_found, project_not_found; 409: path_taken, project_inactive; 415: content_type; 503: unavailable

DELETE /api/v1/projects/{id}/vault-paths/{pathID}

Removes a Vault path binding of the project; the secrets under it become account-level:

Permission
projects:manage
Path parameters
id, pathID
Errors
400: project_mismatch, validation_error; 401: unauthorized; 403: forbidden, not_project_member; 404: not_found, project_not_found; 409: path_taken, project_inactive; 503: unavailable

GET /api/v1/projects/repository-sightings

Lists the repositories the organization's devices were seen working in: those no project binds, or every one with all=true.

Permission
directory.nodes:update
Query parameters
all
Response
200: SightingsPage
Errors
400: invalid_query; 401: unauthorized

POST /api/v1/projects/repository-sightings/project

Creates a project for a sighted repository: {"repository", "parent_id"?}.

Permission
directory.nodes:create
Request body
object
Response
201: object of any
Errors
400: invalid_json, project_mismatch; 401: unauthorized; 403: not_project_member; 404: project_not_found, repository_not_sighted; 409: project_inactive, repository_linked; 415: content_type; 422: invalid_repository

POST /api/v1/regions/{region}/assertion

Assertion a region

Permission
signed in
Path parameters
region
Request body
assertionRequest
Response
200: Issued

GET /api/v1/regions/access

The region list decided for the caller. On the global plane each live region is allowed or not by the account's opt status and policies, with the reason and the policy's name; on a regional cell, and while region sign-in is not configured, it is the list every caller gets (the global plane decides again when the region is opened).

Permission
signed in
Response
200: RegionList

Objects

object

FieldTypeDescription
entriesinteger
peopleinteger

object

FieldTypeDescription
totalinteger
owninteger
inheritedinteger
unknowninteger

object

FieldTypeDescription
namestring
slugstring
descriptionstring
classificationstring
compliance_frameworksarray of string
owner_teamstring
budget_usd optionalnumber

object

FieldTypeDescription
repositorystring
parent_idstring

object

FieldTypeDescription
user_idstring
rolestring

object

FieldTypeDescription
policy_typestring
configobject of any
modestring
enabled optionalboolean

object

FieldTypeDescription
repositorystring

GlobalPlane

Where sign-in happens: the global plane's cell and its public URLs.

FieldTypeDescription
idstring
console_urlstring
api_urlstring

ListedRegion

One region of the region list.

FieldTypeDescription
idstring
display_namestring
short_namestringShortName ("N. Virginia") is what the top bar's region button shows; FullName ("US East (N. Virginia)") names the region in the region menu.
full_namestring
citystring
countrystring
country_codestring
jurisdictionstring
aws_regionstring
hostnamestringThe region's console host: the host the region's cell publishes when it is known, else the planned production host.
console_urlstringConsoleURL and APIURL are set only for a region whose cell answered.
api_urlstring
sign_instringHow a person opens the region: "global" with the global plane's sign-in (a region assertion), "separate" for a sovereign cell, which keeps its own identity: the person signs in there with their login of that region.
statusstring
currentboolean
recommendedboolean
opt_inboolean
switchSwitchAnswer

RegionList

FieldTypeDescription
global optionalGlobalPlaneThe global plane, nil for a self-hosted installation or while a regional cell's global plane is not live.
currentstring
recommendedstring
recommended_bystring
regionsarray of ListedRegion
servicesServicesServices says which services are global and where the global plane serves them.

Services

The region list's answer about global and regional services. A regional cell's console opens the global services' pages on the global plane's console; the global plane's console shows them as Global in the region picker. Sandscale decides it; the console renders it.

FieldTypeDescription
planestringThis cell's plane: global or regional.
global_api_urlstringGlobalAPIURL and GlobalConsoleURL are the global plane's URLs; GlobalConsoleURL is "" while a regional cell does not know the global plane's console (not configured and the global plane not live), and its console then cannot open the global services.
global_console_urlstring
global_servicesarray of stringThe console services that are global, by catalog ID.
global_console_pathsarray of stringThe console paths (relative to the account base, each covering the paths below it) that the global plane serves.

SwitchAnswer

SwitchAnswer says whether the region picker may open the region, and where.

FieldTypeDescription
allowedboolean
reason optionalstring
url optionalstring
message optionalstringMessage says why, in words, when Sandscale decided it for a caller (the policy that blocks the region).
policy optionalSwitchPolicyPolicy names the policy that blocks the region.

SwitchPolicy

SwitchPolicy names the policy that blocks a region.

FieldTypeDescription
kindstring
id optionalstring
namestring

Actions

Actions summarizes what was done: counts only, never the commands, paths or content.

FieldTypeDescription
eventsinteger
commandsinteger
file_changesinteger
file_readsinteger
tool_callsinteger
networkinteger
processesinteger
mcp_callsinteger
model_requestsinteger
input_tokensinteger
output_tokensinteger
cost_usdnumber
decisionsDecisions

Activity

The project's activity over a window.

FieldTypeDescription
project_idstring
daysinteger
fromtimestamp
totimestamp
summaryActions
peoplearray of Person
devicesarray of Device
appsarray of AppUsage
modelsarray of ModelUsage
repositoriesarray of RepoActivity
linked_repositoriesarray of stringRepository keys of the project (Directory bindings), so the console can say what is linked.
unattributedobjectEntries in the project's repositories by people who cannot access the project: counted, not shown.
generated_attimestamp

AppUsage

An app or tool that worked in the project.

FieldTypeDescription
idstring
labelstring
kindstring
sourcesarray of stringWhere its activity was reported: endpoint_agent, agent_policy, gateway.
governedstring
peoplearray of string
devicesarray of string
sessionsinteger
first_seentimestamp
last_seentimestamp
actionsActions

Decisions

Decisions counts policy decisions by outcome.

FieldTypeDescription
allowinteger
denyinteger
askinteger

Device

An enrolled device active in the project.

FieldTypeDescription
device_idstring
namestring
platformstring
user_idstring
appsarray of string
first_seentimestamp
last_seentimestamp
actionsActions

ModelUsage

A model used for the project through the gateway or the IDE suite.

FieldTypeDescription
providerstring
modelstring
requestsinteger
input_tokensinteger
output_tokensinteger
cost_usdnumber

Person

Someone active in the project.

FieldTypeDescription
user_idstring
display_namestring
emailstring
devicesinteger
appsarray of string
sessionsinteger
first_seentimestamp
last_seentimestamp
actionsActions

RepoActivity

A repository of the project work was seen in.

FieldTypeDescription
repo_keystring
eventsinteger
last_seentimestamp

Sighting

A repository devices of the organization were seen working in.

FieldTypeDescription
repo_keystring
devicesinteger
peopleinteger
entriesinteger
first_seentimestamp
last_seentimestamp
project optionalSightingProjectThe project that binds the repository, when one does.
sourcesarray of stringSources: endpoint_agent (an agent's entries), agent_policy (decisions reported for it).

SightingProject

The project a sighted repository is linked to.

FieldTypeDescription
idstring
namestring

SightingsPage

FieldTypeDescription
repositoriesarray of Sighting
daysinteger
generated_attimestamp

Control

One policy, rule, assignment or binding that applies to the project.

FieldTypeDescription
idstring"<kind>:<id of the row>", stable across calls.
servicestring
controlstringThe kind of control (model_assignment, project_rules, ...).
namestringName says what it is, for people.
sourceScope
statestring
enforced_bystring
detailobject of any

GovernanceMap

Every control that applies to a project.

FieldTypeDescription
projectProjectSummary
generated_attimestamp
summaryobject of integerSummary counts the controls by state, over the sections that answered.
servicesarray of Section

ProjectResources

FieldTypeDescription
projectProject
chainarray of ChainNode
kindsarray of KindResources
summaryobjectSummary counts the resources listed (Total = Own + Inherited) and the kinds that could not be read.
generated_attimestamp

ProjectSummary

ProjectSummary identifies the project of a map.

FieldTypeDescription
idstring
org_idstring
namestring
pathstring
statestring
suspendedboolean
classificationstring
compliance_frameworksarray of string
repositoriesarray of string
ancestorsarray of Scope

Run

One entry of a project's runs.

FieldTypeDescription
kindstring
idstring
titlestringTitle says what ran, for people (the agent, the workspace, the image, the repository).
statusstring
user_id optionalstring
started_attimestamp
ended_at optionaltimestamp
detailobject of anyDetail holds the kind's own fields; a CI run carries its "checks" and "gates" here.

RunsPage

A page of runs, newest first.

FieldTypeDescription
runsarray of Run
next_cursor optionalstring

Scope

Where a control is set: the account (organization), a node above the project (business unit, service, team) or the project itself.

FieldTypeDescription
kindstring
idstring
namestring

Section

The controls of one service. Status is "unknown" when the service could not be read: its controls are then missing, never assumed (fail closed).

FieldTypeDescription
servicestring
statusstring
reason optionalstring
controlsarray of Control

VaultPathInput

VaultPathInput binds a prefix.

FieldTypeDescription
mountstring
path_prefixstring
share_scopestringProject (the default for vault paths) or subtree.

ChainNode

One node of a project chain.

FieldTypeDescription
idstring
kindstring
namestring
pathstring
statestring

Home

The node a resource belongs to.

FieldTypeDescription
idstring
kindstring
namestring

KindResources

The resources of one kind.

FieldTypeDescription
typestringThe kind's name in the API (the access control resource type where the kind is shared one object at a time).
labelstring
default_share_scopestring
fixed_share_scopeboolean
statusstringOk, or unknown when the kind's resources could not be read (Reason says so); an unknown kind never lists an empty set.
reason optionalstring
resourcesarray of Resource

Node

An ancestor of a project.

FieldTypeDescription
idstring
kindstring
namestring

Project

A project or sub-project node with what other services need to scope by it. A sub-project takes its suspension, owner team, classification and compliance frameworks from its project.

FieldTypeDescription
idstring
org_idstring
kindstringProject or sub_project.
root_idstringThe project at the top of the node's project tree: the node itself for a project.
namestring
slugstring
pathstring
parent_idstring
statestring
suspendedboolean
owner_team_id optionalstring
classificationstringThe project's own classification (projects.classification).
compliance_frameworksarray of string
ancestorsarray of NodeThe node's ancestors, nearest first; the last is the organization node.
repositoriesarray of stringThe repository identifiers bound to the project (directory_project_repositories), sorted.

Resource

A resource linked to a project.

FieldTypeDescription
idstring
namestring
share_scopestring
homeHome
inheritedbooleanTrue for a resource of a node above the project, shared to its subtree: the project's members use it, its home manages it.

ForecastResult

ForecastResult predicts when a quota will be exhausted.

FieldTypeDescription
quota_iduuid
resource_typestring
current_usageinteger
limitinteger
daily_growth_ratenumberTrend analysis
weekly_growth_ratenumber
monthly_growth_ratenumber
days_until_exhaustion optionalintegerPredictions
estimated_exhaustion_at optionaltimestamp
confidencenumber0.0 - 1.0
recommendation optionalstring

QuotaAlert

QuotaAlert represents an alert triggered by quota usage.

FieldTypeDescription
iduuid
org_iduuid
quota_iduuid
trigger_typestring
threshold_percent optionalinteger
forecast_days optionalinteger
severitystring
messagestring
details optionalobject of any
notification_sentboolean
notification_sent_at optionaltimestamp
notification_recipients optionalarray of uuid
acknowledgedboolean
acknowledged_by optionaluuid
acknowledged_at optionaltimestamp
created_attimestamp

QuotaCheck

The result of checking if an action is allowed.

FieldTypeDescription
allowedboolean
reason optionalstring
quota_id optionaluuid
resource_typestring
current_usageinteger
limitinteger
requestedinteger
availableinteger
is_warningboolean
is_burstableboolean
would_burstboolean

QuotaPool

QuotaPool represents shared quotas across teams.

FieldTypeDescription
iduuid
org_iduuid
namestring
description optionalstring
resource_typestring
total_quotainteger
allocation_strategystring
member_projects optionalarray of uuid
member_weights optionalobject of integer
allocated_quotainteger
available_quotainteger
is_activeboolean
created_attimestamp
updated_attimestamp
created_by optionaluuid

QuotaRequest

QuotaRequest represents a request to increase a quota.

FieldTypeDescription
iduuid
org_iduuid
quota_iduuid
requested_byuuid
resource_typestring
current_limitinteger
requested_limitinteger
justificationstring
business_case optionalstring
urgencystring
statusstring
reviewed_by optionaluuidReview
reviewed_at optionaltimestamp
review_notes optionalstring
auto_approvedbooleanAuto-approval
auto_approval_reason optionalstring
expires_at optionaltimestamp
created_attimestamp
updated_attimestamp

QuotaTemplate

QuotaTemplate defines a pre-configured set of quotas for a tier.

FieldTypeDescription
iduuid
namestring
display_namestring
description optionalstring
tierstring
order_indexinteger
quotasarray of QuotaTemplateSpec
monthly_price optionalnumber
currencystring
is_activeboolean
is_defaultboolean
is_publicboolean
features optionalarray of string
tags optionalobject of string
created_attimestamp
updated_attimestamp

QuotaTemplateSpec

QuotaTemplateSpec defines a quota within a template.

FieldTypeDescription
resource_typestring
limitinteger
limit_typestring
burst_limit optionalinteger

QuotaUsage

QuotaUsage tracks current usage of a quota.

FieldTypeDescription
iduuid
quota_iduuid
org_iduuid
current_usageinteger
peak_usageinteger
is_burstingbooleanBurst tracking
burst_started_at optionaltimestamp
burst_countinteger
last_burst_at optionaltimestamp
window_start optionaltimestampTime windows for rate limits
window_usageinteger
daily_peakintegerHistorical peaks
weekly_peakinteger
monthly_peakinteger
last_updatedtimestamp
peak_reached_at optionaltimestamp

QuotaWithUsage

QuotaWithUsage combines quota definition with current usage.

FieldTypeDescription
quotaResourceQuota
usageQuotaUsage
utilization_percentnumber
is_overageboolean
is_warningboolean

ResourceQuota

ResourceQuota represents a quota for a specific resource.

FieldTypeDescription
iduuid
org_iduuid
scopestring
user_id optionaluuid
project_id optionaluuid
resource_typestring
limit_typestring
limit_valueintegerLimits
warning_threshold optionalinteger
burst_limit optionalintegerBurst configuration
burst_duration optionalinteger object
burst_cooldown optionalinteger object
grace_period optionalinteger objectGrace period
grace_expiry optionaltimestamp
auto_scale_enabledbooleanAuto-scaling
auto_scale_trigger_percent optionalinteger
auto_scale_increment optionalinteger
auto_scale_max optionalinteger
description optionalstringMetadata
tags optionalobject of string
custom_metadata optionalobject of any
is_activeboolean
created_attimestamp
updated_attimestamp
created_by optionaluuid

UsageReport

UsageReport provides a summary of quota utilization.

FieldTypeDescription
org_iduuid
quotasarray of QuotaWithUsage
generated_attimestamp

Issued

An assertion with where to use it.

FieldTypeDescription
assertionstring
expires_attimestamp
regionstring
console_urlstring
exchange_urlstring

approveRejectRequest

FieldTypeDescription
notes optionalstring

assertionRequest

FieldTypeDescription
clientstring
noncestring

checkQuotaRequest

FieldTypeDescription
user_id optionalstring
project_id optionalstring
resource_typestring
amountinteger

createPoolRequest

FieldTypeDescription
namestring
description optionalstring
resource_typestring
total_quotainteger

createQuotaRequest

FieldTypeDescription
scopestring
user_id optionalstring
project_id optionalstring
resource_typestring
limit_typestring
limit_valueinteger
warning_threshold optionalinteger
burst_limit optionalinteger
auto_scale_enabledboolean
auto_scale_trigger_percent optionalinteger
auto_scale_increment optionalinteger
auto_scale_max optionalinteger
description optionalstring
tags optionalobject of string

requestIncreaseRequest

FieldTypeDescription
quota_idstring
requested_limitinteger
justificationstring
business_case optionalstring
urgencystring

updateQuotaRequest

FieldTypeDescription
limit_value optionalinteger
warning_threshold optionalinteger
burst_limit optionalinteger
auto_scale_enabled optionalboolean
auto_scale_trigger_percent optionalinteger
auto_scale_increment optionalinteger
auto_scale_max optionalinteger
description optionalstring
tags optionalobject of string
is_active optionalboolean

This page is generated from the server's route table and the Go handlers that serve each route. Do not edit it by hand.