Navigation

Get One Backup Configuration from One Project

Note

Groups and projects are synonymous terms. Your {GROUP-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/{GROUP-ID}/backupConfigs/{CLUSTER-ID}

Request Parameters

Request Path Parameters

Parameter Type Description
GROUP-ID string (Required.) The unique identifier for the group that holds the cluster with the backup configuration you want to find.
CLUSTER-ID string (Required.) The unique indentifier of the cluster whose backup configuration you want to find.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Cloud Manager API resources. These are all optional.

Name Type Description Default
pretty boolean Indicates whether the response body should be in a prettyprint format. false
envelope boolean

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:

status
HTTP response code
envelope
The expected response body
false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response

Name Type Description
clusterId string Unique identifier of the cluster that this backup configuration is for.
excludedNamespaces string array

A 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 identifier of the group that owns this backup configuration.
includedNamespaces string array

A 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. The relations between URLs are explained in the Web Linking Specification
sslEnabled boolean Is SSL enabled for the sync source database?
statusName string

The current (or desired) status of the backup configuration. Possible values are:

  • INACTIVE
  • PROVISIONING
  • STARTED
  • STOPPED
  • TERMINATING
storageEngineName string

The storage engine used for the backup. Possible values are:

  • MEMORY_MAPPED
  • WIRED_TIGER

Example Request

curl --user "{username}:{apiKey}" --digest \
 --header "Accept: application/json" \
 --include
 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/backupConfigs/{CLUSTER-ID}"

Example Response

Response Header

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}

Response Body

{
  "clusterId" : "{CLUSTER-ID}",
  "excludedNamespaces" : [ ],
  "groupId" : "{GROUP-ID}",
  "includedNamespaces" : [ ],
  "links" : []
  "sslEnabled" : false,
  "statusName" : "STARTED",
  "storageEngineName" : "WIRED_TIGER"
}