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
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/compute/capabilities | List capabilities |
GET | /api/v1/orgs/{orgID}/quota-templates | List 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}/quotas | List the quotas of an org |
POST | /api/v1/orgs/{orgID}/quotas | Create 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}/forecast | Forecast of a quota |
GET | /api/v1/orgs/{orgID}/quotas/{quotaID}/usage | Usage of a quota |
GET | /api/v1/orgs/{orgID}/quotas/alerts | List alerts |
POST | /api/v1/orgs/{orgID}/quotas/alerts/{alertID}/acknowledge | Acknowledge an alert |
POST | /api/v1/orgs/{orgID}/quotas/check | Create a check |
GET | /api/v1/orgs/{orgID}/quotas/pools | List pools |
POST | /api/v1/orgs/{orgID}/quotas/pools | Create a pool |
GET | /api/v1/orgs/{orgID}/quotas/report | List report |
GET | /api/v1/orgs/{orgID}/quotas/requests | List requests |
POST | /api/v1/orgs/{orgID}/quotas/requests | Create a request |
POST | /api/v1/orgs/{orgID}/quotas/requests/{requestID}/approve | Approve a request |
POST | /api/v1/orgs/{orgID}/quotas/requests/{requestID}/reject | Reject a request |
GET | /api/v1/projects | List projects |
POST | /api/v1/projects | Create a project |
GET | /api/v1/projects/{id} | Get one project |
PATCH | /api/v1/projects/{id} | Update one project |
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. |
POST | /api/v1/projects/{id}/archive | Archive a project |
GET | /api/v1/projects/{id}/governance-map | Answers every control that applies to the project: |
GET | /api/v1/projects/{id}/members | List the members of a project |
POST | /api/v1/projects/{id}/members | Create a member for a project |
DELETE | /api/v1/projects/{id}/members/{userID} | Delete one member |
GET | /api/v1/projects/{id}/policies | List the policies of a project |
POST | /api/v1/projects/{id}/policies | Create a policy for a project |
POST | /api/v1/projects/{id}/repositories | Binds a repository to the project: {"repository": "<address or key>"}. |
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. |
GET | /api/v1/projects/{id}/runs | Answers a page of the project's runs, newest first: |
GET | /api/v1/projects/{id}/vault-paths | Lists the Vault path bindings of a project (brief 22, gap 269): |
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: |
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-sightings | Lists 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/project | Creates a project for a sighted repository: {"repository", "parent_id"?}. |
POST | /api/v1/regions/{region}/assertion | Assertion a region |
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). |
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
| Field | Type | Description |
|---|---|---|
entries | integer | |
people | integer |
object
| Field | Type | Description |
|---|---|---|
total | integer | |
own | integer | |
inherited | integer | |
unknown | integer |
object
| Field | Type | Description |
|---|---|---|
name | string | |
slug | string | |
description | string | |
classification | string | |
compliance_frameworks | array of string | |
owner_team | string | |
budget_usd optional | number |
object
| Field | Type | Description |
|---|---|---|
repository | string | |
parent_id | string |
object
| Field | Type | Description |
|---|---|---|
user_id | string | |
role | string |
object
| Field | Type | Description |
|---|---|---|
policy_type | string | |
config | object of any | |
mode | string | |
enabled optional | boolean |
object
| Field | Type | Description |
|---|---|---|
repository | string |
GlobalPlane
Where sign-in happens: the global plane's cell and its public URLs.
| Field | Type | Description |
|---|---|---|
id | string | |
console_url | string | |
api_url | string |
ListedRegion
One region of the region list.
| Field | Type | Description |
|---|---|---|
id | string | |
display_name | string | |
short_name | string | ShortName ("N. Virginia") is what the top bar's region button shows; FullName ("US East (N. Virginia)") names the region in the region menu. |
full_name | string | |
city | string | |
country | string | |
country_code | string | |
jurisdiction | string | |
aws_region | string | |
hostname | string | The region's console host: the host the region's cell publishes when it is known, else the planned production host. |
console_url | string | ConsoleURL and APIURL are set only for a region whose cell answered. |
api_url | string | |
sign_in | string | How 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. |
status | string | |
current | boolean | |
recommended | boolean | |
opt_in | boolean | |
switch | SwitchAnswer |
RegionList
| Field | Type | Description |
|---|---|---|
global optional | GlobalPlane | The global plane, nil for a self-hosted installation or while a regional cell's global plane is not live. |
current | string | |
recommended | string | |
recommended_by | string | |
regions | array of ListedRegion | |
services | Services | Services 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.
| Field | Type | Description |
|---|---|---|
plane | string | This cell's plane: global or regional. |
global_api_url | string | GlobalAPIURL 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_url | string | |
global_services | array of string | The console services that are global, by catalog ID. |
global_console_paths | array of string | The 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.
| Field | Type | Description |
|---|---|---|
allowed | boolean | |
reason optional | string | |
url optional | string | |
message optional | string | Message says why, in words, when Sandscale decided it for a caller (the policy that blocks the region). |
policy optional | SwitchPolicy | Policy names the policy that blocks the region. |
SwitchPolicy
SwitchPolicy names the policy that blocks a region.
| Field | Type | Description |
|---|---|---|
kind | string | |
id optional | string | |
name | string |
Actions
Actions summarizes what was done: counts only, never the commands, paths or content.
| Field | Type | Description |
|---|---|---|
events | integer | |
commands | integer | |
file_changes | integer | |
file_reads | integer | |
tool_calls | integer | |
network | integer | |
processes | integer | |
mcp_calls | integer | |
model_requests | integer | |
input_tokens | integer | |
output_tokens | integer | |
cost_usd | number | |
decisions | Decisions |
Activity
The project's activity over a window.
| Field | Type | Description |
|---|---|---|
project_id | string | |
days | integer | |
from | timestamp | |
to | timestamp | |
summary | Actions | |
people | array of Person | |
devices | array of Device | |
apps | array of AppUsage | |
models | array of ModelUsage | |
repositories | array of RepoActivity | |
linked_repositories | array of string | Repository keys of the project (Directory bindings), so the console can say what is linked. |
unattributed | object | Entries in the project's repositories by people who cannot access the project: counted, not shown. |
generated_at | timestamp |
AppUsage
An app or tool that worked in the project.
| Field | Type | Description |
|---|---|---|
id | string | |
label | string | |
kind | string | |
sources | array of string | Where its activity was reported: endpoint_agent, agent_policy, gateway. |
governed | string | |
people | array of string | |
devices | array of string | |
sessions | integer | |
first_seen | timestamp | |
last_seen | timestamp | |
actions | Actions |
Decisions
Decisions counts policy decisions by outcome.
| Field | Type | Description |
|---|---|---|
allow | integer | |
deny | integer | |
ask | integer |
Device
An enrolled device active in the project.
| Field | Type | Description |
|---|---|---|
device_id | string | |
name | string | |
platform | string | |
user_id | string | |
apps | array of string | |
first_seen | timestamp | |
last_seen | timestamp | |
actions | Actions |
ModelUsage
A model used for the project through the gateway or the IDE suite.
| Field | Type | Description |
|---|---|---|
provider | string | |
model | string | |
requests | integer | |
input_tokens | integer | |
output_tokens | integer | |
cost_usd | number |
Person
Someone active in the project.
| Field | Type | Description |
|---|---|---|
user_id | string | |
display_name | string | |
email | string | |
devices | integer | |
apps | array of string | |
sessions | integer | |
first_seen | timestamp | |
last_seen | timestamp | |
actions | Actions |
RepoActivity
A repository of the project work was seen in.
| Field | Type | Description |
|---|---|---|
repo_key | string | |
events | integer | |
last_seen | timestamp |
Sighting
A repository devices of the organization were seen working in.
| Field | Type | Description |
|---|---|---|
repo_key | string | |
devices | integer | |
people | integer | |
entries | integer | |
first_seen | timestamp | |
last_seen | timestamp | |
project optional | SightingProject | The project that binds the repository, when one does. |
sources | array of string | Sources: endpoint_agent (an agent's entries), agent_policy (decisions reported for it). |
SightingProject
The project a sighted repository is linked to.
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
SightingsPage
| Field | Type | Description |
|---|---|---|
repositories | array of Sighting | |
days | integer | |
generated_at | timestamp |
Control
One policy, rule, assignment or binding that applies to the project.
| Field | Type | Description |
|---|---|---|
id | string | "<kind>:<id of the row>", stable across calls. |
service | string | |
control | string | The kind of control (model_assignment, project_rules, ...). |
name | string | Name says what it is, for people. |
source | Scope | |
state | string | |
enforced_by | string | |
detail | object of any |
GovernanceMap
Every control that applies to a project.
| Field | Type | Description |
|---|---|---|
project | ProjectSummary | |
generated_at | timestamp | |
summary | object of integer | Summary counts the controls by state, over the sections that answered. |
services | array of Section |
ProjectResources
| Field | Type | Description |
|---|---|---|
project | Project | |
chain | array of ChainNode | |
kinds | array of KindResources | |
summary | object | Summary counts the resources listed (Total = Own + Inherited) and the kinds that could not be read. |
generated_at | timestamp |
ProjectSummary
ProjectSummary identifies the project of a map.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
name | string | |
path | string | |
state | string | |
suspended | boolean | |
classification | string | |
compliance_frameworks | array of string | |
repositories | array of string | |
ancestors | array of Scope |
Run
One entry of a project's runs.
| Field | Type | Description |
|---|---|---|
kind | string | |
id | string | |
title | string | Title says what ran, for people (the agent, the workspace, the image, the repository). |
status | string | |
user_id optional | string | |
started_at | timestamp | |
ended_at optional | timestamp | |
detail | object of any | Detail holds the kind's own fields; a CI run carries its "checks" and "gates" here. |
RunsPage
A page of runs, newest first.
| Field | Type | Description |
|---|---|---|
runs | array of Run | |
next_cursor optional | string |
Scope
Where a control is set: the account (organization), a node above the project (business unit, service, team) or the project itself.
| Field | Type | Description |
|---|---|---|
kind | string | |
id | string | |
name | string |
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).
| Field | Type | Description |
|---|---|---|
service | string | |
status | string | |
reason optional | string | |
controls | array of Control |
VaultPathInput
VaultPathInput binds a prefix.
| Field | Type | Description |
|---|---|---|
mount | string | |
path_prefix | string | |
share_scope | string | Project (the default for vault paths) or subtree. |
ChainNode
One node of a project chain.
| Field | Type | Description |
|---|---|---|
id | string | |
kind | string | |
name | string | |
path | string | |
state | string |
Home
The node a resource belongs to.
| Field | Type | Description |
|---|---|---|
id | string | |
kind | string | |
name | string |
KindResources
The resources of one kind.
| Field | Type | Description |
|---|---|---|
type | string | The kind's name in the API (the access control resource type where the kind is shared one object at a time). |
label | string | |
default_share_scope | string | |
fixed_share_scope | boolean | |
status | string | Ok, or unknown when the kind's resources could not be read (Reason says so); an unknown kind never lists an empty set. |
reason optional | string | |
resources | array of Resource |
Node
An ancestor of a project.
| Field | Type | Description |
|---|---|---|
id | string | |
kind | string | |
name | string |
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.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
kind | string | Project or sub_project. |
root_id | string | The project at the top of the node's project tree: the node itself for a project. |
name | string | |
slug | string | |
path | string | |
parent_id | string | |
state | string | |
suspended | boolean | |
owner_team_id optional | string | |
classification | string | The project's own classification (projects.classification). |
compliance_frameworks | array of string | |
ancestors | array of Node | The node's ancestors, nearest first; the last is the organization node. |
repositories | array of string | The repository identifiers bound to the project (directory_project_repositories), sorted. |
Resource
A resource linked to a project.
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
share_scope | string | |
home | Home | |
inherited | boolean | True 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.
| Field | Type | Description |
|---|---|---|
quota_id | uuid | |
resource_type | string | |
current_usage | integer | |
limit | integer | |
daily_growth_rate | number | Trend analysis |
weekly_growth_rate | number | |
monthly_growth_rate | number | |
days_until_exhaustion optional | integer | Predictions |
estimated_exhaustion_at optional | timestamp | |
confidence | number | 0.0 - 1.0 |
recommendation optional | string |
QuotaAlert
QuotaAlert represents an alert triggered by quota usage.
| Field | Type | Description |
|---|---|---|
id | uuid | |
org_id | uuid | |
quota_id | uuid | |
trigger_type | string | |
threshold_percent optional | integer | |
forecast_days optional | integer | |
severity | string | |
message | string | |
details optional | object of any | |
notification_sent | boolean | |
notification_sent_at optional | timestamp | |
notification_recipients optional | array of uuid | |
acknowledged | boolean | |
acknowledged_by optional | uuid | |
acknowledged_at optional | timestamp | |
created_at | timestamp |
QuotaCheck
The result of checking if an action is allowed.
| Field | Type | Description |
|---|---|---|
allowed | boolean | |
reason optional | string | |
quota_id optional | uuid | |
resource_type | string | |
current_usage | integer | |
limit | integer | |
requested | integer | |
available | integer | |
is_warning | boolean | |
is_burstable | boolean | |
would_burst | boolean |
QuotaPool
QuotaPool represents shared quotas across teams.
| Field | Type | Description |
|---|---|---|
id | uuid | |
org_id | uuid | |
name | string | |
description optional | string | |
resource_type | string | |
total_quota | integer | |
allocation_strategy | string | |
member_projects optional | array of uuid | |
member_weights optional | object of integer | |
allocated_quota | integer | |
available_quota | integer | |
is_active | boolean | |
created_at | timestamp | |
updated_at | timestamp | |
created_by optional | uuid |
QuotaRequest
QuotaRequest represents a request to increase a quota.
| Field | Type | Description |
|---|---|---|
id | uuid | |
org_id | uuid | |
quota_id | uuid | |
requested_by | uuid | |
resource_type | string | |
current_limit | integer | |
requested_limit | integer | |
justification | string | |
business_case optional | string | |
urgency | string | |
status | string | |
reviewed_by optional | uuid | Review |
reviewed_at optional | timestamp | |
review_notes optional | string | |
auto_approved | boolean | Auto-approval |
auto_approval_reason optional | string | |
expires_at optional | timestamp | |
created_at | timestamp | |
updated_at | timestamp |
QuotaTemplate
QuotaTemplate defines a pre-configured set of quotas for a tier.
| Field | Type | Description |
|---|---|---|
id | uuid | |
name | string | |
display_name | string | |
description optional | string | |
tier | string | |
order_index | integer | |
quotas | array of QuotaTemplateSpec | |
monthly_price optional | number | |
currency | string | |
is_active | boolean | |
is_default | boolean | |
is_public | boolean | |
features optional | array of string | |
tags optional | object of string | |
created_at | timestamp | |
updated_at | timestamp |
QuotaTemplateSpec
QuotaTemplateSpec defines a quota within a template.
| Field | Type | Description |
|---|---|---|
resource_type | string | |
limit | integer | |
limit_type | string | |
burst_limit optional | integer |
QuotaUsage
QuotaUsage tracks current usage of a quota.
| Field | Type | Description |
|---|---|---|
id | uuid | |
quota_id | uuid | |
org_id | uuid | |
current_usage | integer | |
peak_usage | integer | |
is_bursting | boolean | Burst tracking |
burst_started_at optional | timestamp | |
burst_count | integer | |
last_burst_at optional | timestamp | |
window_start optional | timestamp | Time windows for rate limits |
window_usage | integer | |
daily_peak | integer | Historical peaks |
weekly_peak | integer | |
monthly_peak | integer | |
last_updated | timestamp | |
peak_reached_at optional | timestamp |
QuotaWithUsage
QuotaWithUsage combines quota definition with current usage.
| Field | Type | Description |
|---|---|---|
quota | ResourceQuota | |
usage | QuotaUsage | |
utilization_percent | number | |
is_overage | boolean | |
is_warning | boolean |
ResourceQuota
ResourceQuota represents a quota for a specific resource.
| Field | Type | Description |
|---|---|---|
id | uuid | |
org_id | uuid | |
scope | string | |
user_id optional | uuid | |
project_id optional | uuid | |
resource_type | string | |
limit_type | string | |
limit_value | integer | Limits |
warning_threshold optional | integer | |
burst_limit optional | integer | Burst configuration |
burst_duration optional | integer object | |
burst_cooldown optional | integer object | |
grace_period optional | integer object | Grace period |
grace_expiry optional | timestamp | |
auto_scale_enabled | boolean | Auto-scaling |
auto_scale_trigger_percent optional | integer | |
auto_scale_increment optional | integer | |
auto_scale_max optional | integer | |
description optional | string | Metadata |
tags optional | object of string | |
custom_metadata optional | object of any | |
is_active | boolean | |
created_at | timestamp | |
updated_at | timestamp | |
created_by optional | uuid |
UsageReport
UsageReport provides a summary of quota utilization.
| Field | Type | Description |
|---|---|---|
org_id | uuid | |
quotas | array of QuotaWithUsage | |
generated_at | timestamp |
Issued
An assertion with where to use it.
| Field | Type | Description |
|---|---|---|
assertion | string | |
expires_at | timestamp | |
region | string | |
console_url | string | |
exchange_url | string |
approveRejectRequest
| Field | Type | Description |
|---|---|---|
notes optional | string |
assertionRequest
| Field | Type | Description |
|---|---|---|
client | string | |
nonce | string |
checkQuotaRequest
| Field | Type | Description |
|---|---|---|
user_id optional | string | |
project_id optional | string | |
resource_type | string | |
amount | integer |
createPoolRequest
| Field | Type | Description |
|---|---|---|
name | string | |
description optional | string | |
resource_type | string | |
total_quota | integer |
createQuotaRequest
| Field | Type | Description |
|---|---|---|
scope | string | |
user_id optional | string | |
project_id optional | string | |
resource_type | string | |
limit_type | string | |
limit_value | integer | |
warning_threshold optional | integer | |
burst_limit optional | integer | |
auto_scale_enabled | boolean | |
auto_scale_trigger_percent optional | integer | |
auto_scale_increment optional | integer | |
auto_scale_max optional | integer | |
description optional | string | |
tags optional | object of string |
requestIncreaseRequest
| Field | Type | Description |
|---|---|---|
quota_id | string | |
requested_limit | integer | |
justification | string | |
business_case optional | string | |
urgency | string |
updateQuotaRequest
| Field | Type | Description |
|---|---|---|
limit_value optional | integer | |
warning_threshold optional | integer | |
burst_limit optional | integer | |
auto_scale_enabled optional | boolean | |
auto_scale_trigger_percent optional | integer | |
auto_scale_increment optional | integer | |
auto_scale_max optional | integer | |
description optional | string | |
tags optional | object of string | |
is_active optional | boolean |
This page is generated from the server's route table and the Go handlers that serve each route. Do not edit it by hand.