Navigation

Stitch Administration API

MongoDB Stitch provides an API for programmatically performing administrative tasks outside of the Stitch UI. You can use this API to develop your own tools if the stitch-cli command line tool does not meet your needs.

API Authentication

Generating an Atlas API Key

To access the Atlas API, you must generate an API key, which gives access to the API. Each user that will use the API must generate a key. You can have up to ten API keys associated with your account. Each key can be either enabled or disabled but all count toward the ten-key limit.

An API key is like a password. Keep it secret.

When accessing Atlas through the API, you have the same level of access as you do through the Atlas interface. Your Atlas roles apply to both the interface and the API.

Important

When you generate a key, Atlas displays it one time only. You must copy it. Atlas will never display the full key again.

  1. On the upper-right hand corner, click on your user name and select Account. Click on Public API Access.

  2. In the API Keys section, click Generate.

  3. Type a description and click Generate.

  4. If prompted for two-factor authentication, enter the code and click Verify. Then click Generate again.

  5. Copy and record the key.

    Copy the key immediately. Atlas displays the full key one time only. You will not be able to view the full key again.

    Record the key in a secure place. After you record the key, click Close.

Initial Authentication

Using the generated API key that Atlas provided, you may request a Stitch access token using the Stitch POST /auth/providers/{provider}/login API endpoint:

curl --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"username": "<username>", "apiKey": "<apiKey>"}' \
  https://stitch.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login \
  | python2.7 -m json.tool

Note

The previous command pipes the output into python2.7 -m json.tool to make the JSON more readable.

If authentication succeeds, MongoDB Stitch returns an access token as part of the JSON response document:

{ "access_token": "<access_token>",
  "refresh_token": "<refresh_token>",
  "user_id": "<user_id>",
  "device_id": "<device_id>" }

Most MongoDB Stitch APIs expect an access token provided as part of the HTTP Authorization header of any request. This header uses the following format:

Authorization: Bearer <access_token>

To test your access token, provide the Authorization header to the GET /auth/profile endpoint:

curl --header 'Authorization: Bearer <access_token>' \
  https://stitch.mongodb.com/api/admin/v3.0/auth/profile

As a demonstration, the following fills in the previous request template with fictional values:

curl --request GET \
  --header 'Authorization: Bearer 31Mh_AEBZDMRJjT21niazFoGiM3T0yBDlIXpYc2wnzBMRtO3isYNi061MRZs49Z8wdjJD5YzLQIkFUAHn1t5nZHjZAUiMD9oMVgmjlqR9iNIaGWS0YD6kRNXwYIjFLMQ2cFDTjpXY1XwMaM_NJwND3VIOc0JmIweY0bNNQrShF1UyUuMFeAVwHl13LGWwIWMblRIR59IaGVDMFiZ10bi0QQVGBOF1BwsVTIwXAUQJ6VQFDC3qTgSMg3ZNp9ZKIGvnbWbr6MlNQjBEDu0Qyzlb9lJ5jNBMCDhzQ4DGIaklh2I2wwkOG1BUDUUUTYOZzFlYkEzM0knAiZoplFJdRNikyibizkcXZTUmWCk4jRDBD0CQIaJQUFCUcBWzEWTxIIWOweVTHVZF5bzwiBAOTG6lhljNIYVsUWwIF2ZJXVNnAHN3MkkZNxaxbZMWM3JtYZph0NmF0IZZZ3tFQ.ZyZUcasJL2WDcx0USnNdszoRpctW9BT0I91ZCUCFjM0HEROJFIjY2LiCcWFSWjxDWzJUI4HcLkXUwkFcaxmVVkaZoeidrTzrxAFBw6UIIipIFFk59bCNdsiVhCXHCLw9QlikmGiVdDoXMZHAdXMIj7XORXAj1MAlBIVZ9hMUJUlRuZSCiIJMLICcTwVORUU.naPJJCXFzWc0cNYtzMaFyl5aRyAckG0XIYVJ9iEAC0My0t0MCRWcE0zA30QauhAATNzgdYyFkiLZ6wmYZjX3Zkgs0FR2MjS2JeAVFUnNtK6WlAEJRTC3Q0QjCnwnkrM2JwFwNsDDDhbA1NYZVVBmF1MaMJHnzrM3hRe0jDB2akIjlW' \
  https://stitch.mongodb.com/api/admin/v3.0/auth/profile

