Publish a plan after strategy validation

POST /admin/v1/plans/{planId}/publish — Publish a plan after strategy validation

Endpoint

POST /admin/v1/plans/{planId}/publish

Operation ID: publishPlan

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
`planId`	path	Yes	`string`	—

Body

This operation has no request body.

Responses

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

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

Field	Required	Type	Description
`id`	Yes	`string`	—
`workspaceId`	Yes	`string`	—
`key`	Yes	`string`	—
`name`	Yes	`string`	—
`billingInterval`	Yes	`string (MONTH \| YEAR)`	—
`status`	Yes	`string (DRAFT \| ACTIVE \| ARCHIVED)`	—

Examples

TypeScript Management SDK

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

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

Fetch

const response = await fetch('https://nexus.microvoid.io/admin/v1/plans/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/plans/533c4e1e-2823-4349-86b9-d6f1a869a2ca/publish" \
  --header "Authorization: Bearer ${NEXUS_MANAGEMENT_KEY}"