- API >
- Public API Resources >
- Groups and Users >
- Groups >
- Create One Group
Create One Group¶
On this page
Base URL: {opsManagerHost}:{port}
¶
Syntax¶
Request Parameters¶
Request Path Parameters¶
This endpoint does not use HTTP request path parameters.
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 |
---|---|---|---|
pageNum |
integer | Page number (1-based). | 1 |
itemsPerPage |
integer | Maximum number of items to return, up to a maximum of 100. | 100 |
pretty |
boolean | Display response in human-readable format. | false |
Request Body Parameters¶
Name | Type | Description |
---|---|---|
name |
string | Required. The display name for the group. |
Response Elements¶
Name | Type | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
string | The unique identifier for the group. | ||||||||||||||||||||||||||
name |
string | The display name for the group. | ||||||||||||||||||||||||||
hostCounts |
object | The total number of hosts by type. The embedded fields should be self-explanatory. | ||||||||||||||||||||||||||
lastActiveAgent |
date | The time Ops Manager last updated the activeAgentCount total for the
group. Ops Manager runs a job every 30 minutes to record the number of active
agents of any type (Monitoring, Backup, Automation). |
||||||||||||||||||||||||||
activeAgentCount |
number | The number of active agents of any type (Monitoring, Backup, Automation) sending regular pings to Ops Manager. The value is refreshed every 30 minutes. If you start a new agent or
stop an existing one, the change can take up to 30 minutes to show up
in the |
||||||||||||||||||||||||||
replicaSetCount |
number | The total number of replica sets for this group. | ||||||||||||||||||||||||||
shardCount |
number | The total number of shards for this group. | ||||||||||||||||||||||||||
publicApiEnabled |
boolean | The indicator that the Public API is enabled for this group. This is a
read-only field that is always true . |
||||||||||||||||||||||||||
agentApiKey |
string | The agent API key for the group. You must have the Owner or Global Read Only role to view this field. |
||||||||||||||||||||||||||
tags |
string array | The tags assigned to the group for use in programmatically identifying the group.
A group can have up to 10 tags. Tags follow these rules:
|
||||||||||||||||||||||||||
ldapGroupMappings |
object array | For LDAP-backed Ops Manager, the mappings of LDAP groups to Ops Manager roles. Only present for LDAP-backed Ops Manager. | ||||||||||||||||||||||||||
ldapGroupMappings.roleName |
string | The Ops Manager user role. The mapping of
User Role to
|
||||||||||||||||||||||||||
ldapGroupMappings.ldapGroups |
string array | The LDAP group(s) that map to the Ops Manager role. | ||||||||||||||||||||||||||
links |
string array | See Response Links. |
Response Links¶
Relation | Description |
---|---|
self |
Me |
http://{opsManagerHost}:{port}/hosts |
All hosts in the group. |
http://{opsManagerHost}:{port}/users |
All users in the group. |
http://{opsManagerHost}:{port}/clusters |
All clusters in the group. |
http://{opsManagerHost}:{port}/alerts |
All open alerts for the group. |
http://{opsManagerHost}:{port}/alertConfigs |
All alert configurations for the group. |
http://{opsManagerHost}:{port}/backupConfigs |
All backup configurations for the group. |
http://{opsManagerHost}:{port}/agents |
All agents for the group. |