Skip to content

List current and historical strategy bindings

GET /admin/v1/plans/{planId}/strategy-bindings — List current and historical strategy bindings

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

Endpoint

GET /admin/v1/plans/{planId}/strategy-bindings

Operation ID: listPlanStrategyBindings

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 array<StrategyBindingDto>

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: array<StrategyBindingDto>

Field Required Type Description
[].id Yes string
[].planId Yes string
[].strategyId Yes string
[].strategyType Yes string (QUOTA)
[].effectiveFrom Yes string / date-time
[].effectiveTo No string / date-time

Examples

TypeScript Management SDK

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

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

Fetch

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

Type to search…

↑↓ navigate↵ selectEsc close