Project & Application IDs

Note

The terms Project ID and Group ID are interchangeable.

MongoDB Stitch APIs frequently require two parameters: your Atlas Project/Group ID, and your MongoDB Stitch Application ID.

Project ID

To find your Project ID, go to your Atlas administration console, click Settings in the left-hand navigation bar, and look under the Project ID heading.

Application ID

To find your Application ID, make a request to the Stitch GET /groups/{groupId}/apps API endpoint.

This request has the following format, referencing the access_token described in Initial Authentication:

curl --request GET \
  --header 'Authorization: Bearer <access_token>' \
  https://stitch.mongodb.com/api/admin/v3.0/groups/{groupId}/apps

This will return a list of objects describing each Stitch application in the provided group. The _id field contains the Application ID.

Resources

Base URL

https://stitch.mongodb.com/api/admin/v3.0

The root API resource and starting point for the MongoDB Stitch API.

Stitch Administrator APIs

get
/auth/providers

Enumerate available Stitch administration authentication providers.

Responses

200: Successfully enumerated available authentication providers.

[
  {
    "_id": "string",
    "name": "string",
    "type": "string",
    "disabled": "boolean"
  }
]
Field Type Description
[] array of objects An array of authentication providers.
[]._id string  
[].name string  
[].type string

Possible Values:

  • mongodb-cloud
  • local
[].disabled boolean  
post
/auth/providers/{provider}/login

Authenticate as a Stitch administrator. Use GET /auth/providers to list the available authentication providers.

Path Parameters

Name Type Description
provider string

The authentication provider to use.

Possible Values:

  • mongodb-cloud
  • local

Request Body

{
  "username": "string",
  "apiKey": "string"
}
Field Type Description
username string  
apiKey string  

Responses

200: Authentication was successful.

{
  "access_token": "string",
  "refresh_token": "string",
  "user_id": "string",
  "device_id": "string"
}
Field Type Description
access_token string An access token you may provide in the Authorization header of API requests. Initial Authentication demonstrates how to use this token.
refresh_token string A refresh token you may provide in the Authorization header of POST /auth/session to obtain a new access_token for the current user session.
user_id string  
device_id string  
get
/auth/profile

Get information about the currently logged in user.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: The profile was successfully retrieved.

{
  "user_id": "string",
  "domain_id": "string",
  "identities": [
    {
      "_id": "string",
      "name": "string",
      "type": "string",
      "disabled": "boolean"
    }
  ],
  "data": {
    "email": "string",
    "name": "string"
  },
  "type": "string",
  "roles": [
    {
      "role_name": "string",
      "group_id": "Any"
    }
  ]
}
Field Type Description
user_id string  
domain_id string  
identities array  
identities.[]._id string  
identities.[].name string  
identities.[].type string

Possible Values:

  • mongodb-cloud
  • local
identities.[].disabled boolean  
data object  
data.email string  
data.name string  
type string

Possible Values:

  • normal
  • server
  • system
  • unknown
roles array  
roles.[].role_name string  
roles.[].group_id string An Atlas Project/Group ID.
delete
/auth/session

Delete a Stitch access token.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: Successfully deleted.

post
/auth/session

Obtain a Stitch access token.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the refresh_token field of the POST /auth/providers/{provider}/login API endpoint.

Responses

201: Successfully created.

{
  "access_token": "string"
}
Field Type Description
access_token string  

API Key APIs

get
/groups/{groupId}/apps/{appId}/api_keys

List API keys associated with a Stitch application.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: The API keys were successfully listed.

