Skip to content

List provider connections

GET /admin/v1/workspaces/{workspaceId}/provider-connections — List provider connections

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

Endpoint

GET /admin/v1/workspaces/{workspaceId}/provider-connections

Operation ID: listProviderConnections

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

Body

This operation has no request body.

Responses

Status Description Content type Schema
200 application/json array<ProviderConnectionDto>

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<ProviderConnectionDto>

Field Required Type Description
[].id Yes string / uuid
[].workspaceId Yes string / uuid
[].name Yes string
[].gatewayBaseUrl Yes string Copy-ready SDK Base URL computed from the deployment Gateway origin and ProviderConnection ID.
[].protocolProfile Yes string
[].baseUrl Yes string
[].status Yes string (ACTIVE | SUSPENDED | ARCHIVED)
[].secretPreview Yes string
[].lastVerifiedAt No string / date-time

Examples

TypeScript Management SDK

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

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

Fetch

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

Type to search…

↑↓ navigate↵ selectEsc close