- API >
- Cloud Manager Administration API Resources >
- Measurements and Alerts >
- Third-Party Integration Settings >
- Return the Latest Targets for Prometheus
Return the Latest Targets for Prometheus¶
On this page
Note
Groups and projects are synonymous terms. Your {PROJECT-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://cloud.mongodb.com/prometheus/v1.0
Syntax¶
Request Path Parameters¶
Name | Type | Necessity | Description |
---|---|---|---|
{PROJECT-ID} | string | Required | Unique 24-hexadecimal digit string that identifies your project. |
Request Query Parameters¶
The following query parameters are optional:
Name | Type | Necessity | Description | Default |
---|---|---|---|---|
pageNum | number | Optional | One-based integer that returns a subsection of results. | 1 |
itemsPerPage | number | Optional | Number of items to return per page, up to a maximum of 500. | 100 |
pretty | boolean | Optional | Flag that indicates whether the response body should be in a prettyprint format. | false |
envelope | boolean | Optional | Flag that 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 doesn’t use HTTP request body parameters.
Response Elements¶
The response includes an array of your latest targets from which to scrape and a document containing their labels.
Name | Type | Description |
---|---|---|
targets | array | Each host and port from which to scrape metrics. |
labels | document | Document that contains the label and value that differentiates your metrics. |
labels.group_id | string | Unique hexadecimal digit string that identifies the project. |
labels.group_name | string | Human-readable label that identifies the project. |
labels.org_id | string | Unique hexadecimal digit string that identifies the organization. |