[
  {
    "_id": "string",
    "name": "string",
    "disabled": "boolean"
  }
]
Field Type Description
[] array of objects  
[]._id string  
[].name string  
[].disabled boolean  
post
/groups/{groupId}/apps/{appId}/api_keys

Create a new API key.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

The API key to create.

{
  "name": "string"
}
Field Type Description
name string  

Responses

201: The API key was successfully created.

{
  "_id": "string",
  "key": "string",
  "name": "string",
  "disabled": "string"
}
Field Type Description
_id string  
key string  
name string  
disabled string  
get
/groups/{groupId}/apps/{appId}/api_keys/{apiKeyId}

Retrieve information about an API key.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
apiKeyId string API Key ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: The API key was successfully retrieved.

{
  "_id": "string",
  "key": "string",
  "name": "string",
  "disabled": "string"
}
Field Type Description
_id string  
key string  
name string  
disabled string  
delete
/groups/{groupId}/apps/{appId}/api_keys/{apiKeyId}

Delete an API key.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
apiKeyId string API Key ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: The API key was successfully deleted.

put
/groups/{groupId}/apps/{appId}/api_keys/{apiKeyId}/enable

Enable an API key.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
apiKeyId string API Key ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: The API key was successfully enabled.

put
/groups/{groupId}/apps/{appId}/api_keys/{apiKeyId}/disable

Disable an API key.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
apiKeyId string API Key ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: The API key was successfully disabled.

Application-level APIs

get
/groups/{groupId}/apps

List all Stitch applications within an Atlas project/group.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully listed.

[
  {
    "_id": "string",
    "client_app_id": "string",
    "name": "string",
    "domain_id": "string",
    "group_id": "string"
  }
]
Field Type Description
[] array of objects  
[]._id string The Application ID.
[].client_app_id string  
[].name string  
[].domain_id string  
[].group_id string An Atlas Project/Group ID.
post
/groups/{groupId}/apps

Create a new Stitch application.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.

Query Parameters

Name Type Description
defaults boolean Whether or not to create a default application.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

The application to create.

{
  "name": "string"
}
Field Type Description
name string  

Responses

201: The application was successfully created.

get
/groups/{groupId}/apps/{appId}

Retrieve an application definition.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: The application was successfully retrieved.

{
  "_id": "string",
  "client_app_id": "string",
  "name": "string",
  "domain_id": "string",
  "group_id": "string"
}
Field Type Description
_id string The Application ID.
client_app_id string  
name string  
domain_id string  
group_id string An Atlas Project/Group ID.
delete
/groups/{groupId}/apps/{appId}

Delete an application.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: The application was successfully deleted.

get
/groups/{groupId}/apps/{appId}/export

Export an application as a zip file.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: The application was successfully exported.

Auth Provider APIs

get
/groups/{groupId}/apps/{appId}/auth_providers

List authentication providers within a Stitch application.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully listed.

[
  {
    "_id": "string",
    "name": "string",
    "type": "string",
    "disabled": "boolean"
  }
]
Field Type Description
[] array of objects  
[]._id string  
[].name string  
[].type string

Possible Values:

  • mongodb-cloud
  • local
[].disabled boolean  
post
/groups/{groupId}/apps/{appId}/auth_providers

Create an authentication provider.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

{
  "name": "string",
  "type": "string",
  "disabled": "boolean",
  "config": "object"
}
Field Type Description
name string  
type string

Possible Values:

  • mongodb-cloud
  • local
disabled boolean  
config object  

Responses

201: Successfully created.

get
/groups/{groupId}/apps/{appId}/auth_providers/{providerId}

Retrieve information about one of an application’s authentication providers

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
providerId string Provider ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully retrieved.

{
  "_id": "string",
  "name": "string",
  "type": "string",
  "disabled": "boolean",
  "config": "object"
}
Field Type Description
_id string  
name string  
type string

Possible Values:

  • mongodb-cloud
  • local
