---
title: "Update a provider connection"
description: "PATCH /admin/v1/provider-connections/{providerConnectionId} — Update a provider connection"
---

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

# Update a provider connection

## Endpoint

```http
PATCH /admin/v1/provider-connections/{providerConnectionId}
```

Operation ID: `updateProviderConnection`

## 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 |
| ---------------------- | -------- | -------- | -------- | ----------- |
| `providerConnectionId` | path     | Yes      | `string` | —           |

### application/json body

Required: **Yes**

Type: `UpdateProviderConnectionDto`

| Field             | Required | Type                                       | Description |
| ----------------- | -------- | ------------------------------------------ | ----------- |
| `name`            | No       | `string`                                   | —           |
| `protocolProfile` | No       | `string`                                   | —           |
| `baseUrl`         | No       | `string / uri`                             | —           |
| `status`          | No       | `string (ACTIVE \| SUSPENDED \| ARCHIVED)` | —           |

## Responses

| Status | Description | Content type     | Schema                  |
| ------ | ----------- | ---------------- | ----------------------- |
| `200`  | —           | 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`](/management-sdk/error-handling).

### `200` 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.updateProviderConnection` uses `AdminOperationInput<"updateProviderConnection">` and returns `Promise<AdminOperationOutput<"updateProviderConnection">>`.

```ts
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.updateProviderConnection({
  path: {
    providerConnectionId: '533c4e1e-2823-4349-86b9-d6f1a869a2ca',
  },
  body: {},
});
```

### Fetch

```ts
const response = await fetch(
  'https://nexus.microvoid.io/admin/v1/provider-connections/533c4e1e-2823-4349-86b9-d6f1a869a2ca',
  {
    method: 'PATCH',
    headers: {
      Authorization: `Bearer ${process.env.NEXUS_MANAGEMENT_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({}),
  },
);

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

### curl

```bash
curl --request PATCH \
  "https://nexus.microvoid.io/admin/v1/provider-connections/533c4e1e-2823-4349-86b9-d6f1a869a2ca" \
  --header "Authorization: Bearer ${NEXUS_MANAGEMENT_KEY}" \
  --header "Content-Type: application/json" \
  --data "{}"
```

## Related guide

- [Provider connections](/docs/connect-model-capacity/provider-connections)
- [API Reference overview](/api-reference)

Source: https://nexus.microvoid.io/api-reference/admin/provider-connections/update-provider-connection/index.mdx