Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

Update One Backup Daemon Configuration

On this page

  • Resource
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response
  • Response Header
  • Response Body

Updates the configuration of one Backup Daemon.

Note

Use this endpoint when you want to update one Backup Daemon that you've already configured.

If you have not already configured the Backup Daemon, configure it with the Create One Backup Daemon Configuration endpoint.

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup

PUT /daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}
Name
Type
Necessity
Description

MACHINE

string

Required

Hostname or IP address of the machine that serves the Backup Daemon.

HEAD-ROOT-DIRECTORY

string

Required

Root-relative URL-encoded path of the head directory on this Backup Daemon host.

Requests encode slashes in the URL path. For example, for Linux platforms, you should add the head directory in this format:

http://localhost:8080/api/public/v1.0/admin/backup/
daemon/config/localhost/%2Fdata%2Fbackup%2F

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

Name
Type
Necessity
Description

assignmentEnabled

boolean

Optional

Flag indicating whether this Backup Daemon can be assigned backup jobs.

backupJobsEnabled

boolean

Optional

Flag indicating whether this Backup Daemon can be used to backup databases.

configured

boolean

Optional

Flag indicating whether this Backup Daemon is ready to use.

garbageCollectionEnabled

boolean

Optional

Flag indicating whether this Backup Daemon has garbage collection set.

headDiskType

string

Optional

Type of disk used to store the head directory.

The accepted values for this option are:

  • HDD

  • SSD

id

string

Required

Unique identifier of this Backup Daemon.

labels

array of strings

Optional

Array of tags to manage which backup jobs Ops Manager can assign to which Backup Daemons.

Setting these tags limits which backup jobs this Backup Daemon can process. If omitted, this Backup Daemon can only process backup jobs for projects that do not use labels to filter their jobs.

machine

object

Required

machine.headRootDirectory

string

Optional

Root-relative path of the head directory on this Backup Daemon host. This directory must end with a slash (/). If you omit the slash, the Backup Daemon generates a Java Exception error.

machine.machine

string

Required

Hostname or IP address of the Backup Daemon host.

numWorkers

number

Optional

Number of worker processes that can perform tasks (i.e. backup, restore, or groom) for the Backup Daemon.

resourceUsageEnabled

boolean

Optional

Flag indicating whether this Backup Daemon has its resource usage monitored.

restoreQueryableJobsEnabled

boolean

Optional

Flag indicating whether this Backup Daemon can perform queryable restores.

Name
Type
Description

assignmentEnabled

boolean

Flag indicating whether this Backup Daemon can be assigned backup jobs.

backupJobsEnabled

boolean

Flag indicating whether this Backup Daemon can be used to backup databases.

configured

boolean

Flag indicating whether this Backup Daemon is ready to use.

garbageCollectionEnabled

boolean

Flag indicating whether this Backup Daemon has garbage collection set.

headDiskType

string

Type of disk used to store the head directory.

The accepted values for this option are:

  • HDD

  • SSD

id

string

Unique identifier of this Backup Daemon.

labels

array of strings

Array of tags to manage which backup jobs Ops Manager can assign to which Backup Daemons.

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.

machine

object

machine.headRootDirectory

string

Root-relative path of the head directory on this Backup Daemon host.

machine.machine

string

Hostname or IP address of the Backup Daemon host.

numWorkers

number

Number of worker processes that can perform tasks (i.e. backup, restore, or groom) for the Backup Daemon.

resourceUsageEnabled

boolean

Flag indicating whether this Backup Daemon has its resource usage monitored.

restoreQueryableJobsEnabled

boolean

Flag indicating whether this Backup Daemon can perform queryable restores.

1curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
2 --header 'Accept: application/json' \
3 --header 'Content-Type: application/json' \
4 --include \
5 --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}?pretty=true' \
6 --data '{
7 "assignmentEnabled" : true,
8 "backupJobsEnabled" : false,
9 "configured" : true,
10 "garbageCollectionEnabled" : true,
11 "headDiskType" : "SSD",
12 "labels" : [ "l1", "l2" ],
13 "machine" : {
14 "headRootDirectory" : "/data/backup/",
15 "machine" : "localhost"
16 },
17 "numWorkers" : 50,
18 "resourceUsageEnabled" : true,
19 "restoreQueryableJobsEnabled" : true
20 }'
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}
1{
2 "assignmentEnabled" : true,
3 "backupJobsEnabled" : false,
4 "configured" : true,
5 "garbageCollectionEnabled" : true,
6 "headDiskType" : "SSD",
7 "id" : "5991a422ad5df350005dd062",
8 "labels" : [ "l1", "l2" ],
9 "links" : [ {
10 "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}",
11 "rel" : "self"
12 }],
13 "machine" : {
14 "headRootDirectory" : "/data/backup/",
15 "machine" : "localhost"
16 },
17 "numWorkers" : 50,
18 "resourceUsageEnabled" : true,
19 "restoreQueryableJobsEnabled" : true
20}

Back

Create