Docs Home → MongoDB Cloud Manager
Get One Backup Configuration from One Project
On this page
Note
Groups and projects are synonymous terms. Your {PROJECT-ID}
is the
same as your project id. For existing groups, your group/project id
remains the same. This page uses the more familiar term group when
referring to descriptions. The endpoint remains as stated in the
document.
Base URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}
Request Parameters
Request Path Parameters
Parameter | Type | Necessity | Description |
---|---|---|---|
PROJECT-ID | string | Required | Unique 24-hexadecimal digit string that identifies the
project that holds the cluster with the backup configuration you
want to find. |
CLUSTER-ID | string | Required | Unique 24-hexadecimal digit string that identifies the cluster
whose backup configuration you want to find. |
Request Query Parameters
The following query parameters are optional:
Name | Type | Necessity | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating whether the response body should be in a
prettyprint format. | false | ||||||
envelope | boolean | Optional | Flag that indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. For endpoints that return one result, the response body includes:
| false |
Request Body Parameters
This endpoint doesn't use HTTP request body parameters.
Response
Name | Type | Description |
---|---|---|
availableMembers | string array | List of cluster members available for backup. Appears only
for member requests. |
clusterId | string | Unique 24-hexadecimal digit string that identifies the cluster
to configure for backup. |
excludedNamespaces | string array | List of database names and collection names to omit from
the backup. Each string is a namespace in the form of
You must send the new full list of excluded namespaces, including any that were already listed. If the new list removes any namespaces from the previous
list, you must also set the If the new list only adds to the previous list, you do not
need to set |
groupId | string | Unique 24-hexadecimal digit string that identifies the
project that owns this backup configuration. |
includedNamespaces | string array | List of database names and collection names to include in
the backup. Each string is a namespace in the form of
You must send the new full list of included namespaces, including any that were already listed. If the new list adds any namespaces to the previous list, you
must also set the If the new list only removes namespaces from the previous
list, you do not need to set |
links | object array | One or more links to sub-resources and/or related resources. All
|
preferredMember | string | |
sslEnabled | boolean | Flag that indentifies whether TLS is enabled for the sync
source database. |
statusName | string | Current (or desired) status of the backup configuration. Possible values are:
|
storageEngineName | string | Storage engine used for the backup. Possible values are:
|
Example Request
Example Response
Response Header
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}