> ## Documentation Index > Fetch the complete documentation index at: https://docs.flashduty.com/llms.txt > Use this file to discover all available pages before exploring further. # Preview draft variables > Resolve a draft variable set that is not stored in any dashboard. ## OpenAPI ````yaml /api-reference/monitors.openapi.en.json post /monit/dashboard/runtime/variables/preview openapi: 3.1.0 info: title: Flashduty Open API description: >- Public HTTP API for the Flashduty incident management platform — incidents, notification templates, channels, schedules, monitors, RUM, and platform administration. Every operation is authenticated with an `app_key` query parameter issued from the Flashduty console under Account → APP Keys. Responses follow a uniform envelope: `{ request_id, data }` on success, `{ request_id, error }` on failure. version: 1.0.0 servers: - url: https://api.flashcat.cloud description: Flashduty Open API security: - AppKeyAuth: [] tags: - name: Monitors/Alert rules description: >- Create, manage, and export monitor alert rules. Query rule counters and audit history. - name: Monitors/Data sources description: Manage monitoring data sources used by alert rules to query metrics. - name: Monitors/Diagnostics description: >- Diagnostic and query endpoints used by Flashduty AI SRE — ad-hoc data source queries, log/metric diagnostics, and target-side tool invocation. - name: Monitors/Monitor utilities description: Monitors service activation and data preview utilities. - name: Monitors/Dashboards description: >- Create, search, version and run Monitors dashboards, and resolve their variables and queries. - name: Monitors/Rule folders description: >- List the monitor folder tree that dashboards and alert rules are organised in. paths: /monit/dashboard/runtime/variables/preview: post: tags: - Monitors/Dashboards summary: Preview draft variables description: Resolve a draft variable set that is not stored in any dashboard. operationId: monit-dashboard-variable-read-preview requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DashboardVariablesPreviewRequest' example: context: kind: new folder_id: 12 variables: - kind: custom name: env label: Environment selection: mode: single include_all: false options: - text: Production value: prod - text: Staging value: staging default: kind: values values: - prod selections: env: kind: values values: - prod time: from_ms: 1791100800000 to_ms: 1791104400000 responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/DashboardVariablesPreviewResponse' example: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: variables: - name: env kind: custom candidates: - text: Production value: prod - text: Staging value: staging selection: kind: values values: - prod selections: env: kind: values values: - prod '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' components: schemas: DashboardVariablesPreviewRequest: type: object description: >- Resolve a draft set of variables that is not stored in any dashboard yet. properties: context: $ref: '#/components/schemas/DashboardDraftContext' variables: type: array items: $ref: '#/components/schemas/DashboardVariable' maxItems: 20 description: Draft variables, at most 20. selections: type: object additionalProperties: $ref: '#/components/schemas/DashboardSelection' description: Selections keyed by variable name, at most 20 entries. time: $ref: '#/components/schemas/DashboardAbsoluteTimeRange' required: - context - variables - selections - time SuccessEnvelope: type: object description: >- Success response envelope. On every 2xx response, `request_id` identifies the call (also mirrored in the `Flashcat-Request-Id` header) and `data` holds the endpoint-specific payload. Failure responses use a different shape — see `ErrorResponse`. properties: request_id: type: string description: >- Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues. example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: description: Endpoint-specific payload. See each operation's 200 response schema. required: - request_id - data DashboardVariablesPreviewResponse: type: object description: >- Resolved draft variables. There is no `dashboard_id` because nothing is persisted. properties: variables: type: array items: $ref: '#/components/schemas/DashboardResolvedVariable' description: Resolved variables. selections: type: object additionalProperties: $ref: '#/components/schemas/DashboardSelection' description: Effective selections keyed by variable name. required: - variables - selections DashboardDraftContext: type: object description: >- Where an unsaved draft panel or variable set belongs. `existing` targets a stored dashboard, `new` a folder that does not contain one yet — the two are mutually exclusive. properties: kind: type: string enum: - existing - new description: >- Draft context kind: `existing` = targets a stored dashboard (`dashboard_id` required); `new` = a folder that does not contain one yet (`folder_id` required). dashboard_id: type: string pattern: >- ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ description: Required for `existing`, forbidden for `new`. folder_id: type: integer format: uint64 minimum: 1 description: Required for `new`, forbidden for `existing`. required: - kind DashboardVariable: description: A dashboard variable. Pick the arm with `kind`. oneOf: - $ref: '#/components/schemas/DashboardDatasourceVariable' - $ref: '#/components/schemas/DashboardCustomVariable' - $ref: '#/components/schemas/DashboardQueryVariable' discriminator: propertyName: kind mapping: datasource: '#/components/schemas/DashboardDatasourceVariable' custom: '#/components/schemas/DashboardCustomVariable' query: '#/components/schemas/DashboardQueryVariable' DashboardSelection: type: object description: >- A concrete selection of variable values. An empty `values` array is valid wire input and means unresolved — the server never substitutes a default for it. properties: kind: type: string enum: - values - all description: >- `values` selects the listed entries, `all` selects everything (only allowed when `include_all` is true). values: type: array items: type: string minLength: 1 maxLength: 1024 maxItems: 1000 description: >- Selected values, unique and never `$__all`. Must be empty when `kind` is `all`. required: - kind DashboardAbsoluteTimeRange: type: object description: >- Absolute evaluation window. Both bounds are Unix timestamps in milliseconds, `from_ms` must be less than `to_ms`, and neither may exceed the JavaScript safe integer limit. properties: from_ms: type: integer format: int64 minimum: 0 description: Unix timestamp in milliseconds. to_ms: type: integer format: int64 minimum: 1 description: Unix timestamp in milliseconds. required: - from_ms - to_ms DashboardResolvedVariable: type: object description: >- One resolved variable. An unreachable datasource, a bad expression or an empty result leaves `candidates` incomplete and fills `error` instead of failing the request. properties: name: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$ description: Variable name. kind: type: string enum: - datasource - custom - query description: >- Variable kind: `datasource` = selects a datasource; `custom` = fixed inline list; `query` = resolved by running a query. candidates: type: array items: $ref: '#/components/schemas/DashboardCandidate' description: Resolved candidates, at most 1000. selection: $ref: '#/components/schemas/DashboardSelection' datasource: $ref: '#/components/schemas/DashboardRuntimeDatasource' error: $ref: '#/components/schemas/DashboardRuntimeError' required: - name - kind - candidates ErrorResponse: type: object description: Response envelope for errors. `error` is required; `data` is absent. properties: request_id: type: string example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 description: >- Unique trace ID of this request; include it when reporting issues so logs can be located. error: $ref: '#/components/schemas/DutyError' required: - request_id - error DashboardDatasourceVariable: type: object description: >- Datasource selector variable. Its candidates are the account's datasources of `datasource_type`. properties: kind: type: string enum: - datasource description: >- Variable kind discriminator; always `datasource`, selecting a datasource. name: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$ description: Variable name used in `{{ }}` templates, at most 64 characters. label: type: string maxLength: 189 description: Optional display label; falls back to `name`. datasource_type: type: string pattern: ^[a-z][a-z0-9_]{0,63}$ description: Datasource type the candidates are drawn from. name_patterns: type: array items: type: string minLength: 1 maxLength: 189 maxItems: 10 description: >- Wildcard patterns narrowing the candidates; empty means every datasource of the type. default_datasource_id: type: integer format: uint64 description: >- Default datasource ID. Without a usable default the runtime picks the first candidate by name, then ID. required: - kind - name - datasource_type DashboardCustomVariable: type: object description: Variable whose candidates come from a fixed list supplied inline. properties: kind: type: string enum: - custom description: >- Variable kind discriminator; always `custom`, with candidates from a fixed list supplied inline. name: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$ description: Variable name used in `{{ }}` templates, at most 64 characters. label: type: string maxLength: 189 description: Optional display label; falls back to `name`. selection: $ref: '#/components/schemas/DashboardSelectionConfig' options: type: array items: $ref: '#/components/schemas/DashboardCandidate' minItems: 1 maxItems: 1000 description: >- Candidate list, 1–1000 entries. Values must be non-empty, unique and must not be `$__all`. default: $ref: '#/components/schemas/DashboardSelection' required: - kind - name - selection - options DashboardQueryVariable: type: object description: >- Variable whose candidates are resolved by running a query against a datasource. properties: kind: type: string enum: - query description: >- Variable kind discriminator; always `query`, with candidates resolved by running a query against a datasource. name: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$ description: Variable name used in `{{ }}` templates, at most 64 characters. label: type: string maxLength: 189 description: Optional display label; falls back to `name`. selection: $ref: '#/components/schemas/DashboardSelectionConfig' default: $ref: '#/components/schemas/DashboardSelection' datasource_ref: $ref: '#/components/schemas/DashboardDatasourceRef' variable_query: $ref: '#/components/schemas/DashboardVariableQuery' refresh: type: string enum: - on_dashboard_load - on_time_range_change description: >- When the candidates are recomputed: `on_dashboard_load` = once when the dashboard loads; `on_time_range_change` = every time the time range changes. required: - kind - name - selection - datasource_ref - variable_query - refresh DashboardCandidate: type: object description: One selectable option of a custom variable. properties: text: type: string minLength: 1 maxLength: 1024 description: Label shown in the picker. value: type: string minLength: 1 maxLength: 1024 description: Value substituted into templates. required: - text - value DashboardRuntimeDatasource: type: object description: The datasource a runtime query was bound to. properties: id: type: integer format: uint64 minimum: 1 description: Datasource ID. type: type: string pattern: ^[a-z][a-z0-9_]{0,63}$ description: Datasource type identifier. name: type: string description: Datasource name. required: - id - type - name DashboardRuntimeError: type: object description: >- Per-variable or per-query failure. A failed arm does not fail the whole call. properties: reason: type: string description: >- Machine-readable failure reason. Observed values include `invalid_request`, `variable_invalid`, `panel_missing`, `field_missing`, `datasource_permission_denied`, `timeout`, `panel_deadline`, `panel_canceled`, `canceled`, `overloaded`, `source_too_large`, `edge_unavailable`, `edge_upgrade_required`, `edge_version_unknown`, `mixed_edge_versions` and `internal`. message: type: string description: Human-readable detail for the failure. required: - reason - message DutyError: type: object description: >- Error payload inside the response envelope. Present only on non-2xx responses. properties: code: $ref: '#/components/schemas/ErrorCode' message: type: string description: >- Human-readable error message, localized by the caller's Accept-Language. May contain field names, IDs, or other context from the failing request. example: The specified parameter template_id is not valid. reason: description: >- Optional machine-readable rejection reason, including datasource tool failures. Inspect alongside HTTP status and code. type: string x-flashduty-preserve-absence: true required: - code - message DashboardSelectionConfig: type: object description: Selection cardinality for a variable. properties: mode: type: string enum: - single - multi description: >- Selection cardinality: `single` makes the resolved selection hold exactly one value; `multi` allows multiple values. include_all: type: boolean description: When true the variable also offers an `all` selection. required: - mode - include_all DashboardDatasourceRef: type: object description: >- Points a panel or query variable at a datasource — either a fixed ID or a datasource variable evaluated at render time. properties: kind: type: string enum: - fixed - variable description: >- `fixed` uses `datasource_id`; `variable` resolves `name` against a datasource variable. datasource_id: type: integer format: uint64 minimum: 1 description: >- Datasource ID. Required when `kind` is `fixed`, forbidden when `kind` is `variable`. name: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$ description: >- Datasource variable name. Required when `kind` is `variable`, forbidden when `kind` is `fixed`. datasource_type: type: string pattern: ^[a-z][a-z0-9_]{0,63}$ description: Datasource type identifier, e.g. `prometheus` or `victorialogs`. required: - kind - datasource_type DashboardVariableQuery: description: >- Variable query. Pick the arm with `kind`; the arm must match the referenced datasource type. oneOf: - $ref: '#/components/schemas/DashboardPrometheusVariableQuery' - $ref: '#/components/schemas/DashboardSQLVariableQuery' - $ref: '#/components/schemas/DashboardLogsVariableQuery' discriminator: propertyName: kind mapping: prometheus: '#/components/schemas/DashboardPrometheusVariableQuery' sql: '#/components/schemas/DashboardSQLVariableQuery' logs: '#/components/schemas/DashboardLogsVariableQuery' ErrorCode: type: string description: >- Flashduty error code enum. Every failed API response sets `error.code` to one of these stable wire strings. HTTP status is informational — the authoritative signal is the enum value. | Code | HTTP | Meaning | |---|---|---| | `OK` | 200 | Reserved — not returned on real errors. | | `InvalidParameter` | 400 | A required parameter is missing or failed validation. | | `BadRequest` | 400 | Generic 400 used when no more specific code fits. | | `InvalidContentType` | 400 | The `Content-Type` header is not `application/json`. | | `ResourceNotFound` | 400 | The referenced resource does not exist. Note: returned as HTTP 400, not 404 (historical choice). | | `NoLicense` | 400 | The feature is license-gated and no active license was found. | | `ReferenceExist` | 400 | Deletion blocked — other entities still reference this resource. | | `Unauthorized` | 401 | `app_key` is missing, invalid, or expired. | | `BalanceNotEnough` | 402 | Billing-gated operation with insufficient account balance. | | `AccessDenied` | 403 | Authenticated but lacking the permission required for this operation. | | `RouteNotFound` | 404 | The request URL path is not a known route. | | `MethodNotAllowed` | 405 | The HTTP method is not allowed on this otherwise-known path. | | `UndonedOrderExist` | 409 | An outstanding billing order blocks this new one. Wait and retry. | | `RequestLocked` | 423 | Operation temporarily locked due to repeated failures. | | `EntityTooLarge` | 413 | Request body exceeds the configured max size. | | `RequestTooFrequently` | 429 | Rate limit hit — API-global, per-account, or per-integration. | | `RequestVerifyRequired` | 428 | Second-factor verification required but not supplied. | | `DangerousOperation` | 428 | High-risk operation requires MFA verification. | | `InternalError` | 500 | Unhandled server-side error. Include `request_id` in the bug report. | | `ServiceUnavailable` | 503 | A backend dependency is unavailable. Try again later. | enum: - OK - InvalidParameter - BadRequest - InvalidContentType - ResourceNotFound - NoLicense - ReferenceExist - Unauthorized - BalanceNotEnough - AccessDenied - RouteNotFound - MethodNotAllowed - UndonedOrderExist - RequestLocked - EntityTooLarge - RequestTooFrequently - RequestVerifyRequired - DangerousOperation - InternalError - ServiceUnavailable x-enumDescriptions: OK: Reserved — not returned on real errors. InvalidParameter: A required parameter is missing or failed validation. BadRequest: Generic 400 used when no more specific code fits. InvalidContentType: The `Content-Type` header is not `application/json`. ResourceNotFound: >- The referenced resource does not exist. Note: returned as HTTP 400, not 404 (historical choice). NoLicense: The feature is license-gated and no active license was found. ReferenceExist: Deletion blocked — other entities still reference this resource. Unauthorized: '`app_key` is missing, invalid, or expired.' BalanceNotEnough: Billing-gated operation with insufficient account balance. AccessDenied: Authenticated but lacking the permission required for this operation. RouteNotFound: The request URL path is not a known route. MethodNotAllowed: The HTTP method is not allowed on this otherwise-known path. UndonedOrderExist: An outstanding billing order blocks this new one. Wait and retry. RequestLocked: Operation temporarily locked due to repeated failures. EntityTooLarge: Request body exceeds the configured max size. RequestTooFrequently: Rate limit hit — API-global, per-account, or per-integration. RequestVerifyRequired: Second-factor verification required but not supplied. DangerousOperation: High-risk operation requires MFA verification. InternalError: Unhandled server-side error. Include `request_id` in the bug report. ServiceUnavailable: A backend dependency is unavailable. Try again later. example: InvalidParameter DashboardPrometheusVariableQuery: type: object description: Prometheus label-values query. properties: kind: type: string enum: - prometheus description: >- Query kind discriminator; always `prometheus`, a label-values query against Prometheus. label: type: string pattern: ^[A-Za-z_][A-Za-z0-9_:.\-]{0,189}$ description: Label whose values become candidates. metric: type: string description: Optional metric used to restrict the series considered. label_filters: type: array items: $ref: '#/components/schemas/DashboardLabelFilter' description: Optional matchers narrowing the series before label values are read. required: - kind - label DashboardSQLVariableQuery: type: object description: SQL query returning one column of candidates. properties: kind: type: string enum: - sql description: >- Query kind discriminator; always `sql`, a SQL query returning one column of candidates. expr: type: string description: SQL statement; may reference other variables through `{{ }}`. args: type: object additionalProperties: type: string description: Named query arguments; defaults to an empty object. text_field: type: string description: Column used as the candidate label; defaults to the value column. value_field: type: string minLength: 1 description: Column used as the candidate value. required: - kind - expr - args - value_field DashboardLogsVariableQuery: type: object description: Logs query returning one field's values as candidates. properties: kind: type: string enum: - logs description: >- Query kind discriminator; always `logs`, a logs query returning one field's values as candidates. expr: type: string description: >- Logs query expression; may reference other variables through `{{ }}`. args: type: object additionalProperties: type: string description: Named query arguments; defaults to an empty object. field: type: string minLength: 1 description: Log field whose values become candidates. required: - kind - expr - args - field DashboardLabelFilter: type: object description: Prometheus label matcher. properties: label: type: string pattern: ^[A-Za-z_][A-Za-z0-9_:.\-]{0,189}$ description: Label name. op: type: string enum: - '=' - '!=' - '=~' - '!~' description: >- Matcher operator: `=` = equals; `!=` = not equals; `=~` = regex match; `!~` = regex does-not-match. value: type: string minLength: 1 description: Matcher value; may reference other variables through `{{ }}`. required: - label - op - value responses: BadRequest: description: Invalid request — usually a missing or malformed parameter. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingParameter: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: InvalidParameter message: The specified parameter is not valid. Unauthorized: description: Missing or invalid app_key. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingAppKey: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: Unauthorized message: You are unauthorized. Forbidden: description: The app_key is valid but lacks permission for this operation. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: noEditPermission: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: AccessDenied message: Access Denied. NotFound: description: >- The referenced resource does not exist or has been deleted. Note: Flashduty historically returns HTTP 400 with code `ResourceNotFound` for missing domain entities; a true 404 is reserved for unknown routes. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: resourceMissing: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: ResourceNotFound message: The resource you request is not found TooManyRequests: description: >- Rate limit hit. Either the global API limit, a per-account limit, or a per-integration limit. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: rateLimited: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: RequestTooFrequently message: Request too frequently. ServerError: description: Unexpected server-side error. Include the request_id when reporting. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internal: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: InternalError message: >- We encountered an internal error, and it has been reported. Please try again later. securitySchemes: AppKeyAuth: type: apiKey in: query name: app_key description: >- App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.