This version of the documentation is archived and no longer supported. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.

Rename an Organization

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


POST /orgs/{ORG-ID}

Request Path Parameters

Name Type Description
ORG-ID string The id of the organization that you want to rename.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Ops Manager API resources. These are all optional.

Name Type Description Default
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, the response body includes:

Name Description
status HTTP response code
envelope Expected response body

Request Body Parameters

Name Type Description
name string The new name for the organization.


Name Type Description
id ObjectId Unique identifier for the organization.
links document array One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
name string New name of the organization.

Example Request

curl -X PATCH --include --user "<username:apiKey>" --digest --header "Content-Type: application/json" \
  "" \
  --data '{"name":"MyCloudManagerCluster"}'

Example Response

  "id" : "6001f2c580eef55aedbc6bb1",
  "links" : [ {
    "href" : "",
    "rel" : "self"
  }, {
    "href" : "",
    "rel" : ""
  }, {
    "href" : "",
    "rel" : ""
  }, {
    "href" : "",
    "rel" : ""
  } ],
  "name" : "MyCloudManagerCluster"