disabled boolean  
config object  
delete
/groups/{groupId}/apps/{appId}/auth_providers/{providerId}

Delete an authentication provider.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
providerId string Provider ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: Successfully deleted.

patch
/groups/{groupId}/apps/{appId}/auth_providers/{providerId}

Update an authentication provider.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
providerId string Provider ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

{
  "_id": "string",
  "name": "string",
  "type": "string",
  "disabled": "boolean",
  "config": "object"
}
Field Type Description
_id string  
name string  
type string

Possible Values:

  • mongodb-cloud
  • local
disabled boolean  
config object  

Responses

204: Successfully updated.

put
/groups/{groupId}/apps/{appId}/auth_providers/{providerId}/disable

Disable an authentication provider.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
providerId string Provider ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: Successfully disabled.

put
/groups/{groupId}/apps/{appId}/auth_providers/{providerId}/enable

Enable an authentication provider.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
providerId string Provider ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: Successfully enabled.

Email APIs

post
/groups/{groupId}/apps/{appId}/user_registrations/by_email/{email}/send_confirm

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
email string Email address

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully sent.

Functions APIs

post
/groups/{groupId}/apps/{appId}/debug/execute_function

Execute a function for testing.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

201: Successfully executed.

post
/groups/{groupId}/apps/{appId}/debug/execute_function_source

Execute a function’s source code for testing.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Query Parameters

Name Type Description
user_id string The user as which to execute the function.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

The source to execute.

{
  "eval_source": "string",
  "source": "string"
}
Field Type Description
eval_source string  
source string  

Responses

200: Successfully executed.

{
  "error": "object",
  "logs": "Any",
  "result": "object",
  "stats": "Any"
}
Field Type Description
error object  
logs any  
result object  
stats object  
get
/groups/{groupId}/apps/{appId}/functions

List functions.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully listed.

[
  {
    "_id": "string",
    "name": "string"
  }
]
Field Type Description
[] array of objects  
[]._id string  
[].name string  
post
/groups/{groupId}/apps/{appId}/functions

Create a new function.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

The function to create

{
  "can_evaluate": "Any",
  "name": "string",
  "private": "boolean",
  "source": "string"
}
Field Type Description
can_evaluate any  
name string  
private boolean  
source string  

Responses

201: The function was successfully created.

{
  "can_evaluate": "Any",
  "name": "string",
  "private": "boolean",
  "source": "string"
}
Field Type Description
can_evaluate any  
name string  
private boolean  
source string  
get
/groups/{groupId}/apps/{appId}/functions/{functionId}

Retrieve a function.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
functionId string Function ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: The function was successfully retrieved.

{
  "_id": "string",
  "can_evaluate": "Any",
  "name": "string",
  "private": "boolean",
  "source": "string"
}
Field Type Description
_id string  
can_evaluate any  
name string  
private boolean  
source string  
delete
/groups/{groupId}/apps/{appId}/functions/{functionId}

Delete a function.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
functionId string Function ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: The function was successfully deleted.

put
/groups/{groupId}/apps/{appId}/functions/{functionId}

Update a function.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
functionId string Function ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: The function was successfully updated.

{
  "can_evaluate": "Any",
  "name": "string",
  "private": "boolean",
  "source": "string"
}
Field Type Description
can_evaluate any  
name string  
private boolean  
source string  

Logging APIs

get
/groups/{groupId}/apps/{appId}/logs

Retrieve Stitch logs.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Query Parameters

Name Type Description
co_id string Return only log messages associated with the given request ID.
errors_only boolean Whether to only return errors.
user_id string Return only log messages associated with the given user_id.
before string The date and time in ISO 8601 at which to begin returning results, exclusive.
after string The date and time in ISO 8601 at which to cease returning results, inclusive.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully retrieved.

