- API >
- Public API Resources >
- Backup and Restore >
- Backup Configurations >
- Get One Backup Configuration from One Project
Get One Backup Configuration from One Project¶
On this page
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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
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 Ops Manager API resources. These are all optional.
Name | Type | Description | Default |
---|---|---|---|
pretty | boolean | Flag indicating whether the response body should be in a prettyprint format. | false |
envelope | boolean | Flag indicating 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 one result, response body includes:
|
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. |
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. |
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 |
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
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 | 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:
|
storageEngineName | string | The storage engine used for the backup. Possible values are:
|