prometheus/documentation/dev/api/swagger.json

188 lines
4.4 KiB
JSON
Raw Normal View History

2017-07-06 05:38:40 -07:00
{
"swagger": "2.0",
"info": {
"title": "rpc.proto",
2017-07-06 05:38:40 -07:00
"version": "version not set"
},
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/v2/admin/tsdb/clean_tombstones": {
"post": {
"summary": "CleanTombstones removes the deleted data from disk and cleans up the existing tombstones.",
"operationId": "Admin_TSDBCleanTombstones",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/prometheusTSDBCleanTombstonesResponse"
}
},
"default": {
"description": "An unexpected error response",
"schema": {
"$ref": "#/definitions/runtimeError"
}
}
},
"tags": [
"Admin"
]
}
},
"/v2/admin/tsdb/delete_series": {
2017-07-06 05:38:40 -07:00
"post": {
"summary": "DeleteSeries deletes data for a selection of series in a time range.",
"operationId": "Admin_DeleteSeries",
2017-07-06 05:38:40 -07:00
"responses": {
"200": {
"description": "A successful response.",
2017-07-06 05:38:40 -07:00
"schema": {
"$ref": "#/definitions/prometheusSeriesDeleteResponse"
}
},
"default": {
"description": "An unexpected error response",
"schema": {
"$ref": "#/definitions/runtimeError"
}
2017-07-06 05:38:40 -07:00
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/prometheusSeriesDeleteRequest"
}
}
],
"tags": [
"Admin"
]
}
},
"/v2/admin/tsdb/snapshot": {
2017-07-06 05:38:40 -07:00
"post": {
"summary": "Snapshot creates a snapshot of all current data into 'snapshots/\u003cdatetime\u003e-\u003crand\u003e' under the TSDB's data directory.",
"operationId": "Admin_TSDBSnapshot",
2017-07-06 05:38:40 -07:00
"responses": {
"200": {
"description": "A successful response.",
2017-07-06 05:38:40 -07:00
"schema": {
"$ref": "#/definitions/prometheusTSDBSnapshotResponse"
}
},
"default": {
"description": "An unexpected error response",
"schema": {
"$ref": "#/definitions/runtimeError"
}
2017-07-06 05:38:40 -07:00
}
},
"tags": [
"Admin"
]
}
}
},
"definitions": {
"prometheusLabelMatcher": {
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/prometheusLabelMatcherType"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"description": "Matcher specifies a rule, which can match or set of labels or not."
},
"prometheusLabelMatcherType": {
"type": "string",
"enum": [
"EQ",
"NEQ",
"RE",
"NRE"
],
"default": "EQ"
},
"prometheusSeriesDeleteRequest": {
"type": "object",
"properties": {
"min_time": {
"type": "string",
"format": "date-time"
},
"max_time": {
"type": "string",
"format": "date-time"
},
"matchers": {
"type": "array",
"items": {
"$ref": "#/definitions/prometheusLabelMatcher"
}
}
}
},
"prometheusSeriesDeleteResponse": {
"type": "object"
},
"prometheusTSDBCleanTombstonesResponse": {
2017-07-06 05:38:40 -07:00
"type": "object"
},
"prometheusTSDBSnapshotResponse": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"protobufAny": {
"type": "object",
"properties": {
"type_url": {
"type": "string"
},
"value": {
"type": "string",
"format": "byte"
}
}
},
"runtimeError": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"$ref": "#/definitions/protobufAny"
}
}
}
2017-07-06 05:38:40 -07:00
}
}
}