• API >
• Public API Resources >
• Deployments >
• Disks >
• Get all Disk Partitions

Get all Disk Partitions

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.

Retrieves all disk partitions on the specified host.

Base URL: https://cloud.mongodb.com/api/public/v1.0

Resource

copy

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

Request Path Parameters

Parameter	Type	Description
PROJECT-ID	string	(Required.) Unique identifier of the project where the disk partition resides.
HOST-ID	string	(Required.) Unique identifier of the host where the disk partition resides.

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

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	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 disk.

Name	Type	Description
partitionName	string	The name of the disk partition.
links	array	Links to related subresources. All links arrays in responses contain at least one link called self.

Example Request

copy

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/533c5895b910306f21033a/hosts/814e70da8167883b9939608a12a/disks"

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

copy

{
  "results" : [ {
    "links" : [],
    "partitionName" : "xvdf"
  }, ... ],
  "links" : [],
  "totalCount" : 4
}

←   Disks Get a Disk Partition  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.