Navigation
You were redirected from a different version of the documentation. Click here to go back.

Get All Groups for the Current User

Base URL: {opsManagerHost}:{port}

Syntax

GET /api/public/v1.0/groups

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

This endpoint does not use HTTP request body parameters.

Response Elements

The response includes the totalCount of the alerts and a results array with the list of group details. Each group information includes:

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 activeAgentCount field.

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:

  • Are case-sensitive
  • Can contain these characters:
    • A through Z
    • 0 through 9
    • . (period)
    • _ (underscore)
    • - (dash)
  • Are limited to 32 characters
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 roleName follows:

User Role roleName Value
Group Automation Admin GROUP_AUTOMATION_ADMIN
Group Backup Admin GROUP_BACKUP_ADMIN
Group Monitoring Admin GROUP_MONITORING_ADMIN
Group Owner GROUP_OWNER
Group Read Only GROUP_READ_ONLY
Group User Admin GROUP_USER_ADMIN
Global Automation Admin GLOBAL_AUTOMATION_ADMIN
Global Backup Admin GLOBAL_BACKUP_ADMIN
Global Monitoring Admin GLOBAL_MONITORING_ADMIN
Global Owner GLOBAL_OWNER
Global Read Only GLOBAL_READ_ONLY
Global User Admin GLOBAL_USER_ADMIN
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.

Examples

Example Request

curl --user "{username}:{apiKey}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups?pretty=true"

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {DATE-IN-UNIX-FORMAT}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{NONCE}", algorithm=MD5, op="auth", stale=false
Content-Length: {REQUEST-LENGTH}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {DATE-IN-UNIX-FORMAT}
Connection: keep-alive
Content-Length: {REQUEST-LENGTH}

Response Body

{
  "links" : [ ... ],
  "results" : [
      {
        "id": "xxx",
        "name": "My Group",
        "hostCounts": {
          "arbiter": 2,
          "config": 1,
          "primary": 4,
          "secondary": 8,
          "mongos": 2,
          "master": 0,
          "slave": 0
        },
        "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"),
        "activeAgentCount": 1,
        "replicaSetCount": 3,
        "shardCount": 2,
        "publicApiEnabled": true,
        "agentApiKey": "cbd728abd6a6d6c6b6d7826345dbcff0e",
        "tags": [ "DEV", "PRODUCT" ],
        "ldapGroupMappings" : [ {
          "roleName": "GROUP_OWNER",
          "ldapGroups": [ "group-owner" ]
          }, ... ],
        "links": [ ... ]
      },
      ...
  ],
  "totalCount" : 12
}