Create One Deployment Region by ID

On this page

Resource

Request Parameters
Request Path Parameters
Request Query Parameters
Request Body Parameters
Response
Example Request
Example Response
Response Header
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

PUT /admin/backup/backupDeployments/{DEPLOYMENT-ID}

Request Parameters

Request Path Parameters

Path Parameter	Type	Necessity	Description
{DEPLOYMENT-ID}	string	Required	Unique identifier that references this deployment region in configurations.

Request Query Parameters

The following query parameters are optional:

Name

Type

Necessity

Description

Default

pretty

boolean

Optional

Flag indicating 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 one result, the response body includes:

Name	Description
`status`	HTTP response code
`content`	Expected response body

false

Request Body Parameters

Name	Type	Necessity	Description
`assignmentEnabled`	boolean	Optional	Flag indicating whether you can assign Deployment Regions to backup resources.
bqProxyEndpoint	string	Required	Ops Manager instance that serves Queryable Backup requests. Value is in the following format: `domain:port`. For example, `localhost:8080`.
deploymentDescription	string	Required	String that describes the purpose of the deployment region.
ingestionEndpoint	string	Reguired	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.
restoreEndpoint	string	Required	Ops Manager instance that serves restore requests.

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

curl --user "{publicKey}:{privateKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request PUT
     "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments/AU_NJ?pretty=true" \
     --data '
       {
         "ingestionEndpoint": "https://api-backup.mongodb.com",
         "restoreEndpoint": "https://api-backup.mongodb.com",
         "bqProxyEndpoint": "queryable-backup.mongodb.com:27217",
         "deploymentDescription": "Australia and New Zealand",
         "assignmentEnabled": true
       }'

Example Response

Response Header

HTTP/1.1 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

HTTP/1.1 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

{
  "assignmentEnabled" : true,
  "bqProxyEndpoint" : "queryable-backup.mongodb.com:27217",
  "deploymentDescription" : "Australia and New Zealand",
  "id" : "AU_NJ",
  "ingestionEndpoint" : "https://api-backup.mongodb.com",
  "links" : [ ],
  "restoreEndpoint" : "https://api-backup.mongodb.com"
}

Back

Create One Deployment Region

Assign One Deployment Region