Update a Service Configuration

PATCH /groups/{groupId}/apps/{appId}/services/{serviceId}/config

Token auth

Update a Data Source or Third-Party Service [Deprecated] configuration.

Path parameters

groupId string Required

An Atlas Project/Group ID.
appId string Required

The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.
serviceId string Required

The unique _id value of a service.

application/json

Body object

clusterName string Required

The cluster name of the data source within. The name may be at most 64 characters long and must only contain ASCII letters, numbers, underscores, and hyphens.
readPreference string Required

The read preference mode for read requests to the data source.

Values are primary, primaryPreferred, secondary, secondaryPreferred, or nearest.
readPreferenceTagSets array[string]

Target read operations to specific members of a replica set.

Values are server1 or server2.
wireProtocolEnabled boolean Required

If true, clients may connect to the app over the MongoDB Wire Protocol.

_id string Required
name string Required

Value is mongodb-datafederation.
type string Required

Value is datalake.
config object Required
Hide config attribute Show config attribute object
- dataLakeName string Required
  
  The service name used to refer to the Federated database instance within this Atlas app. The name may be at most 64 characters long and must only contain ASCII letters, numbers, underscores, and hyphens.

name string

The service name.
type string

The type of service.

Values are aws, twilio, github, gcm, or http.
incoming_webhooks array[object]
Hide incoming_webhooks attributes Show incoming_webhooks attributes object
- name string Required
- function_source string Required
- respond_result boolean Required
- options object
  Hide options attributes Show options attributes object
  
  secret string
  
  secretAsQueryParam boolean
version integer

Responses

204

Successfully updated.

PATCH /groups/{groupId}/apps/{appId}/services/{serviceId}/config

curl \
 --request PATCH 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/services/{serviceId}/config' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"clusterName":"Cluster0","readPreference":"primary","readPreferenceTagSets":["server1"],"wireProtocolEnabled":true}'

Request examples

{
  "clusterName": "Cluster0",
  "readPreference": "primary",
  "readPreferenceTagSets": [
    "server1"
  ],
  "wireProtocolEnabled": true
}

{
  "_id": "string",
  "name": "mongodb-datafederation",
  "type": "datalake",
  "config": {
    "dataLakeName": "string"
  }
}

{
  "name": "string",
  "type": "aws",
  "incoming_webhooks": [
    {
      "name": "string",
      "function_source": "string",
      "respond_result": true,
      "options": {
        "secret": "string",
        "secretAsQueryParam": true
      }
    }
  ],
  "version": 42
}