{"openapi":"3.1.0","info":{"title":"IONOS PostgreSQL (BYOK) API","version":"0.1.0","description":"IONOS PostgreSQL (BYOK) lets an AI assistant read your own IONOS PostgreSQL data through the IONOS PostgreSQL API with a key you supply (IONOS Cloud API token (JWT)). Read-only: 5 tools (list_clusters, get_cluster, list_backups, list_backup_locations, list_postgres_versions). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-ionos-postgresql.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-ionos-postgresql/docs"},"termsOfService":"https://connectorbay.com/byok-ionos-postgresql/terms"},"servers":[{"url":"https://byok-ionos-postgresql.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-ionos-postgresql/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_clusters":{"post":{"operationId":"list_clusters","summary":"List managed PostgreSQL clusters in a region with name, version, instance count, cores, RAM, storage, replication mode, ","description":"List managed PostgreSQL clusters in a region with name, version, instance count, cores, RAM, storage, replication mode, state and DNS name. Credentials are never returned. Use for \"Which PostgreSQL clusters do I run on IONOS in Frankfurt\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"IONOS region of the PostgreSQL service: de-txl (Berlin), de-fra (Frankfurt), fr-par (Paris), es-vit (Logrono), gb-lhr (London), gb-bhx (Worcester), us-las (Las Vegas), us-mci (Lenexa) or us-ewr (Newark).","enum":["de-txl","de-fra","fr-par","es-vit","gb-lhr","gb-bhx","us-las","us-mci","us-ewr"],"title":"Region","type":"string"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only clusters whose name contains this text.","title":"Name"},"state":{"anyOf":[{"enum":["PROVISIONING","AVAILABLE","UPDATING","DESTROYING","FAILED"],"type":"string"},{"type":"null"}],"default":null,"description":"Only clusters in this state.","title":"State"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 1000).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many items to skip from the start of the list.","title":"Offset"}},"required":["region"],"title":"list_clustersArguments","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_cluster":{"post":{"operationId":"get_cluster","summary":"Get one PostgreSQL cluster: version, sizing, state, DNS name, replication mode, connection pooler, maintenance window an","description":"Get one PostgreSQL cluster: version, sizing, state, DNS name, replication mode, connection pooler, maintenance window and backup settings. Credentials are never returned. Use for \"Show my IONOS PostgreSQL cluster c1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"IONOS region of the PostgreSQL service: de-txl (Berlin), de-fra (Frankfurt), fr-par (Paris), es-vit (Logrono), gb-lhr (London), gb-bhx (Worcester), us-las (Las Vegas), us-mci (Lenexa) or us-ewr (Newark).","enum":["de-txl","de-fra","fr-par","es-vit","gb-lhr","gb-bhx","us-las","us-mci","us-ewr"],"title":"Region","type":"string"},"cluster_id":{"description":"PostgreSQL cluster id (a UUID) from list_clusters.","maxLength":64,"title":"Cluster Id","type":"string"}},"required":["region","cluster_id"],"title":"get_clusterArguments","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_backups":{"post":{"operationId":"list_backups","summary":"List PostgreSQL backups in a region with cluster, version, whether the cluster is active, earliest and latest recovery t","description":"List PostgreSQL backups in a region with cluster, version, whether the cluster is active, earliest and latest recovery time and location. Use for \"How far back can I restore my IONOS PostgreSQL cluster\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"IONOS region of the PostgreSQL service: de-txl (Berlin), de-fra (Frankfurt), fr-par (Paris), es-vit (Logrono), gb-lhr (London), gb-bhx (Worcester), us-las (Las Vegas), us-mci (Lenexa) or us-ewr (Newark).","enum":["de-txl","de-fra","fr-par","es-vit","gb-lhr","gb-bhx","us-las","us-mci","us-ewr"],"title":"Region","type":"string"},"cluster_id":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Only backups of this cluster id.","title":"Cluster Id"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 1000).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many items to skip from the start of the list.","title":"Offset"}},"required":["region"],"title":"list_backupsArguments","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_backup_locations":{"post":{"operationId":"list_backup_locations","summary":"List the locations where PostgreSQL backups can be stored in a region. Use for \"Where can IONOS store my PostgreSQL back","description":"List the locations where PostgreSQL backups can be stored in a region. Use for \"Where can IONOS store my PostgreSQL backups\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"IONOS region of the PostgreSQL service: de-txl (Berlin), de-fra (Frankfurt), fr-par (Paris), es-vit (Logrono), gb-lhr (London), gb-bhx (Worcester), us-las (Las Vegas), us-mci (Lenexa) or us-ewr (Newark).","enum":["de-txl","de-fra","fr-par","es-vit","gb-lhr","gb-bhx","us-las","us-mci","us-ewr"],"title":"Region","type":"string"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 1000).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many items to skip from the start of the list.","title":"Offset"}},"required":["region"],"title":"list_backup_locationsArguments","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_postgres_versions":{"post":{"operationId":"list_postgres_versions","summary":"List the PostgreSQL versions offered in a region with status, comment and upgrade targets. Use for \"Which PostgreSQL ver","description":"List the PostgreSQL versions offered in a region with status, comment and upgrade targets. Use for \"Which PostgreSQL versions does IONOS offer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"IONOS region of the PostgreSQL service: de-txl (Berlin), de-fra (Frankfurt), fr-par (Paris), es-vit (Logrono), gb-lhr (London), gb-bhx (Worcester), us-las (Las Vegas), us-mci (Lenexa) or us-ewr (Newark).","enum":["de-txl","de-fra","fr-par","es-vit","gb-lhr","gb-bhx","us-las","us-mci","us-ewr"],"title":"Region","type":"string"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 1000).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many items to skip from the start of the list.","title":"Offset"}},"required":["region"],"title":"list_postgres_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}}}}