These methods are generated from the Admin OpenAPI contract. They configure the control plane; they do not send model requests.
| Method | HTTP | Path | Reference |
|---|---|---|---|
bindPlanStrategy |
POST |
/admin/v1/plans/{planId}/strategy-bindings |
API |
closePlanStrategyBinding |
DELETE |
/admin/v1/plan-strategy-bindings/{bindingId} |
API |
createPlan |
POST |
/admin/v1/workspaces/{workspaceId}/plans |
API |
createQuotaStrategy |
POST |
/admin/v1/workspaces/{workspaceId}/plan-strategies/quota |
API |
getPlan |
GET |
/admin/v1/plans/{planId} |
API |
getPlanStrategy |
GET |
/admin/v1/plan-strategies/{strategyId} |
API |
listPlans |
GET |
/admin/v1/workspaces/{workspaceId}/plans |
API |
listPlanStrategies |
GET |
/admin/v1/workspaces/{workspaceId}/plan-strategies |
API |
listPlanStrategyBindings |
GET |
/admin/v1/plans/{planId}/strategy-bindings |
API |
publishPlan |
POST |
/admin/v1/plans/{planId}/publish |
API |
publishPlanStrategy |
POST |
/admin/v1/plan-strategies/{strategyId}/publish |
API |
updatePlan |
PATCH |
/admin/v1/plans/{planId} |
API |
Method signatures
bindPlanStrategy
nexus.bindPlanStrategy(
input: AdminOperationInput<"bindPlanStrategy">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"bindPlanStrategy">>Bind a strategy version to a plan from an effective time
closePlanStrategyBinding
nexus.closePlanStrategyBinding(
input: AdminOperationInput<"closePlanStrategyBinding">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"closePlanStrategyBinding">>Close a strategy binding at the requested effective time
createPlan
nexus.createPlan(
input: AdminOperationInput<"createPlan">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"createPlan">>Create a workspace plan
createQuotaStrategy
nexus.createQuotaStrategy(
input: AdminOperationInput<"createQuotaStrategy">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"createQuotaStrategy">>Create a versioned quota strategy
getPlan
nexus.getPlan(
input: AdminOperationInput<"getPlan">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"getPlan">>Get a workspace plan and active strategy bindings
getPlanStrategy
nexus.getPlanStrategy(
input: AdminOperationInput<"getPlanStrategy">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"getPlanStrategy">>Get a strategy version
listPlans
nexus.listPlans(
input: AdminOperationInput<"listPlans">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"listPlans">>List workspace plans
listPlanStrategies
nexus.listPlanStrategies(
input: AdminOperationInput<"listPlanStrategies">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"listPlanStrategies">>List plan strategies owned by a workspace
listPlanStrategyBindings
nexus.listPlanStrategyBindings(
input: AdminOperationInput<"listPlanStrategyBindings">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"listPlanStrategyBindings">>List current and historical strategy bindings
publishPlan
nexus.publishPlan(
input: AdminOperationInput<"publishPlan">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"publishPlan">>Publish a plan after strategy validation
publishPlanStrategy
nexus.publishPlanStrategy(
input: AdminOperationInput<"publishPlanStrategy">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"publishPlanStrategy">>Publish an immutable strategy version
updatePlan
nexus.updatePlan(
input: AdminOperationInput<"updatePlan">,
options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"updatePlan">>Update a draft workspace plan