Navigation
You were redirected from a different version of the documentation. Click here to go back.

Get All Backup Configurations for a Group

Base URL: {opsManagerHost}:{port}

Syntax

GET /api/public/v1.0/groups/{GROUP-ID}/backupConfigs

Request Parameters

Request Path Parameters

Parameter Required/Optional Description
GROUP-ID Required. The unique identifier for the group.

Request Query Parameters

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

Name Type Description Default
pageNum integer Page number (1-based). 1
itemsPerPage integer Maximum number of items to return, up to a maximum of 100. 100
pretty boolean Display response in human-readable format. false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

Name Type Description
totalCount integer Positive integer that counts the number of backup configurations present in the group.
results document array A list of documents that explain the backup configurations.
results.groupId string ID of the group that owns this backup configuration.
results.clusterId string ID of the cluster that this backup configuration is for.
results.statusName string

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

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

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

  • MEMORY_MAPPED
  • WIRED_TIGER
results.encryptionEnabled boolean Specifies whether encryption is enabled for the backup configuration. You must include the syncSource field when enabling encryption for a backup configuration. For existing backups in a group, enabling encryption requires an initial backup sync to recreate the backups’ head databases.
results.sslEnabled boolean Is SSL enabled for the sync source database?
results.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.

results.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.

Examples

Example Request

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

Example Response

HTTP/1.1 200 OK
 {
   "totalCount" : 3,
   "results" : [ {
     "groupId" : "5196d3628d022db4cbc26d9e",
     "clusterId" : "5196e5b0e4b0fca9cc88334a",
     "statusName" : "STARTED",
     "storageEngineName" : "WIRED_TIGER",
     "encryptionEnabled" : true,
     "sslEnabled" : false,
     "excludedNamespaces" : [ ],
     "includedNamespaces" : [ ]
   }, {
     "groupId" : "5196d3628d022db4cbc26d9e",
     "clusterId" : "51a2ac88e4b0371c2dbf46ea",
     "statusName" : "STARTED",
     "storageEngineName" : "MEMORY_MAPPED",
     "encryptionEnabled" : true,
     "sslEnabled" : false,
     "excludedNamespaces" : [ ],
     "includedNamespaces" : [ ]
   }, {
     "groupId" : "5196d3628d022db4cbc26d9e",
     "clusterId" : "52d33abee4b0ca49bc6acd6c",
     "statusName" : "STOPPED",
     "storageEngineName" : "WIRED_TIGER",
     "encryptionEnabled" : false,
     "sslEnabled" : false,
     "excludedNamespaces" : [ ],
     "includedNamespaces" : [ ]
   } ]
}