---
title: "Provider Connections"
description: "Generated TypeScript Management SDK methods for Provider Connections."
---

> Documentation Index
> Fetch the complete documentation index at: https://nexus.microvoid.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Provider Connections

These methods are generated from the Admin OpenAPI contract. They configure the control plane; they do not send model requests.

| Method                      | HTTP     | Path                                                                  | Reference                                                                    |
| --------------------------- | -------- | --------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `archiveProviderConnection` | `DELETE` | `/admin/v1/provider-connections/{providerConnectionId}`               | [API](/api-reference/admin/provider-connections/archive-provider-connection) |
| `createProviderConnection`  | `POST`   | `/admin/v1/workspaces/{workspaceId}/provider-connections`             | [API](/api-reference/admin/provider-connections/create-provider-connection)  |
| `getProviderConnection`     | `GET`    | `/admin/v1/provider-connections/{providerConnectionId}`               | [API](/api-reference/admin/provider-connections/get-provider-connection)     |
| `listProviderConnections`   | `GET`    | `/admin/v1/workspaces/{workspaceId}/provider-connections`             | [API](/api-reference/admin/provider-connections/list-provider-connections)   |
| `rotateProviderSecret`      | `POST`   | `/admin/v1/provider-connections/{providerConnectionId}/rotate-secret` | [API](/api-reference/admin/provider-connections/rotate-provider-secret)      |
| `testProviderConnection`    | `POST`   | `/admin/v1/workspaces/{workspaceId}/provider-connections/test`        | [API](/api-reference/admin/provider-connections/test-provider-connection)    |
| `updateProviderConnection`  | `PATCH`  | `/admin/v1/provider-connections/{providerConnectionId}`               | [API](/api-reference/admin/provider-connections/update-provider-connection)  |
| `verifyProviderConnection`  | `POST`   | `/admin/v1/provider-connections/{providerConnectionId}/verify`        | [API](/api-reference/admin/provider-connections/verify-provider-connection)  |

## Method signatures

### `archiveProviderConnection`

```ts
nexus.archiveProviderConnection(
  input: AdminOperationInput<"archiveProviderConnection">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"archiveProviderConnection">>
```

Archive a provider connection

### `createProviderConnection`

```ts
nexus.createProviderConnection(
  input: AdminOperationInput<"createProviderConnection">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"createProviderConnection">>
```

Connect an upstream provider and encrypted API key

### `getProviderConnection`

```ts
nexus.getProviderConnection(
  input: AdminOperationInput<"getProviderConnection">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"getProviderConnection">>
```

Get a provider connection without secret plaintext

### `listProviderConnections`

```ts
nexus.listProviderConnections(
  input: AdminOperationInput<"listProviderConnections">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"listProviderConnections">>
```

List provider connections

### `rotateProviderSecret`

```ts
nexus.rotateProviderSecret(
  input: AdminOperationInput<"rotateProviderSecret">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"rotateProviderSecret">>
```

Rotate a provider API key

### `testProviderConnection`

```ts
nexus.testProviderConnection(
  input: AdminOperationInput<"testProviderConnection">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"testProviderConnection">>
```

Test provider connectivity and credentials before saving

### `updateProviderConnection`

```ts
nexus.updateProviderConnection(
  input: AdminOperationInput<"updateProviderConnection">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"updateProviderConnection">>
```

Update a provider connection

### `verifyProviderConnection`

```ts
nexus.verifyProviderConnection(
  input: AdminOperationInput<"verifyProviderConnection">,
  options?: AdminRequestOptions,
): Promise<AdminOperationOutput<"verifyProviderConnection">>
```

Verify provider connectivity and credentials

Source: https://nexus.microvoid.io/management-sdk/reference/provider-connections/index.mdx