Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / /

Update Default Server Type For One Project

On this page

  • Required Roles
  • Request
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response
  • Response Header
  • Response Body

Update the default server type for one project.

Your API Key must have the Global Owner role to successfully call this resource.

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

PUT /usage/groups/{groupId}/defaultServerType

Ops Manager requires all request path parameters:

Request Parameters
Type
Description
groupId
string
Unique identifier of the project associated with the desired hosts.

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
Body Parameter
Type
Necessity
Description
serverType
object
Required
Server Type of the physical host.
serverType
.name
object
Required

Server Type value for the physical host.

You can set this to one of the following values:

  • DEV_SERVER

  • TEST_SERVER

  • PRODUCTION_SERVER

  • RAM_POOL

Tip

See also:

serverType
.label
object
Optional

Server Type label for the physical host.

You can set this to one of the following values:

  • Dev Server

  • Test Server

  • Production Server

  • Ram Pool

Tip

See also:

Response Element
Type
Description
serverType
object
Server Type of the physical host.
serverType
.name
object

Server Type value for the physical host.

Ops Manager returns one of following values:

  • DEV_SERVER

  • TEST_SERVER

  • PRODUCTION_SERVER

  • RAM_POOL

Tip

See also:

serverType
.label
object

Server Type label for the physical host.

Ops Manager returns one of following values:

  • Dev Server

  • Test Server

  • Production Server

  • Ram Pool

Tip

See also:

curl --user "{publicApiKey}:{privateApiKey}" --digest \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--include \
--request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/usage/groups/{groupId}/defaultServerType?pretty=true' \
--data '{
"serverType":{
"name":"RAM_POOL",
"label":"RAM Pool"
}
}'
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}

This endpoint doesn't return a response body.

Back

Get Default Server Type For One Project

Next

Update Server Type for One Host