- API >
- Public API Resources >
- Backup and Restore >
- Backup Configurations >
- Get One Backup Configuration from a Group
Get One Backup Configuration from a Group¶
On this page
Base URL: {opsManagerHost}:{port}
¶
Syntax¶
Request Parameters¶
Request Path Parameters¶
Parameter | Required/Optional | Description |
---|---|---|
GROUP-ID |
Required. | The unique identifier for the group that holds the cluster with the backup configuration you want to find. |
CLUSTER-ID |
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 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 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
groupId |
string | ID of the group that owns this backup configuration. | ||||||||||
clusterId |
string | ID of the cluster that this backup configuration is for. | ||||||||||
statusName |
string | The current (or desired) status of the backup configuration. Possible values are:
|
||||||||||
storageEngineName |
string | The storage engine used for the backup. Possible values are:
|
||||||||||
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. |
||||||||||
sslEnabled |
boolean | Is SSL enabled for the sync source database? | ||||||||||
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
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 | A 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 |
string array |
|