Get All Databases on One Host

On this page

Resource

Request Path Parameters
Request Query Parameters
Request Body Parameters
Response
Response Document
results Embedded Document
Example Request
Example Response
Response Header
Response Body

Retrieve all databases running on the specified host.

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

Resource

GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/databases

Request Path Parameters

Parameter	Type	Description
PROJECT-ID	string	(Required.) Unique identifier of the project that owns this MongoDB process.
HOST-ID	string	(Required.) Unique identifier of the host running the MongoDB process.

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

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`	array	Array includes one object for each item detailed in the `results` Embedded Document section.
`links`	array	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	Integer 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 database.

Name	Type	Description
`databaseName`	string	The name of the database.
`links`	array	Links to the group that the database belongs to, the MongoDB host running the database, and database measurements. The relations between URLs are explained in the Web Linking Specification.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://<ops-manager-host>/api/public/v1.0/groups/533c5895b910306f21033a/hosts/fd5b59188dc13ad142493/databases"

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

{
  "links" : [],
  "results" : [ {
    "databaseName" : "local",
    "links" : []
  }, {
    "databaseName" : "production",
    "links" : []
  }, {
    "databaseName" : "test",
    "links" : []
  }, ],
  "totalCount" : 3
}

Back

Databases

Get by Name