[
  {
    "_id": "string",
    "co_id": "string",
    "domain_id": "string",
    "app_id": "string",
    "group_id": "string",
    "request_url": "string",
    "request_method": "string",
    "started": "string",
    "completed": "string",
    "error": "string",
    "error_code": "string",
    "status": "integer"
  }
]
Field Type Description
[] array of objects  
[]._id string  
[].co_id string  
[].domain_id string  
[].app_id string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
[].group_id string An Atlas Project/Group ID.
[].request_url string  
[].request_method string  
[].started string  
[].completed string  
[].error string  
[].error_code string  
[].status integer  

Notifications APIs

get
/groups/{groupId}/apps/{appId}/push/notifications

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Query Parameters

Name Type Description
state string

Only list notifications with the given state.

Possible Values:

  • sent
  • draft

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully listed.

[
  {
    "_id": "string",
    "appID": "string",
    "label": "string",
    "message": "string",
    "topic": "string",
    "created": "string",
    "sent": "string",
    "state": "string"
  }
]
Field Type Description
[] array of objects  
[]._id string  
[].appID string  
[].label string  
[].message string  
[].topic string  
[].created string  
[].sent string  
[].state string

Possible Values:

  • sent
  • draft
post
/groups/{groupId}/apps/{appId}/push/notifications

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

The notification to create.

{
  "label": "string",
  "message": "string",
  "topic": "string",
  "state": "string"
}
Field Type Description
label string  
message string  
topic string  
state string

Possible Values:

  • sent
  • draft

Responses

201: Successfully created.

get
/groups/{groupId}/apps/{appId}/push/notifications/{messageId}

Retrieve a push notification message.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
messageId string Message ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully retrieved.

{
  "_id": "string",
  "appID": "string",
  "label": "string",
  "message": "string",
  "topic": "string",
  "created": "string",
  "sent": "string",
  "state": "string"
}
Field Type Description
_id string  
appID string  
label string  
message string  
topic string  
created string  
sent string  
state string

Possible Values:

  • sent
  • draft
delete
/groups/{groupId}/apps/{appId}/push/notifications/{messageId}

Delete a push notification message.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
messageId string Message ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: Successfully deleted.

put
/groups/{groupId}/apps/{appId}/push/notifications/{messageId}

Update a push notification message.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
messageId string Message ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully updated.

{
  "_id": "string",
  "appID": "string",
  "label": "string",
  "message": "string",
  "topic": "string",
  "created": "string",
  "sent": "string",
  "state": "string"
}
Field Type Description
_id string  
appID string  
label string  
message string  
topic string  
created string  
sent string  
state string

Possible Values:

  • sent
  • draft
put
/groups/{groupId}/apps/{appId}/push/notifications/{messageId}/type

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
messageId string Message ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully set.

post
/groups/{groupId}/apps/{appId}/push/notifications/{messageId}/send

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
messageId string Message ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully sent.

Rules APIs

get
/groups/{groupId}/apps/{appId}/services/{serviceId}/rules

List rules.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully listed.

[
  {
    "name": "string",
    "actions": "Any",
    "when": "object"
  }
]
Field Type Description
[] array of objects  
[].name string  
[].actions array  
[].when object  
post
/groups/{groupId}/apps/{appId}/services/{serviceId}/rules

Create a rule.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

The rule to create.

{
  "name": "string",
  "actions": "Any",
  "when": "object"
}
Field Type Description
name string  
actions array  
when object  

Responses

201: Successfully created.

{
  "_id": "string",
  "name": "string"
}
Field Type Description
_id string  
name string  

409: There is already a rule with the given name.

get
/groups/{groupId}/apps/{appId}/services/{serviceId}/rules/{ruleId}

Retrieve a rule.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID
ruleId string Rule ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully retrieved.

{
  "name": "string",
  "actions": "Any",
  "when": "object"
}
Field Type Description
name string  
actions array  
when object  
delete
/groups/{groupId}/apps/{appId}/services/{serviceId}/rules/{ruleId}

Delete a rule.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID
ruleId string Rule ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: Successfully deleted.

