{"openapi":"3.1.0","info":{"title":"Victoria Metrics Cloud (BYOK) API","version":"0.1.0","description":"Victoria Metrics Cloud (BYOK) lets an AI assistant read your own Victoria Metrics Cloud data through the Victoria Metrics Cloud API with a key you supply (VictoriaMetrics Cloud API key). Read-only: 6 tools (list_deployments, get_deployment, list_rule_files, list_tiers, list_regions, list_cloud_providers). The BYOK key travels with each request, is used for that one call only and is never stored,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-victoriametrics-cloud.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-victoriametrics-cloud/docs"},"termsOfService":"https://connectorbay.com/byok-victoriametrics-cloud/terms"},"servers":[{"url":"https://byok-victoriametrics-cloud.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-victoriametrics-cloud/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_deployments":{"post":{"operationId":"list_deployments","summary":"List the account's VictoriaMetrics Cloud deployments (metrics, logs, traces) with type, tier, version, cloud provider, r","description":"List the account's VictoriaMetrics Cloud deployments (metrics, logs, traces) with type, tier, version, cloud provider, region, status and creation time. Use for \"What VictoriaMetrics Cloud deployments do I have and are they running\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"enum":["single_node","cluster","vlogs_single","vtraces_single"],"type":"string"},{"type":"null"}],"default":null,"description":"Only entries of this deployment type.","title":"Type"}},"title":"list_deploymentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_deployment":{"post":{"operationId":"get_deployment","summary":"Get one deployment: status, tier, version, retention, deduplication, storage size, maintenance window, price per period ","description":"Get one deployment: status, tier, version, retention, deduplication, storage size, maintenance window, price per period and access endpoint. Use for \"What is the retention and cost of my VictoriaMetrics Cloud deployment\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deployment_id":{"description":"VictoriaMetrics Cloud deployment ID; list_deployments returns it.","maxLength":100,"title":"Deployment Id","type":"string"}},"required":["deployment_id"],"title":"get_deploymentArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_rule_files":{"post":{"operationId":"list_rule_files","summary":"List the names of the alerting and recording rule files of a metrics deployment. Use for \"Which alerting rule files does","description":"List the names of the alerting and recording rule files of a metrics deployment. Use for \"Which alerting rule files does my VictoriaMetrics Cloud deployment have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deployment_id":{"description":"VictoriaMetrics Cloud deployment ID; list_deployments returns it.","maxLength":100,"title":"Deployment Id","type":"string"}},"required":["deployment_id"],"title":"list_rule_filesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_tiers":{"post":{"operationId":"list_tiers","summary":"List the deployment tiers that can be chosen, with type, cloud provider, hourly compute cost, access token limits and in","description":"List the deployment tiers that can be chosen, with type, cloud provider, hourly compute cost, access token limits and ingestion or read limits. Use for \"What VictoriaMetrics Cloud tiers exist and what do they cost per hour\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"enum":["single_node","cluster","vlogs_single","vtraces_single"],"type":"string"},{"type":"null"}],"default":null,"description":"Only entries of this deployment type.","title":"Type"}},"title":"list_tiersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_regions":{"post":{"operationId":"list_regions","summary":"List the regions where VictoriaMetrics Cloud deployments can be created, with cloud provider. Use for \"In which regions ","description":"List the regions where VictoriaMetrics Cloud deployments can be created, with cloud provider. Use for \"In which regions can I run VictoriaMetrics Cloud\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_regionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_cloud_providers":{"post":{"operationId":"list_cloud_providers","summary":"List the cloud providers available for VictoriaMetrics Cloud deployments with their IDs and URLs. Use for \"Which cloud p","description":"List the cloud providers available for VictoriaMetrics Cloud deployments with their IDs and URLs. Use for \"Which cloud providers does VictoriaMetrics Cloud support\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_cloud_providersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}