- API >
- Public API Resources >
- Backup and Restore >
- Backup Configurations >
- Get All Backup Configurations for One Project
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¶
Request Parameters¶
Request Path Parameters¶
Name | Type | Description |
---|---|---|
PROJECT-ID | string | (Required.) The unique identifier for the project. |
Request Query Parameters¶
The following query parameters are optional:
Name | Type | Description | Default |
---|---|---|---|
pageNum |
number | One-based integer that returns a subsection of results. | 1 |
itemsPerPage |
number | Number of items to return per page, up to a maximum of 500. | 100 |
pretty |
boolean | Flag that indicates whether the response body should be in a prettyprint format. | false |
envelope |
boolean | 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 |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Name | Type | Description |
---|---|---|
groupId | string | Unique identifier of the project that owns this backup configuration. |
clusterId | string | Unique identifier 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 project, 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 |