Skip to content

Publish an immutable strategy version

POST /admin/v1/plan-strategies/{strategyId}/publish — Publish an immutable strategy version

Updated View as Markdown
Audience: application-backendPlane: adminAuth: management-keyStatus: beta

Endpoint

POST /admin/v1/plan-strategies/{strategyId}/publish

Operation ID: publishPlanStrategy

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
strategyId path Yes string

Body

This operation has no request body.

Responses

Status Description Content type Schema
200 application/json QuotaStrategyDto

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: QuotaStrategyDto

Field Required Type Description
id Yes string
workspaceId Yes string
key Yes string
version Yes number
type Yes string (QUOTA)
resetInterval Yes string (MONTH | YEAR)
quotaUnits Yes string 64-bit integer encoded as a decimal string.
inputMultiplierPpm Yes string
outputMultiplierPpm Yes string
cachedInputMultiplierPpm Yes string
maxOutputTokens Yes number
status Yes string

Examples

TypeScript Management SDK

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

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.publishPlanStrategy({
  path: {
    strategyId: '533c4e1e-2823-4349-86b9-d6f1a869a2ca',
  },
});

Fetch

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

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

curl

curl --request POST \
  "https://nexus.microvoid.io/admin/v1/plan-strategies/533c4e1e-2823-4349-86b9-d6f1a869a2ca/publish" \
  --header "Authorization: Bearer ${NEXUS_MANAGEMENT_KEY}"
Navigation

Type to search…

↑↓ navigate↵ selectEsc close