Prometheus API (0.5.1)
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
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
[- {
- "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
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
[- {
- "status": "success",
- "message": "The rule was created successfully"
}
]Export Data From Prometheus
Exports data from Prometheus based on the provided PromQL
query Parameters
| format | string (Format) Default: "csv" |
Request Body schema: application/json
| expr required | string (Expr) |
| start | string (Start) |
| end | string (End) |
| step | string (Step) |
| timestamp_format | string (Timestamp Format) Default: "unix" |
| replace_fields | object (Replace Fields) Default: {} |
Responses
Request samples
- Payload
Count of successful logins by users per hour in a day
{- "expr": "users_login_count{status='success'}",
- "start": "2024-01-30T00:00:00Z",
- "end": "2024-01-31T23:59:59Z",
- "step": "1h"
}Response samples
- 200
- 400
- 422
- 500
nullGet Metrics Lifecycle Policy By Name
Returns metrics lifecycle policy that match the provided name parameter
path Parameters
| name required | string (Name) |
Responses
Response samples
- 200
- 404
- 422
[- {
- "match": "{__name__=~'go_.*'}",
- "keep_for": "7d",
- "description": "This metrics lifecycle policy keeps GoLang metrics for 7 days"
}
]Update Metrics Lifecycle Policy By Name
Updates specific metrics lifecycle policy
path Parameters
| name required | string (Name) |
Request Body schema: application/json
| pattern | string (Pattern) |
| keep_for | string (Keep For) |
| description | string (Description) |
Responses
Request samples
- Payload
Updates keep_for setting only
{- "keep_for": "10d"
}Response samples
- 200
- 400
- 404
- 422
- 500
[- {
- "status": "success",
- "message": "Policy updated successfully"
}
]Response samples
- 200
[- {
- "GoLang Policy": {
- "match": "{__name__=~'go_.*'}",
- "keep_for": "7d",
- "message": "This policy keeps GoLang metrics for 7 days"
}, - "Kubernetes Policy": {
- "match": "{job='kubernetes-pods'}",
- "keep_for": "10d",
- "message": "This policy keeps series of job 'kubernetes-pods' for 10 days"
}
}
]Create Metrics Lifecycle Policy
Creates a new metrics lifecycle policy
Request Body schema: application/json
| name required | string (Name) |
| match required | string (Match) |
| keep_for required | string (Keep For) |
| description | string (Description) |
Responses
Request samples
- Payload
Time-series matching with regex will be kept for 7 days
{- "name": "Example Policy",
- "match": "{__name__=~'go_.*'}",
- "keep_for": "7d",
- "description": "Time-series matching with regex will be kept for 7 days."
}Response samples
- 201
- 400
- 409
- 422
- 500
[- {
- "status": "success",
- "policy_name": "GoLang Metrics Policy",
- "message": "Policy created successfully"
}
]Get Prometheus Configuration
Get Prometheus configuration in various formats depending on the Content-Type request header
Responses
Response samples
- 200
- 500
{- "global": {
- "scrape_interval": "15s",
- "scrape_timeout": "10s",
- "evaluation_interval": "30s"
}, - "scrape_configs": [
- {
- "job_name": "prometheus",
- "scrape_interval": "15s",
- "scrape_timeout": "10s",
- "metrics_path": "/metrics",
- "scheme": "http",
- "static_configs": [
- {
- "targets": [
- "localhost:9090"
]
}
]
}
]
}Update Prometheus Configuration
Update entire Prometheus configuration file
Request Body schema: application/json
object (Global) The global configuration specifies parameters that are valid in all other configuration contexts. They also serve as defaults for other configuration sections. | |
object (RuntimeConfig) | |
| rule_files | Array of strings (Rule Files) Rule files specifies a list of globs. Rules and alerts are read from all matching files. |
| scrape_config_files | Array of strings (Scrape Config Files) Scrape config files specifies a list of globs. Scrape configs are read from all matching files and appended to the list of scrape configs. |
Array of objects (Scrape Configs) A list of scrape configurations. | |
object (Alerting) Alerting specifies settings related to the Alertmanager. | |
Array of objects (Remote Write) Settings related to the remote write feature. | |
object (Remote Read) Settings related to the remote read feature. | |
object (Storage) Storage related settings that are runtime reloadable. | |
object (Tracing) Configures exporting traces. |
Responses
Request samples
- Payload
Update entire Prometheus configuration file
{- "global": {
- "scrape_interval": "30s",
- "scrape_timeout": "30s",
- "evaluation_interval": "1m"
}, - "scrape_configs": [
- {
- "job_name": "prometheus",
- "metrics_path": "/metrics",
- "scheme": "http",
- "static_configs": [
- {
- "targets": [
- "localhost:9090"
], - "labels": {
- "instance": "prometheus-server",
- "env:": "production"
}
}
]
}
]
}Response samples
- 200
- 400
- 422
- 500
[- {
- "status": "success",
- "message": "Configuration updated successfully"
}
]Update Part Of Prometheus Configuration
Update specific part of Prometheus configuration file
Request Body schema: application/json
object (Global) The global configuration specifies parameters that are valid in all other configuration contexts. They also serve as defaults for other configuration sections. | |
object (RuntimeConfig) | |
| rule_files | Array of strings (Rule Files) Rule files specifies a list of globs. Rules and alerts are read from all matching files. |
| scrape_config_files | Array of strings (Scrape Config Files) Scrape config files specifies a list of globs. Scrape configs are read from all matching files and appended to the list of scrape configs. |
Array of objects (Scrape Configs) A list of scrape configurations. | |
object (Alerting) Alerting specifies settings related to the Alertmanager. | |
Array of objects (Remote Write) Settings related to the remote write feature. | |
object (Remote Read) Settings related to the remote read feature. | |
object (Storage) Storage related settings that are runtime reloadable. | |
object (Tracing) Configures exporting traces. |
Responses
Request samples
- Payload
Update Alertmanager configuration settings
{- "alerting": {
- "alertmanagers": [
- {
- "scheme": "https",
- "static_configs": [
- {
- "targets": [
- "example-alertmanager.com"
]
}
]
}
]
}
}Response samples
- 200
- 400
- 422
- 500
[- {
- "status": "success",
- "message": "Configuration updated successfully"
}
]