- API >
- Public API Resources >
- Groups and Users >
- Projects >
- Change One Project’s Name
Change One Project’s Name¶
On this page
Note
Groups and projects are synonymous terms. Your {GROUP-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.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Request Parameters¶
Request Path Parameters¶
Name | Type | Description |
---|---|---|
GROUP-ID | string | (Required.) The unique identifier for the project. |
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 For endpoints that return one result, the response body includes:
|
false |
Request Body Parameters¶
Name | Type | Description |
---|---|---|
name | string | The display name for the group. |
Response¶
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
activeAgentCount | integer | Number of active agents sending regular pings to Ops Manager. The value is refreshed about every 24 hours and cached. If
you start a new agent or stop an existing one, the change
can take up to 30 minutes to show up in the
|
||||||||||||||||||
hostCounts | object | Total number of hosts by type. The embedded fields should be self-explanatory. | ||||||||||||||||||
id | string | Unique identifier for the project. | ||||||||||||||||||
lastActiveAgent | string | Time Ops Manager last updated the activeAgentCount total for
the project. Ops Manager refreshes this value every 24 hours and
caches it to record the number of active MongoDB Agents. |
||||||||||||||||||
ldapGroupMappings | object array | For LDAP-backed Ops Manager, the mappings of LDAP groups to Ops Manager project roles. Only present for LDAP-backed Ops Manager. | ||||||||||||||||||
ldapGroupMappings
.roleName
|
string | Ops Manager user role. The mapping of
Project Role to
|
||||||||||||||||||
ldapGroupMappings
.ldapGroups
|
string array | LDAP project(s) that map to the Ops Manager role. | ||||||||||||||||||
links | object 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 | Display name for the project. | ||||||||||||||||||
orgId | string | Unique identifier for the organization to which the project belongs. | ||||||||||||||||||
publicApiEnabled | boolean | Flag indicating that the API is enabled for this project.
This is a read-only field that is always true . |
||||||||||||||||||
replicaSetCount | integer | Total number of replica sets for this project. | ||||||||||||||||||
shardCount | integer | Total number of shards for this project. | ||||||||||||||||||
tags | string array | Tags assigned to the project for use in programmatically identifying the project.
A project can have up to 10 tags. Tags follow these rules:
|