Connect an upstream provider and encrypted API key

POST /admin/v1/workspaces/{workspaceId}/provider-connections — Connect an upstream provider and encrypted API key

Endpoint

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

Operation ID: createProviderConnection

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`	—

application/json body

Required: Yes

Type: CreateProviderConnectionDto

Field	Required	Type	Description
`name`	Yes	`string`	—
`protocolProfile`	Yes	`string`	—
`baseUrl`	Yes	`string / uri`	—
`apiKey`	Yes	`string`	—

Responses

Status	Description	Content type	Schema
`201`	—	application/json	`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.

`201` application/json schema

Type: 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.createProviderConnection uses AdminOperationInput<"createProviderConnection"> and returns Promise<AdminOperationOutput<"createProviderConnection">>.

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.createProviderConnection({
  path: {
    workspaceId: '533c4e1e-2823-4349-86b9-d6f1a869a2ca',
  },
  body: {
    name: 'Production',
    protocolProfile: 'string',
    baseUrl: 'https://app.example/callback',
    apiKey: '<secret-from-environment>',
  },
});

Fetch

const response = await fetch(
  'https://nexus.microvoid.io/admin/v1/workspaces/533c4e1e-2823-4349-86b9-d6f1a869a2ca/provider-connections',
  {
    method: 'POST',
    headers: {
      Authorization: `Bearer ${process.env.NEXUS_MANAGEMENT_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'Production',
      protocolProfile: 'string',
      baseUrl: 'https://app.example/callback',
      apiKey: '<secret-from-environment>',
    }),
  },
);

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

curl

curl --request POST \
  "https://nexus.microvoid.io/admin/v1/workspaces/533c4e1e-2823-4349-86b9-d6f1a869a2ca/provider-connections" \
  --header "Authorization: Bearer ${NEXUS_MANAGEMENT_KEY}" \
  --header "Content-Type: application/json" \
  --data "{\"name\":\"Production\",\"protocolProfile\":\"string\",\"baseUrl\":\"https://app.example/callback\",\"apiKey\":\"<secret-from-environment>\"}"