---
title: "Update provider"
method: PUT
path: "/v4/organizations/{organizationId}/aiServices/providers/{providerId}"
tags: ["AI Data Plane Providers"]
---

# Update provider

`PUT /v4/organizations/{organizationId}/aiServices/providers/{providerId}`

## Request

- Base URL: `https://cloudapi.cloud.couchbase.com`
- URL: `https://cloudapi.cloud.couchbase.com/v4/organizations/{organizationId}/aiServices/providers/{providerId}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/docs/v4/organizations/:organizationId/aiServices/providers/:providerId/put.ts> (a function with typed inputs; its response is checked against the schema)

Updates an existing provider.

In order to access this endpoint, the provided API key must have at least one of the following roles:
- Organization Owner

To learn more, see [Organization, Project, and Database Access Overview](https://docs.couchbase.com/cloud/organizations/organization-projects-overview.html).

## Headers

- `If-Match` string

## Request body

- UpdateProviderRequest
  - `configuration` union, required: The configuration for the provider to update.
    - object
      - `accessKeyId` string: The access key ID to access the S3 bucket.
      - `secretAccessKey` string: The secret access key to access the S3 bucket.
      - `sessionToken` string: The session token to access the S3 bucket in case of temporary credentials.
      - `awsRegion` string: The AWS region the S3 bucket is located in.
      - `bucket` string: The name of the S3 bucket.
      - `folderPath` string: The path to the folder in the S3 bucket where the files are stored. Leave empty for root folder.
    - object
      - `apiKey` string: The API key to access the OpenAI API.
    - object: Update credentials for AWS Bedrock provider. You can only update credentials within the same authentication mode that was set during creation. Switching authentication modes is not allowed.
      - `accessKeyId` string: The AWS access key ID (only for providers created with IAM credentials).
      - `secretAccessKey` string: The AWS secret access key (only for providers created with IAM credentials).
      - `apiKey` string: The Bedrock API key (only for providers created with API key authentication).
      - `region` 'us-east-1' | 'us-west-2' | 'ap-northeast-1' | 'ap-northeast-2' | 'ap-northeast-3' | 'ap-south-1' | 'ap-south-2' | 'ap-southeast-1' | 'ap-southeast-2' | 'ca-central-1' | 'eu-central-1' | 'eu-central-2' | 'eu-north-1' | 'eu-south-1' | 'eu-south-2' | 'eu-west-1' | 'eu-west-2' | 'eu-west-3' | 'sa-east-1': The AWS region for Bedrock (only for providers created with API key authentication).

## Response `204`

Successfully submitted request to update provider.

## Other responses

- `400`: Returned when we are unable to decode the recevied payload.
- `403`: The client does not have the necessary permissions to access this resource.
- `404`: The requested resource was not found.
- `412`: Returned when there is a mismatch with the Etag version.
- `422`: Request validation error.
- `429`: Returned when the client exceeds the rate limit for the given APIKey.
- `500`: An unexpected error occurred in the server while processing this request.

## Changes

- **2026-08-06** `e67df5d1f74e`: 4 info
  - api tag `AI Data Plane Providers` added
  - api tag `AI Services Providers` removed
  - added the new optional request property `configuration/oneOf[#/components/schemas/UpdateBedrockConfigurationRequest]/apiKey`
  - added the new optional request property `configuration/oneOf[#/components/schemas/UpdateBedrockConfigurationRequest]/region`

[Operation history](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/changes/v4/organizations/:organizationId/aiServices/providers/:providerId/put.md)

---

[API](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api.md) - [All operations](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/revisions/fcc4f29578b1?raw)