Create One Physical Host¶

On this page

Required Roles
Resource
Response
Example Request
Example Response
- Response Header
- Response Body

Required Roles¶

This resource requires the API Key to have the Global Owner role.

Resource¶

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

POST /usage/groups

Request Path Parameters¶

This endpoint does not use HTTP request path parameters.

Request Query Parameters¶

The following query parameters are optional:

Name Type Description Default

pageNum integer Page number (1-index based). 1

itemsPerPage integer Number of items to return per page, up to a maximum of 500. 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 one result, response body includes:

status	HTTP response code
envelope	Expected response body

For endpoints that return a list of results, the results object is an envelope. Ops Manager adds the status field to the response body.

None

Request Body Parameters¶

Body Parameter	Type	Necessity	Description
virtualHosts	array of strings	Required	List of virtual hosts bound to the provided physical host.
virtualHosts .groupId	string	Optional	Unique identifier of the project into which Ops Manager places this virtual host.
virtualHosts .hostname	string	Optional	FQDN of the virtual host bound to the physical host.
name	string	Required	Label you gave to the physical host. This value must be unique.
serverType	string	Required	Server Type of the physical host. You can set this to one of the following values: `DEV_SERVER` `TEST_SERVER` `PRODUCTION_SERVER` `RAM_POOL` See also MongoDB Usage

Response¶

Response Element	Type	Description
hosts	array of objects	List of virtual hosts bound to the provided physical host.
hosts .[n].groupId	string	Unique identifier of the project into which Ops Manager places this virtual host.
hosts .[n].hostname	string	FQDN of the virtual host bound to the physical host.
id	string	Unique identifier of the physical host to which Ops Manager bound the virtual hosts.
name	string	Label you gave to the physical host.
serverType	string	Server Type of the physical host. Ops Manager returns one of the following values: DEV_SERVER TEST_SERVER PRODUCTION_SERVER RAM_POOL See also MongoDB Usage

Example Request¶

copy

curl --user "{publicApiKey}:{privateApiKey}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pretty=true" \
     --data '{
               "name": "physicalHostA",
               "serverType":
                 {
                   "name": "PRODUCTION_SERVER",
                   "label": "Production Server",
                 },
               "virtualHosts": [
                 {
                   "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1",
                   "groupId": "{groupId}"
                 }
               ]
             }'

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

{
  "hosts": [
    {
      "groupId": "{groupId}",
      "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1"
    }
  ],
  "id": "{physicalHostID}",
  "name": "physicalHostA",
  "serverType":
    {
      "name": "PRODUCTION_SERVER",
      "label": "Production Server",
    },
}

← Retrieve One Physical Host Update One Physical Host →