Get the current quota snapshot

GET /admin/v1/workspace-accesses/{accessId}/quota — Get the current quota snapshot

Endpoint

GET /admin/v1/workspace-accesses/{accessId}/quota

Operation ID: getWorkspaceAccessQuota

Authentication

Send a Nexus Management Key as Authorization: Bearer <management-key>. This credential is control-plane only.

Idempotency

This operation does not declare an Idempotency-Key requirement in the accepted OpenAPI contract.

Request

Parameters

Name	Location	Required	Schema	Description
`accessId`	path	Yes	`string`	—

Body

This operation has no request body.

Responses

Status	Description	Content type	Schema
`200`	—	application/json	`QuotaSnapshotDto`

Only responses explicitly declared by the accepted Admin OpenAPI contract are shown. The current contract does not declare operation-specific error bodies; the SDK preserves any non-success status and body in AdminApiError.

`200` application/json schema

Type: QuotaSnapshotDto

Field	Required	Type	Description
`workspaceAccessId`	Yes	`string`	—
`planId`	Yes	`string`	—
`quotaStrategyId`	Yes	`string`	—
`quotaPeriodId`	Yes	`string`	—
`grantedUnits`	Yes	`string`	—
`reservedUnits`	Yes	`string`	—
`consumedUnits`	Yes	`string`	—
`availableUnits`	Yes	`string`	—
`periodEnd`	Yes	`string / date-time`	—

Examples

TypeScript Management SDK

NexusAdminClient.getWorkspaceAccessQuota uses AdminOperationInput<"getWorkspaceAccessQuota"> and returns Promise<AdminOperationOutput<"getWorkspaceAccessQuota">>.

import { NexusAdminClient } from '@nexus/sdk-typescript';

const nexus = new NexusAdminClient({
  baseUrl: 'https://nexus.microvoid.io',
  managementKey: process.env.NEXUS_MANAGEMENT_KEY,
});

const result = await nexus.getWorkspaceAccessQuota({
  path: {
    accessId: '533c4e1e-2823-4349-86b9-d6f1a869a2ca',
  },
});

Fetch

const response = await fetch(
  'https://nexus.microvoid.io/admin/v1/workspace-accesses/533c4e1e-2823-4349-86b9-d6f1a869a2ca/quota',
  {
    method: 'GET',
    headers: {
      Authorization: `Bearer ${process.env.NEXUS_MANAGEMENT_KEY}`,
    },
  },
);

if (!response.ok) throw new Error(`Nexus request failed: ${response.status}`);

curl

curl --request GET \
  "https://nexus.microvoid.io/admin/v1/workspace-accesses/533c4e1e-2823-4349-86b9-d6f1a869a2ca/quota" \
  --header "Authorization: Bearer ${NEXUS_MANAGEMENT_KEY}"