put
/groups/{groupId}/apps/{appId}/services/{serviceId}/rules/{ruleId}

Update a rule.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID
ruleId string Rule ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

The new state of the rule.

{
  "name": "string",
  "actions": "Any",
  "when": "object"
}
Field Type Description
name string  
actions array  
when object  

Responses

200: Successfully updated.

Security APIs

get
/groups/{groupId}/apps/{appId}/security/allowed_request_origins

List the allowed HTTP origins from which Stitch should allow requests.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully listed.

[
  "string"
]
Field Type Description
[] array of strings  
post
/groups/{groupId}/apps/{appId}/security/allowed_request_origins

Set the allowed HTTP origins from which Stitch should allow requests.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

A list of HTTP origins.

[
  "string"
]
Field Type Description
[] array of strings  

Responses

204: The allowed HTTP origins were successfully set.

Services APIs

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

List all services within an application.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully listed services.

[
  {
    "_id": "string",
    "name": "string",
    "type": "string",
    "version": "integer"
  }
]
Field Type Description
[] array of objects  
[]._id string  
[].name string  
[].type string  
[].version integer  
post
/groups/{groupId}/apps/{appId}/services

Create a service.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

201: Successfully created the service.

{
  "name": "string",
  "type": "string",
  "config": "object"
}
Field Type Description
name string  
type string  
config object  

409: There is already a service with the given name.

get
/groups/{groupId}/apps/{appId}/services/{serviceId}

Retrieve a service.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: The service was successfully deleted.

{
  "_id": "string",
  "name": "string",
  "type": "string",
  "version": "integer"
}
Field Type Description
_id string  
name string  
type string  
version integer  
delete
/groups/{groupId}/apps/{appId}/services/{serviceId}

Delete a service.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: The service was successfully deleted.

patch
/groups/{groupId}/apps/{appId}/services/{serviceId}

Update a service.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully updated.

post
/groups/{groupId}/apps/{appId}/services/{serviceId}/commands/{commandName}

Run a command associated with a service.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID
commandName string Command name

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully executed.

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

Retrieve a service’s configuration.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully retrieved.

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

Update a service’s configuration.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully updated.

get
/groups/{groupId}/apps/{appId}/services/{serviceId}/rules

List rules.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully listed.

[
  {
    "name": "string",
    "actions": "Any",
    "when": "object"
  }
]
Field Type Description
[] array of objects  
[].name string  
[].actions array  
[].when object  
post
/groups/{groupId}/apps/{appId}/services/{serviceId}/rules

Create a rule.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

The rule to create.

{
  "name": "string",
  "actions": "Any",
  "when": "object"
}
Field Type Description
name string  
actions array  
when object  

Responses

201: Successfully created.

{
  "_id": "string",
  "name": "string"
}
Field Type Description
_id string  
name string  

409: There is already a rule with the given name.

get
/groups/{groupId}/apps/{appId}/services/{serviceId}/rules/{ruleId}

Retrieve a rule.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID
ruleId string Rule ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully retrieved.

{
  "name": "string",
  "actions": "Any",
  "when": "object"
}
Field Type Description
name string  
actions array  
when object  
delete
/groups/{groupId}/apps/{appId}/services/{serviceId}/rules/{ruleId}

Delete a rule.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID
ruleId string Rule ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: Successfully deleted.

put
/groups/{groupId}/apps/{appId}/services/{serviceId}/rules/{ruleId}

Update a rule.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID
ruleId string Rule ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

The new state of the rule.

{
  "name": "string",
  "actions": "Any",
  "when": "object"
}
Field Type Description
name string  
actions array  
when object  

Responses

200: Successfully updated.

get
/groups/{groupId}/apps/{appId}/services/{serviceId}/incoming_webhooks

List webhooks.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully listed incoming webhooks.

