- API >
- Public API Resources >
- Organizations and Teams >
- Organizations >
- Get All Projects in an Organization
Get All Projects in an Organization¶
On this page
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Request Parameters¶
Request Path Parameters¶
Path Element | Type | Description |
---|---|---|
ORG-ID | Required. | The unique identifier for the organization whose information you want to retrieve. |
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 | 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 a list of results, the |
false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Response Document¶
The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.
Name | Type | Description |
---|---|---|
results |
object array | This array includes one object for each item detailed in the results Embedded Document section. |
links |
object array | This array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. |
totalCount |
integer | Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated. |
results Embedded Document¶
Each result is one project.
Name | Type | Description |
---|---|---|
activeAgentCount | integer | The number of active monitoring, automation, and backup agents in the project. |
hostCounts | Document | Describes the host types and number of each host type for the cluster. |
hostCounts.arbiter | integer | The number of arbiter hosts in the cluster. |
hostCounts.config | integer | The number of sharded cluster configuration server hosts in the cluster. |
hostCounts.master | integer | The number of master hosts in the cluster. |
hostCounts.mongos | integer | The number of mongos hosts in the
cluster. |
hostCounts.primary | integer | The number of primary hosts in the cluster. |
hostCounts.secondary | integer | The number of secondary hosts in the cluster. |
hostCounts.slave | integer | The number of slave hosts in the cluster. |
id | string | The unique identifier for the project. |
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 name of the cluster. |
orgId | string | The unique identifier for the parent organization of the project. |
publicApiEnabled | boolean | The status of API access to the cluster. |
replicaSetCount | integer | The number of replica sets in the cluster. |
shardCount | integer | The number of shards in the cluster. |