{"openapi":"3.1.0","info":{"title":"Elastic Cloud Serverless (BYOK) API","version":"0.1.0","description":"Elastic Cloud Serverless (BYOK) lets an AI assistant read your own Elastic Cloud Serverless data through the Elastic Cloud Serverless API with a key you supply (Elastic Cloud API key (encoded value)). Read-only: 10 tools (get_capabilities, list_regions, get_region, list_observability_projects, get_observability_project, get_observability_project_status, list_elasticsearch_projects,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-elastic-cloud-serverless.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-elastic-cloud-serverless/docs"},"termsOfService":"https://connectorbay.com/byok-elastic-cloud-serverless/terms"},"servers":[{"url":"https://byok-elastic-cloud-serverless.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-elastic-cloud-serverless/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_capabilities":{"post":{"operationId":"get_capabilities","summary":"Show the organization's Serverless quotas: the maximum number of projects and the maximum number of projects one cross-p","description":"Show the organization's Serverless quotas: the maximum number of projects and the maximum number of projects one cross-project search may link. Use for \"How many Serverless projects can my Elastic Cloud organization have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_capabilitiesArguments","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 cloud regions where Serverless projects can be created, with provider, provider region, country and whether cre","description":"List the cloud regions where Serverless projects can be created, with provider, provider region, country and whether creation is enabled. Use for \"In which regions can I create Elastic Cloud Serverless projects\".","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/get_region":{"post":{"operationId":"get_region","summary":"Get one Serverless region by id: name, cloud provider, provider region, country and whether project creation is enabled.","description":"Get one Serverless region by id: name, cloud provider, provider region, country and whether project creation is enabled. Use for \"Show one Elastic Cloud Serverless region\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Region id from list_regions, for example aws-us-east-1.","maxLength":200,"title":"Id","type":"string"}},"required":["id"],"title":"get_regionArguments","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_observability_projects":{"post":{"operationId":"list_observability_projects","summary":"List Elastic Cloud Serverless Observability projects with name, alias, region, Cloud ID, endpoint URLs and creation time","description":"List Elastic Cloud Serverless Observability projects with name, alias, region, Cloud ID, endpoint URLs and creation time. Use for \"Which Elastic Observability Serverless projects do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_observability_projectsArguments","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_observability_project":{"post":{"operationId":"get_observability_project","summary":"Get one Observability project: name, alias, region, product tier, Cloud ID, endpoints, traffic filter ids and suspension","description":"Get one Observability project: name, alias, region, product tier, Cloud ID, endpoints, traffic filter ids and suspension state. Use for \"Show one Elastic Observability Serverless project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Id of the project, as returned by the project list tool.","maxLength":200,"title":"Id","type":"string"}},"required":["id"],"title":"get_observability_projectArguments","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_observability_project_status":{"post":{"operationId":"get_observability_project_status","summary":"Get the lifecycle phase of an Observability project (initializing, initialized, suspending, suspended, deleting) and whe","description":"Get the lifecycle phase of an Observability project (initializing, initialized, suspending, suspended, deleting) and when it changed. Use for \"Is my Elastic Observability Serverless project up\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Id of the project, as returned by the project list tool.","maxLength":200,"title":"Id","type":"string"}},"required":["id"],"title":"get_observability_project_statusArguments","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_elasticsearch_projects":{"post":{"operationId":"list_elasticsearch_projects","summary":"List Elastic Cloud Serverless Elasticsearch projects with name, alias, region, Cloud ID, endpoint URLs and creation time","description":"List Elastic Cloud Serverless Elasticsearch projects with name, alias, region, Cloud ID, endpoint URLs and creation time. Use for \"Which Elasticsearch Serverless projects do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_elasticsearch_projectsArguments","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_project":{"post":{"operationId":"get_elasticsearch_project","summary":"Get one Elasticsearch Serverless project: name, region, optimization (general purpose or vector), search power, Cloud ID","description":"Get one Elasticsearch Serverless project: name, region, optimization (general purpose or vector), search power, Cloud ID and endpoints. Use for \"Show one Elasticsearch Serverless project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Id of the project, as returned by the project list tool.","maxLength":200,"title":"Id","type":"string"}},"required":["id"],"title":"get_elasticsearch_projectArguments","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_security_projects":{"post":{"operationId":"list_security_projects","summary":"List Elastic Cloud Serverless Security projects with name, alias, region, Cloud ID, endpoint URLs and creation time. Use","description":"List Elastic Cloud Serverless Security projects with name, alias, region, Cloud ID, endpoint URLs and creation time. Use for \"Which Elastic Security Serverless projects do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_security_projectsArguments","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_traffic_filters":{"post":{"operationId":"list_traffic_filters","summary":"List Serverless network traffic filters (IP, VPC endpoint or private endpoint rules) with type, region and whether they ","description":"List Serverless network traffic filters (IP, VPC endpoint or private endpoint rules) with type, region and whether they apply by default. Use for \"Which traffic filters protect my Elastic Cloud Serverless projects\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only filters of this region id, for example aws-us-east-1.","title":"Region"}},"title":"list_traffic_filtersArguments","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}}}}