Get All Backup Configurations for 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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/backupConfigs
Request Parameters
Request Path Parameters
Name | Type | Necessity | Description |
---|---|---|---|
PROJECT-ID | string | Required | Unique 24-hexadecimal digit string that identifies the
project to which the backup configuration applies. |
Request Query Parameters
The following query parameters are optional:
Name | Type | Necessity | Description | Default |
---|---|---|---|---|
pageNum | number | Optional | One-based integer that returns a subsection of results. | 1 |
itemsPerPage | number | Optional | Number of items to return per page, up to a maximum of 500. | 100 |
pretty | boolean | Optional | Flag that indicates 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 For endpoints that return a list of results, the | false |
backupJobsEnabledOnly | boolean | Optional | Flag indicating whether to exclude daemons not enabled for
backing up databases from the response. Set this to false to
include daemon configurations with the backupJobsEnabled
flag set to false . | true |
Request Body Parameters
This endpoint doesn't use HTTP request body parameters.
Response
Name | Type | Description |
---|---|---|
groupId | string | Unique 24-hexadecimal digit string that identifies the
project that owns this backup configuration. |
clusterId | string | Unique 24-hexadecimal digit string that identifies the cluster
whose backup configuration you want to find. |
statusName | string | Current (or desired) status of the backup configuration. Possible values are:
|
storageEngineName | string | Storage engine used for the backup. Possible values are:
|
encryptionEnabled | boolean | Flag that indicates whether encryption is enabled for the
backup configuration. You must include the FCV For more information on backup encryption for FCV 4.2 or later, see Encrypted Backup Snapshots. |
sslEnabled | boolean | Flag that indicates whether TLS is enabled for the sync source
database. |
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
|
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 |
Example Request
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs"
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}
Response Body
1 { 2 "totalCount" : 3, 3 "results" : [ { 4 "groupId" : "{PROJECT-ID}", 5 "clusterId" : "{CLUSTER-ID1}", 6 "statusName" : "STARTED", 7 "storageEngineName" : "WIRED_TIGER", 8 "sslEnabled" : false, 9 "excludedNamespaces" : [ ], 10 "includedNamespaces" : [ ], 11 "links" : [ ] 12 }, { 13 "groupId" : "{PROJECT-ID}", 14 "clusterId" : "{CLUSTER-ID2}", 15 "statusName" : "STARTED", 16 "storageEngineName" : "MEMORY_MAPPED", 17 "sslEnabled" : false, 18 "excludedNamespaces" : [ ], 19 "includedNamespaces" : [ ], 20 "links" : [ ] 21 }, { 22 "groupId" : "{PROJECT-ID}", 23 "clusterId" : "{CLUSTER-ID3}", 24 "statusName" : "STOPPED", 25 "storageEngineName" : "WIRED_TIGER", 26 "sslEnabled" : false, 27 "excludedNamespaces" : [ ], 28 "includedNamespaces" : [ ], 29 "links" : [ ] 30 } ], 31 "links" : [ ] 32 }