{
  "name": "string",
  "function_source": "string",
  "respond_result": "boolean",
  "options": {
    "secret": "string",
    "secretAsQueryParam": "boolean"
  }
}
Field Type Description
name string  
function_source string  
respond_result boolean  
options object  
options.secret string  
options.secretAsQueryParam boolean  
post
/groups/{groupId}/apps/{appId}/services/{serviceId}/incoming_webhooks

Create a webhook.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

The webhook to create.

{
  "name": "string",
  "function_source": "string",
  "respond_result": "boolean",
  "options": {
    "secret": "string",
    "secretAsQueryParam": "boolean"
  }
}
Field Type Description
name string  
function_source string  
respond_result boolean  
options object  
options.secret string  
options.secretAsQueryParam boolean  

Responses

201: Successfully created.

get
/groups/{groupId}/apps/{appId}/services/{serviceId}/incoming_webhooks/{incomingWebhookId}

Retrieve a webhook.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID
incomingWebhookId string Incoming webhook ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully retrieved.

delete
/groups/{groupId}/apps/{appId}/services/{serviceId}/incoming_webhooks/{incomingWebhookId}

Delete a webhook.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID
incomingWebhookId string Incoming webhook ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: Successfully deleted.

put
/groups/{groupId}/apps/{appId}/services/{serviceId}/incoming_webhooks/{incomingWebhookId}

Update a webhook.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID
incomingWebhookId string Incoming webhook ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

The updated state of the webhook.

{
  "name": "string",
  "function_source": "string",
  "respond_result": "boolean",
  "options": {
    "secret": "string",
    "secretAsQueryParam": "boolean"
  }
}
Field Type Description
name string  
function_source string  
respond_result boolean  
options object  
options.secret string  
options.secretAsQueryParam boolean  

Responses

200: Successfully updated.

Users APIs

get
/groups/{groupId}/apps/{appId}/users

List users.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully listed.

[
  {
    "_id": "string",
    "identities": "Any",
    "type": "string",
    "creation_date": "integer",
    "last_authentication_date": "integer",
    "disabled": "boolean",
    "data": "object"
  }
]
Field Type Description
[] array of objects  
[]._id string  
[].identities array  
[].type string  
[].creation_date integer  
[].last_authentication_date integer  
[].disabled boolean  
[].data object  
post
/groups/{groupId}/apps/{appId}/users

Create a user.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

The user to create

{
  "email": "string",
  "password": "string"
}
Field Type Description
email string  
password string  

Responses

201: Successfully created.

{
  "_id": "string",
  "identities": "Any",
  "type": "string",
  "creation_date": "integer",
  "last_authentication_date": "integer",
  "disabled": "boolean",
  "data": "object"
}
Field Type Description
_id string  
identities array  
type string  
creation_date integer  
last_authentication_date integer  
disabled boolean  
data object  
get
/groups/{groupId}/apps/{appId}/users/{uid}

Retrieve a user.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
uid string UID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully retrieved.

{
  "_id": "string",
  "identities": "Any",
  "type": "string",
  "creation_date": "integer",
  "last_authentication_date": "integer",
  "disabled": "boolean",
  "data": "object"
}
Field Type Description
_id string  
identities array  
type string  
creation_date integer  
last_authentication_date integer  
disabled boolean  
data object  
delete
/groups/{groupId}/apps/{appId}/users/{uid}

Delete a user.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
uid string UID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: Successfully deleted.

get
/groups/{groupId}/apps/{appId}/users/{uid}/devices

List a user’s devices.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
uid string UID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully listed.

[
  "object"
]
Field Type Description
[] array of objects  
put
/groups/{groupId}/apps/{appId}/users/{uid}/logout

Revoke all of a user’s sessions.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
uid string UID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: Successfully revoked.

put
/groups/{groupId}/apps/{appId}/users/{uid}/enable

Enable a user.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
uid string UID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: Successfully enabled.

put
/groups/{groupId}/apps/{appId}/users/{uid}/disable

Disable a user.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
uid string UID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: Successfully disabled.

