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

Delete One S3-Compatible Blockstore Configuration

On this page

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

Deletes the configuration of one s3 blockstore.

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

DELETE /snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}
Name
Type
Description
S3-BLOCKSTORE-CONFIG-ID
string
The unique name that labels this S3 blockstore configuration.

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
envelope
Expected response body
false

This endpoint doesn't use HTTP request body parameters.

This endpoint does not have response elements.

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
--include \
--request DELETE 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}'

This endpoint doesn't return a response body.

Back

Update One S3 Blockstore Configuration

Next

Oplog Store Configurations