Get All Deployment Regions

On this page

Resource

Request Parameters
Request Query Parameters
Request Body Parameters
Response
Example Request
Request Body
Response Body

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

Request Parameters

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 `envelope : true` in the query. For endpoints that return a list of results, the `content` object is an envelope. Ops Manager adds the `status` field to the response body.	`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 `links` arrays in responses include at least one link called `self`. The relationships between URLs are explained in the Web Linking Specification.
`restoreEndpoint`	string	Ops Manager instance that serves restore requests.

Example Request

Request Body

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments"

Response Body

1 {
2   "links" : [ ],
3   "results" : [ {
4     "assignmentEnabled" : true,
5     "bqProxyEndpoint" : "queryable-backup.mongodb.com:27217",
6     "deploymentDescription" : "Eastern US",
7     "id" : "NY_NJ",
8     "ingestionEndpoint" : "https://api-backup.mongodb.com",
9     "links" : [ ],
10     "restoreEndpoint" : "https://api-backup.mongodb.com"
11   } ],
12   "totalCount" : 1
13 }

Back

Deployment Regions

Get One Deployment Region

1	{
2	"links" : [ ],
3	"results" : [ {
4	"assignmentEnabled" : true,
5	"bqProxyEndpoint" : "queryable-backup.mongodb.com:27217",
6	"deploymentDescription" : "Eastern US",
7	"id" : "NY_NJ",
8	"ingestionEndpoint" : "https://api-backup.mongodb.com",
9	"links" : [ ],
10	"restoreEndpoint" : "https://api-backup.mongodb.com"
11	} ],
12	"totalCount" : 1
13	}