# Update One Federated Database Instance in One Project

**PATCH /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}**

Updates the details of one federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or higher role.


## Servers
- https://cloud.mongodb.com: https://cloud.mongodb.com ()


## Authentication methods
- Service accounts
- Digest auth


## Parameters

### Path parameters
- **groupId** (string)
  Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.

  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
- **tenantName** (string)
  Human-readable label that identifies the federated database instance to update.

### Query parameters
- **envelope** (boolean)
  Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
- **pretty** (boolean)
  Flag that indicates whether the response body should be in the prettyprint format.
- **skipRoleValidation** (boolean)
  Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.

### Body: application/vnd.atlas.2023-01-01+json (object)
Details of one Federated Database to update in the specified project.
- **cloudProviderConfig** (object)
  Cloud provider where this Federated Database Instance is hosted.
- **dataProcessRegion** (object)
  Information about the cloud provider region to which the Federated Database Instance routes client connections.
- **name** (string)
  Human-readable label that identifies the Federated Database Instance.
- **storage** (object)
  Configuration information for each data store and its mapping to MongoDB Cloud databases.


## Responses
### 200
OK

#### Body: application/vnd.atlas.2023-01-01+json (object)
- **cloudProviderConfig** (object)
  Cloud provider where this Federated Database Instance is hosted.
- **dataProcessRegion** (object)
  Information about the cloud provider region to which the Federated Database Instance routes client connections.
- **groupId** (string)
  Unique 24-hexadecimal character string that identifies the project.
- **hostnames** (array[string])
  List that contains the hostnames assigned to the Federated Database Instance.
- **name** (string)
  Human-readable label that identifies the Federated Database Instance.
- **privateEndpointHostnames** (array[object])
  List that contains the sets of private endpoints and hostnames.
- **state** (string)
  Label that indicates the status of the Federated Database Instance.
- **storage** (object)
  Configuration information for each data store and its mapping to MongoDB Cloud databases.

### 400
Bad Request.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 401
Unauthorized.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 403
Forbidden.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 404
Not Found.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.

### 500
Internal Server Error.

#### Body: application/json (object)
- **badRequestDetail** (object)
  Bad request detail.
- **detail** (string)
  Describes the specific conditions or reasons that cause each type of error.
- **error** (integer(int32))
  HTTP status code returned with this error.
- **errorCode** (string)
  Application error code returned with this error.
- **parameters** (array[object])
  Parameters used to give more information about the error.
- **reason** (string)
  Application error message returned with this error.


[Powered by Bump.sh](https://bump.sh)