Docs Menu
Docs Home
/
MongoDB Cloud Manager
/ / / /

Get One Backup Configuration from One Project

On this page

  • Resource
  • Request Parameters
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response
  • Response Header
  • Response Body

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

GET /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}
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.

The following query parameters are optional:

Name
Type
Necessity
Description
Default
pretty
boolean
Optional
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:

Name
Description
status
HTTP response code
envelope
Expected response body
false

This endpoint doesn't use HTTP request body parameters.

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 {database} or {database}.{collection}. If this field is present the includedNamespaces field cannot be present.

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 syncSource field, as the removal of an excluded namespace necessitates a full resync. Without the syncSource field, the request will fail.

If the new list only adds to the previous list, you do not need to set syncSource.

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 {database} or {database}.{collection}. Any namespace not listed in this array will not be backed up. If this field is present the excludedNamespaces field cannot be present.

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 syncSource field, as the addition of an included namespace necessitates a full resync. Without the syncSource field, the request will fail.

If the new list only removes namespaces from the previous list, you do not need to set syncSource.

links
object array

One or more links to sub-resources and/or related resources. All links arrays in responses include at least one link called self. The relationships between URLs are explained in the Web Linking Specification.

preferredMember
string
Cluster member manually designated as the preferred member for backup. Appears only for member requests when the preferred member is set with the UI or API.
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:

  • INACTIVE

  • PROVISIONING

  • STARTED

  • STOPPED

  • TERMINATING

storageEngineName
string

Storage engine used for the backup. Possible values are:

  • MEMORY_MAPPED

  • WIRED_TIGER

HTTP/1.1 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
HTTP/1.1 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}
←  Get All Backup Configurations from One Project