- API >
- Public API Resources >
- Groups and Users >
- Projects >
- Add or Remove Tags from One Project
Add or Remove Tags from One Project¶
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.
Add and remove tags from the given project. The tags
array
replaces and overwrites the project’s current tags
array.
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 | Flag indicating whether the response body should be in a prettyprint format. | false |
envelope | boolean | Flag indicating 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, response body includes:
|
false |
Request Body Parameters¶
Name | Type | Description |
---|---|---|
id | string | The unique identifier for the group. |
tags | string array | The tags assigned to the group for use in programmatically identifying the group. To view tags you must have either the Global Read Only or Global Owner role. To create or edit tags, you must be a Global Owner. A project can have up to 10 tags. Tags follow these rules:
|
Response¶
Name | Type | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 |
||||||||||||||
agentApiKey | string | The agent API key for the group. You must have the |
||||||||||||||
hostCounts | object | The total number of hosts by type. The embedded fields should be self-explanatory. | ||||||||||||||
id | string | The unique identifier for the group. | ||||||||||||||
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). |
||||||||||||||
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 | 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 | The display name for the group. | ||||||||||||||
orgId | string | The unique identifier for the organization to which the group/project belongs. | ||||||||||||||
publicApiEnabled | boolean | The indicator that the Public API is enabled for this group. This is a
read-only field that is always true . |
||||||||||||||
replicaSetCount | number | The total number of replica sets for this group. | ||||||||||||||
shardCount | number | The total number of shards for this group. | ||||||||||||||
tags | string array | The tags assigned to the group for use in programmatically identifying the group.
A project can have up to 10 tags. Tags follow these rules:
|
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. |