{"openapi":"3.1.0","info":{"title":"Gandi (BYOK) API","version":"0.1.0","description":"Gandi (BYOK) lets an AI assistant read your own Gandi data through the Gandi API with a key you supply (Gandi personal access token (PAT)). Read-only: 9 tools (check_domain_availability, list_domains, get_domain, list_livedns_domains, get_livedns_domain, list_dns_records, get_dns_records_by_name, get_zone_nameservers, list_dnssec_keys). The BYOK key travels with each request, is used for that one...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-gandi.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-gandi/docs"},"termsOfService":"https://connectorbay.com/byok-gandi/terms"},"servers":[{"url":"https://byok-gandi.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-gandi/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/check_domain_availability":{"post":{"operationId":"check_domain_availability","summary":"Check whether a domain name can be registered and what it costs (prices per period). Only reads availability; it does no","description":"Check whether a domain name can be registered and what it costs (prices per period). Only reads availability; it does not register anything. Use for \"Is the domain example-new-name.com available and how much does it cost\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"description":"Domain name to check, for example 'example.com'.","maxLength":253,"title":"Name","type":"string"},"currency":{"anyOf":[{"maxLength":3,"type":"string"},{"type":"null"}],"default":null,"description":"Currency code for prices, for example 'EUR' or 'USD'.","title":"Currency"},"country":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"Two-letter country code for tax calculation.","title":"Country"}},"required":["name"],"title":"check_domain_availabilityArguments","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_domains":{"post":{"operationId":"list_domains","summary":"List the domains of your organization with TLD, status, auto-renew, dates, name server mode and tags. Supports wildcards","description":"List the domains of your organization with TLD, status, auto-renew, dates, name server mode and tags. Supports wildcards in the fqdn filter. Use for \"Which domains do I have at Gandi and when do they expire\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fqdn":{"anyOf":[{"maxLength":253,"type":"string"},{"type":"null"}],"default":null,"description":"Filter by name with wildcards, for example 'example.*' or '*example.com'.","title":"Fqdn"},"tld":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only this extension, for example 'com'.","title":"Tld"},"nameserver":{"anyOf":[{"enum":["abc","livedns","other"],"type":"string"},{"type":"null"}],"default":null,"description":"Only domains with this name server mode: abc, livedns or other.","title":"Nameserver"},"sort_by":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Sort field (default fqdn).","title":"Sort By"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items per page (1 to 100).","title":"Per Page"},"sharing_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Organization ID to read instead of your personal organization.","title":"Sharing Id"}},"title":"list_domainsArguments","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_domain":{"post":{"operationId":"get_domain","summary":"Get one domain's details: status, name servers, services, dates, auto-renew settings, whether the TLD can be locked, and","description":"Get one domain's details: status, name servers, services, dates, auto-renew settings, whether the TLD can be locked, and tags. The transfer code is not returned. Use for \"Show the details of my Gandi domain example.com\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Domain name, for example 'example.com'.","maxLength":253,"title":"Domain","type":"string"}},"required":["domain"],"title":"get_domainArguments","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_livedns_domains":{"post":{"operationId":"list_livedns_domains","summary":"List the domains managed in Gandi LiveDNS (DNS zones) of your personal organization, or of another organization via shar","description":"List the domains managed in Gandi LiveDNS (DNS zones) of your personal organization, or of another organization via sharing_id. Use for \"Which DNS zones do I manage in Gandi LiveDNS\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items per page (1 to 100).","title":"Per Page"},"sharing_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Organization ID to read instead of your personal organization.","title":"Sharing Id"}},"title":"list_livedns_domainsArguments","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_livedns_domain":{"post":{"operationId":"get_livedns_domain","summary":"Get a LiveDNS zone: links to its records and keys and whether automatic snapshots are on. Use for \"Does my zone example.","description":"Get a LiveDNS zone: links to its records and keys and whether automatic snapshots are on. Use for \"Does my zone example.com have automatic snapshots on Gandi\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fqdn":{"description":"Domain name, for example 'example.com'.","maxLength":253,"title":"Fqdn","type":"string"}},"required":["fqdn"],"title":"get_livedns_domainArguments","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_dns_records":{"post":{"operationId":"list_dns_records","summary":"List the DNS record sets (name, type, values, TTL) of a LiveDNS zone, optionally only one record type. Use for \"What DNS","description":"List the DNS record sets (name, type, values, TTL) of a LiveDNS zone, optionally only one record type. Use for \"What DNS records does example.com have at Gandi\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fqdn":{"description":"Domain name, for example 'example.com'.","maxLength":253,"title":"Fqdn","type":"string"},"rrset_type":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Only this record type, for example A, AAAA, MX, TXT, CNAME.","title":"Rrset Type"},"sort_by":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Sort field (default rrset_name).","title":"Sort By"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items per page (1 to 100).","title":"Per Page"}},"required":["fqdn"],"title":"list_dns_recordsArguments","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_dns_records_by_name":{"post":{"operationId":"get_dns_records_by_name","summary":"Get all record sets of one name (for example 'www' or '@') in a LiveDNS zone. Use for \"What records does www.example.com","description":"Get all record sets of one name (for example 'www' or '@') in a LiveDNS zone. Use for \"What records does www.example.com have at Gandi\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fqdn":{"description":"Domain name, for example 'example.com'.","maxLength":253,"title":"Fqdn","type":"string"},"rrset_name":{"description":"Record name relative to the zone, for example '@' or 'www'.","maxLength":253,"title":"Rrset Name","type":"string"}},"required":["fqdn","rrset_name"],"title":"get_dns_records_by_nameArguments","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_zone_nameservers":{"post":{"operationId":"get_zone_nameservers","summary":"List the name servers of a LiveDNS zone (the apex NS records, or Gandi's hashed name servers if there are none). Use for","description":"List the name servers of a LiveDNS zone (the apex NS records, or Gandi's hashed name servers if there are none). Use for \"Which name servers does example.com use at Gandi LiveDNS\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fqdn":{"description":"Domain name, for example 'example.com'.","maxLength":253,"title":"Fqdn","type":"string"}},"required":["fqdn"],"title":"get_zone_nameserversArguments","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_dnssec_keys":{"post":{"operationId":"list_dnssec_keys","summary":"List the DNSSEC keys of a LiveDNS zone with algorithm, flags, status and DS record. Use for \"Is DNSSEC set up for exampl","description":"List the DNSSEC keys of a LiveDNS zone with algorithm, flags, status and DS record. Use for \"Is DNSSEC set up for example.com at Gandi\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"fqdn":{"description":"Domain name, for example 'example.com'.","maxLength":253,"title":"Fqdn","type":"string"}},"required":["fqdn"],"title":"list_dnssec_keysArguments","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}}}}