Get One Deployment Region
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 /admin/backup/backupDeployments/{DEPLOYMENT-ID}
Request Parameters
Request Path Parameters
Parameter | Type | Necessity | Description |
|---|---|---|---|
DEPLOYMENT-ID | string | Required | Unique identifier that references the deployment region in
configurations. |
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 |
Request Body Parameters
This endpoint doesn't use HTTP request body parameters.
Response
Name | Type | Description |
|---|---|---|
assignmentEnabled | boolean | Flag indicating whether you can assign Deployment Regions to backup resources. |
bqProxyEndpoint | string | Ops Manager instance that serves Queryable Backup requests. Value
is in the following format: domain:port. For example,
localhost:8080. |
deploymentDescription | string | String that describes the purpose of the deployment region. |
id | string | Unique identifier that references this deployment region in
configurations. |
ingestionEndpoint | string | Ops Manager instance to which the Backup Agent writes snapshot or
oplog data. Value is a valid URL such as
http://www.mongodb.com. Supports both HTTP and HTTPS. |
links | object array | One or more links to sub-resources and/or related resources. All
|
restoreEndpoint | string | Ops Manager instance that serves restore requests. |
Example Request
curl --user "{publicKey}:{privateKey}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments/NY_NJ?pretty=true"
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 "assignmentEnabled" : true, 3 "bqProxyEndpoint" : "queryable-backup.mongodb.com:27217", 4 "deploymentDescription" : "Eastern US", 5 "id" : "NY_NJ", 6 "ingestionEndpoint" : "https://api-backup.mongodb.com", 7 "links" : [ ], 8 "restoreEndpoint" : "https://api-backup.mongodb.com" 9 }