Values APIs

get
/groups/{groupId}/apps/{appId}/values

List all Values defined in an application.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Values were successfully enumerated.

[
  {
    "_id": "string",
    "name": "string",
    "private": "boolean"
  }
]
Field Type Description
[] array of objects  
[]._id string  
[].name string  
[].private boolean  
post
/groups/{groupId}/apps/{appId}/values

Define a Value in an application.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

The value to create.

{
  "name": "string",
  "private": "boolean",
  "value": "Any"
}
Field Type Description
name string  
private boolean  
value any  

Responses

201: The Value was successfully defined.

{
  "name": "string",
  "private": "boolean",
  "value": "Any"
}
Field Type Description
name string  
private boolean  
value any  
get
/groups/{groupId}/apps/{appId}/values/{valueId}

Retrieve a Value definition from an application.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
valueId string Value ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully retrieved the value.

{
  "_id": "string",
  "name": "string",
  "private": "boolean",
  "value": "Any"
}
Field Type Description
_id string  
name string  
private boolean  
value any  
delete
/groups/{groupId}/apps/{appId}/values/{valueId}

Delete a Value defined in an application.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
valueId string Value ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: Successfully deleted the value.

put
/groups/{groupId}/apps/{appId}/values/{valueId}

Update a Value definition in an application.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
valueId string Value ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully updated the value.

[
  {
    "name": "string",
    "private": "boolean",
    "value": "Any"
  }
]
Field Type Description
[] array of objects  
[].name string  
[].private boolean  
[].value any  

Incoming Webhook APIs

get
/groups/{groupId}/apps/{appId}/services/{serviceId}/incoming_webhooks

List webhooks.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully listed incoming webhooks.

{
  "name": "string",
  "function_source": "string",
  "respond_result": "boolean",
  "options": {
    "secret": "string",
    "secretAsQueryParam": "boolean"
  }
}
Field Type Description
name string  
function_source string  
respond_result boolean  
options object  
options.secret string  
options.secretAsQueryParam boolean  
post
/groups/{groupId}/apps/{appId}/services/{serviceId}/incoming_webhooks

Create a webhook.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

The webhook to create.

{
  "name": "string",
  "function_source": "string",
  "respond_result": "boolean",
  "options": {
    "secret": "string",
    "secretAsQueryParam": "boolean"
  }
}
Field Type Description
name string  
function_source string  
respond_result boolean  
options object  
options.secret string  
options.secretAsQueryParam boolean  

Responses

201: Successfully created.

get
/groups/{groupId}/apps/{appId}/services/{serviceId}/incoming_webhooks/{incomingWebhookId}

Retrieve a webhook.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID
incomingWebhookId string Incoming webhook ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

200: Successfully retrieved.

delete
/groups/{groupId}/apps/{appId}/services/{serviceId}/incoming_webhooks/{incomingWebhookId}

Delete a webhook.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID
incomingWebhookId string Incoming webhook ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Responses

204: Successfully deleted.

put
/groups/{groupId}/apps/{appId}/services/{serviceId}/incoming_webhooks/{incomingWebhookId}

Update a webhook.

Path Parameters

Name Type Description
groupId string An Atlas Project/Group ID.
appId string The ObjectID of your application. Project & Application IDs demonstrates how to find this value.
serviceId string Service ID
incomingWebhookId string Incoming webhook ID

Header Parameters

Name Type Description
Authorization string The authorization token provided in the access_token field of the POST /auth/providers/{provider}/login and POST /auth/session API endpoints.

Request Body

The updated state of the webhook.

{
  "name": "string",
  "function_source": "string",
  "respond_result": "boolean",
  "options": {
    "secret": "string",
    "secretAsQueryParam": "boolean"
  }
}
Field Type Description
name string  
function_source string  
respond_result boolean  
options object  
options.secret string  
options.secretAsQueryParam boolean  

Responses

200: Successfully updated.

←   Billing