{"openapi":"3.1.0","info":{"title":"Elastic Cloud (BYOK) API","version":"0.1.0","description":"Elastic Cloud (BYOK) lets an AI assistant read your own Elastic Cloud data through the Elastic Cloud API with a key you supply (Elastic Cloud API key (encoded value)). Read-only: 10 tools (get_account, list_deployments, get_deployment, get_elasticsearch_resource, get_kibana_resource, get_deployment_tags, list_stack_versions, list_deployment_templates, list_organizations, get_organization_costs)....\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-elasticcloud.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-elasticcloud/docs"},"termsOfService":"https://connectorbay.com/byok-elasticcloud/terms"},"servers":[{"url":"https://byok-elasticcloud.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-elasticcloud/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/get_account":{"post":{"operationId":"get_account","summary":"Show the Elastic Cloud account id and trust settings of the API key. Use for \"Which Elastic Cloud account is my API key ","description":"Show the Elastic Cloud account id and trust settings of the API key. Use for \"Which Elastic Cloud account is my API key for\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_accountArguments","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_deployments":{"post":{"operationId":"list_deployments","summary":"List the hosted deployments of the account with id and name. Use for \"What Elastic Cloud deployments do I have\".","description":"List the hosted deployments of the account with id and name. Use for \"What Elastic Cloud deployments do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"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: name, alias and health. Use get_elasticsearch_resource or get_kibana_resource for the status of its ","description":"Get one deployment: name, alias and health. Use get_elasticsearch_resource or get_kibana_resource for the status of its parts. Use for \"Is my Elastic Cloud deployment healthy\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deployment_id":{"description":"Elastic Cloud deployment id (32-character hex string); get it from list_deployments.","maxLength":64,"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/get_elasticsearch_resource":{"post":{"operationId":"get_elasticsearch_resource","summary":"Get the status of a deployment's Elasticsearch cluster: name, region, health and lifecycle status. Use for \"What is the ","description":"Get the status of a deployment's Elasticsearch cluster: name, region, health and lifecycle status. Use for \"What is the status of the Elasticsearch cluster in my Elastic Cloud deployment\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deployment_id":{"description":"Elastic Cloud deployment id (32-character hex string); get it from list_deployments.","maxLength":64,"title":"Deployment Id","type":"string"},"ref_id":{"description":"Resource reference id inside the deployment, usually 'main-elasticsearch' or 'main-kibana'; shown by get_deployment.","maxLength":64,"title":"Ref Id","type":"string"}},"required":["deployment_id","ref_id"],"title":"get_elasticsearch_resourceArguments","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_kibana_resource":{"post":{"operationId":"get_kibana_resource","summary":"Get the status of a deployment's Kibana instance: name, region, health and lifecycle status. Use for \"Is the Kibana in m","description":"Get the status of a deployment's Kibana instance: name, region, health and lifecycle status. Use for \"Is the Kibana in my Elastic Cloud deployment running\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deployment_id":{"description":"Elastic Cloud deployment id (32-character hex string); get it from list_deployments.","maxLength":64,"title":"Deployment Id","type":"string"},"ref_id":{"description":"Resource reference id inside the deployment, usually 'main-elasticsearch' or 'main-kibana'; shown by get_deployment.","maxLength":64,"title":"Ref Id","type":"string"}},"required":["deployment_id","ref_id"],"title":"get_kibana_resourceArguments","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_tags":{"post":{"operationId":"get_deployment_tags","summary":"List the key-value tags attached to a deployment. Use for \"What tags does my Elastic Cloud deployment have\".","description":"List the key-value tags attached to a deployment. Use for \"What tags does my Elastic Cloud deployment have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deployment_id":{"description":"Elastic Cloud deployment id (32-character hex string); get it from list_deployments.","maxLength":64,"title":"Deployment Id","type":"string"}},"required":["deployment_id"],"title":"get_deployment_tagsArguments","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_stack_versions":{"post":{"operationId":"list_stack_versions","summary":"List the Elastic Stack versions available on Elastic Cloud with whether each is usable and which versions it can upgrade","description":"List the Elastic Stack versions available on Elastic Cloud with whether each is usable and which versions it can upgrade to. Use for \"Which Elastic Stack versions can I deploy or upgrade to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"show_deleted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include versions that are no longer offered.","title":"Show Deleted"},"show_unusable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include versions that cannot be used for new deployments.","title":"Show Unusable"}},"title":"list_stack_versionsArguments","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_deployment_templates":{"post":{"operationId":"list_deployment_templates","summary":"List the deployment templates (hardware profiles) available in a cloud region with id, name and description. Use for \"Wh","description":"List the deployment templates (hardware profiles) available in a cloud region with id, name and description. Use for \"What deployment templates does Elastic Cloud offer in gcp-us-central1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Cloud region id, for example 'gcp-us-central1' or 'aws-eu-west-1'.","maxLength":64,"title":"Region","type":"string"},"stack_version":{"anyOf":[{"maxLength":32,"type":"string"},{"type":"null"}],"default":null,"description":"Only templates that support this stack version, for example '9.1.0'.","title":"Stack Version"}},"required":["region"],"title":"list_deployment_templatesArguments","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_organizations":{"post":{"operationId":"list_organizations","summary":"List the Elastic Cloud organizations the key can see with id and name. Use for \"Which Elastic Cloud organizations am I i","description":"List the Elastic Cloud organizations the key can see with id and name. Use for \"Which Elastic Cloud organizations am I in\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_organizationsArguments","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_organization_costs":{"post":{"operationId":"get_organization_costs","summary":"Get the cost overview of an organization: total cost, cost by dimension, hourly rate, trial credit and prepaid balance, ","description":"Get the cost overview of an organization: total cost, cost by dimension, hourly rate, trial credit and prepaid balance, for a time range. Use for \"How much have I spent on Elastic Cloud this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Elastic Cloud organization id; get it from list_organizations.","maxLength":64,"title":"Organization Id","type":"string"},"from_time":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Start of the range as an ISO 8601 time, for example 2026-10-01T00:00:00Z.","title":"From Time"},"to_time":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"End of the range as an ISO 8601 time.","title":"To Time"}},"required":["organization_id"],"title":"get_organization_costsArguments","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}}}}