Prometheus API (0.2.2)
Download OpenAPI specification:Download
This project enhances the native Prometheus HTTP API by providing additional features and addressing its limitations. Running as a sidecar alongside the Prometheus server enables users to extend the capabilities of the API.
Create Rule
Creates a new rule with a randomly generated filename
Request Body schema: application/json
| file | string (File) Default: "" |
| data | object (Data) Default: {} |
Responses
Request samples
- Payload
Content type
application/json
Example
Prometheus Recording Rule
Prometheus Recording Rule
Prometheus Alerting Rule
Creates Prometheus recording rule with the name ExampleRecordingRule
{- "data": {
- "groups": [
- {
- "name": "ExampleRecordingRule",
- "rules": [
- {
- "record": "code:prometheus_http_requests_total:sum",
- "expr": "sum by (code) (prometheus_http_requests_total)"
}
]
}
]
}
}Response samples
- 201
- 400
- 422
- 500
Content type
application/json
[- {
- "status": "success",
- "file": "example-rule.yml",
- "message": "The rule was created successfully"
}
]Create Rule
Creates a new rule file with the provided filename
path Parameters
| file required | string (File) |
query Parameters
| recreate | string (Recreate) Default: "false" |
Request Body schema: application/json
| file | string (File) Default: "" |
| data | object (Data) Default: {} |
Responses
Request samples
- Payload
Content type
application/json
Example
Prometheus Recording Rule
Prometheus Recording Rule
Prometheus Alerting Rule
Creates Prometheus recording rule with the name ExampleRecordingRule
{- "data": {
- "groups": [
- {
- "name": "ExampleRecordingRule",
- "rules": [
- {
- "record": "code:prometheus_http_requests_total:sum",
- "expr": "sum by (code) (prometheus_http_requests_total)"
}
]
}
]
}
}Response samples
- 201
- 400
- 409
- 422
- 500
Content type
application/json
[- {
- "status": "success",
- "message": "The rule was created successfully"
}
]