Navigation

Rename an Organization

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

Resource

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 Cloud 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:

status
HTTP response code
envelope
The expected response body
false

Request Body Parameters

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

Response

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" \
  "https://cloud.mongo.com/api/public/v1.0/orgs/6001f2c580eef55aedbc6bb1?pretty=true" \
  --data '{"name":"MyCloudManagerCluster"}'

Example Response

{
  "id" : "6001f2c580eef55aedbc6bb1",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/6001f2c580eef55aedbc6bb1",
    "rel" : "self"
  }, {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/6001f2c580eef55aedbc6bb1/groups",
    "rel" : "http://mms.mongodb.com/groups"
  }, {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/6001f2c580eef55aedbc6bb1/teams",
    "rel" : "http://mms.mongodb.com/teams"
  }, {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/6001f2c580eef55aedbc6bb1/users",
    "rel" : "http://mms.mongodb.com/users"
  } ],
  "name" : "MyCloudManagerCluster"
}