Create a data source or third-party service

POST /groups/{groupId}/apps/{appId}/services

Token auth

Create a data source or third-party service [Deprecated].

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.

application/json

Body object

_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

201 application/json

Successfully created.
One of:
ServiceConstructor object AtlasFederatedInstanceConstructor object ThirdPartyService object
Hide attributes Show attributes

_id string

The cluster's unique ID.

name string

The service name.

type string

The type of service.
Hide attributes Show attributes

_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.
THIRD-PARTY SERVICES ARE DEPRECATED

See Third-Party Services for more information.

Hide attributes Show attributes

_id string

A unique ID for the third-party service.

name string

The third-party service name.

type string

The type of third party service.

Values are aws, twilio, github, or gcm.

version integer
409

There is already a service with the given name.

POST /groups/{groupId}/apps/{appId}/services

curl \
 --request POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/services' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"string","type":"string"}'

Request examples

{
  "name": "string",
  "type": "string"
}

{
  "_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
}

Response examples (201)

{
  "_id": "string",
  "name": "string",
  "type": "string"
}

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

{
  "_id": "string",
  "name": "string",
  "type": "aws",
  "version": 42
}