Navigation

Get All S3 Oplog Configurations

Retrieves the configurations of all s3 oplog stores.

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

Resource

GET /oplog/s3Configs

Request Path Parameters

This endpoint does not use HTTP request path parameters.

Request Query Parameters

Name Type Description Default
pageNum integer Page number (1-based). 1
itemsPerPage integer Maximum number of items to return, up to a maximum of 100. 100
pretty boolean Indicates whether the response body should be in a prettyprint format. false
envelope boolean

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 results object is an envelope. Ops Manager adds the status field to the response body.

false
assignableOnly boolean Flag indicating whether this S3 oplog store can be assigned new backup jobs. true

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response

Response Document

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Name Type Description
results object array This array includes one object for each item detailed in the results Embedded Document section.
links object array This array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCount number The count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

results Embedded Document

Each result is one s3 oplog store.

Name Type Description
assignmentEnabled boolean Flag indicating whether this data store can be assigned backup jobs.
awsAccessKey string The AWS Access Key ID that can access the S3 bucket specified in <s3BucketName>.
awsSecretKey string The AWS Secret Access Key that can access the S3 bucket specified in <s3BucketName>.
encryptedCredentials boolean Flag indicating whether the username and password for this S3 oplog store were encrypted using the credentialstool.
id string The unique name that labels this S3 oplog store.
labels array of strings Array of tags to manage which backup jobs Ops Manager can assign to which S3 oplog stores.
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
pathStyleAccessEnabled boolean Optional. Flag indicating whether this S3 oplog store uses a path-style URL endpoint (s3.amazonaws.com/<bucket>) instead of a virtual-host-style URL endpoint (<bucket>.s3.amazonaws.com).
s3BucketEndpoint string The URL used to access this AWS S3 or S3-compatible bucket.
s3BucketName string The name of the S3 bucket that hosts the S3 oplog store.
sseEnabled boolean
Optional. Flag indicating whether this S3 blockstore
enables server-side encryption.
uri string A comma-separated list of hosts in the <hostname:port> format that can be used to access this S3 oplog store.
ssl boolean Flag indicating whether this S3 oplog store only accepts connections encrypted using TLS.
writeConcern string

The write concern used for this oplog store.

The accepted values for this option are:
  • ACKNOWLEDGED
  • W2
  • JOURNALED
  • MAJORITY

See also

To learn about write acknowledgement levels in MongoDB, see Write Concern

Example Request

curl --user '{USERNAME}:{APIKEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs?pretty=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}

Response Body

{
  "links" : [ {
    "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
  "assignmentEnabled": true,
  "awsAccessKey": "access",
  "awsSecretKey": "secret",
  "encryptedCredentials": false,
  "id": "id",
  "labels": [
    "l1",
    "l2"
  ],
  "links": [
    {
      "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs/{S3-OPLOG-ID}",
      "rel": "self"
    }
  ],
  "s3BucketEndpoint": "http://backup.example.com/oplog",
  "s3BucketName": "oplog",
  "uri": "mongodb://localhost:27017",
  "ssl": true,
  "writeConcern": "W2"
  } ],
  "totalCount" : 1
}