{"openapi":"3.1.0","info":{"title":"Netlify (BYOK) API","version":"0.1.0","description":"Netlify (BYOK) lets an AI assistant read your own Netlify data through the Netlify API with a key you supply (personal access token). Read-only: 10 tools (get_current_user, list_accounts, list_sites, get_site, list_site_deploys, get_deploy, list_site_builds, list_site_forms, list_site_submissions, list_form_submissions). The BYOK key travels with each request, is used for that one call only and...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-netlify.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-netlify/docs"},"termsOfService":"https://connectorbay.com/byok-netlify/terms"},"servers":[{"url":"https://byok-netlify.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-netlify/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_current_user":{"post":{"operationId":"get_current_user","summary":"Show the Netlify user the token belongs to: user ID, name, email, number of sites, login providers and last login. Use f","description":"Show the Netlify user the token belongs to: user ID, name, email, number of sites, login providers and last login. Use for \"Which Netlify account is my token connected to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_current_userArguments","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_accounts":{"post":{"operationId":"list_accounts","summary":"List the Netlify accounts (teams) the user belongs to with slug, plan type and how many sites and collaborators are incl","description":"List the Netlify accounts (teams) the user belongs to with slug, plan type and how many sites and collaborators are included and used. Use for \"Which Netlify teams am I a member of\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_accountsArguments","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_sites":{"post":{"operationId":"list_sites","summary":"List Netlify sites the token can access with URL, state, plan, team and timestamps. Use for \"What Netlify sites do I hav","description":"List Netlify sites the token can access with URL, state, plan, team and timestamps. Use for \"What Netlify sites do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only sites whose name matches this text.","title":"Site Name"},"filter":{"anyOf":[{"enum":["all","owner","guest"],"type":"string"},{"type":"null"}],"default":null,"description":"all, owner (sites you own) or guest (sites you were invited to).","title":"Filter"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results per page (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"list_sitesArguments","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_site":{"post":{"operationId":"get_site","summary":"Get one Netlify site: URLs, custom domain and aliases, state, plan, team, Git provider, SSL and DNS flags, and region. U","description":"Get one Netlify site: URLs, custom domain and aliases, state, plan, team, Git provider, SSL and DNS flags, and region. Use for \"Show details of the Netlify site my-site.netlify.app\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site_id":{"description":"Site ID, as returned by list_sites (the id field).","maxLength":200,"title":"Site Id","type":"string"}},"required":["site_id"],"title":"get_siteArguments","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_site_deploys":{"post":{"operationId":"list_site_deploys","summary":"List a Netlify site's deploys, newest first, optionally only production deploys, deploy previews, a branch or a state. R","description":"List a Netlify site's deploys, newest first, optionally only production deploys, deploy previews, a branch or a state. Returns the full deploy records. Use for \"Did the latest Netlify deploys of my-site succeed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site_id":{"description":"Site ID, as returned by list_sites (the id field).","maxLength":200,"title":"Site Id","type":"string"},"production":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to list only production deploys.","title":"Production"},"deploy_previews":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to list only deploy previews.","title":"Deploy Previews"},"branch":{"anyOf":[{"maxLength":250,"type":"string"},{"type":"null"}],"default":null,"description":"Only deploys of this Git branch.","title":"Branch"},"state":{"anyOf":[{"enum":["new","pending_review","accepted","rejected","enqueued","building","uploading","uploaded","preparing","prepared","processing","processed","ready","error","retrying"],"type":"string"},{"type":"null"}],"default":null,"description":"Only deploys in this state.","title":"State"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results per page (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["site_id"],"title":"list_site_deploysArguments","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_deploy":{"post":{"operationId":"get_deploy","summary":"Get one Netlify deploy by ID, returning its full record as Netlify provides it. Use for \"Why did Netlify deploy 5f2a0000","description":"Get one Netlify deploy by ID, returning its full record as Netlify provides it. Use for \"Why did Netlify deploy 5f2a0000000000000000abcd fail\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deploy_id":{"description":"Deploy ID, as returned by list_site_deploys.","maxLength":200,"title":"Deploy Id","type":"string"}},"required":["deploy_id"],"title":"get_deployArguments","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_site_builds":{"post":{"operationId":"list_site_builds","summary":"List a Netlify site's builds, newest first, returning the full build records as Netlify provides them. Use for \"Which Ne","description":"List a Netlify site's builds, newest first, returning the full build records as Netlify provides them. Use for \"Which Netlify builds of my-site failed recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site_id":{"description":"Site ID, as returned by list_sites (the id field).","maxLength":200,"title":"Site Id","type":"string"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results per page (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["site_id"],"title":"list_site_buildsArguments","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_site_forms":{"post":{"operationId":"list_site_forms","summary":"List the forms Netlify has detected on a site, returning the full form records as Netlify provides them. Use for \"Which ","description":"List the forms Netlify has detected on a site, returning the full form records as Netlify provides them. Use for \"Which forms does my Netlify site have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site_id":{"description":"Site ID, as returned by list_sites (the id field).","maxLength":200,"title":"Site Id","type":"string"}},"required":["site_id"],"title":"list_site_formsArguments","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_site_submissions":{"post":{"operationId":"list_site_submissions","summary":"List the form submissions received by a Netlify site across all its forms, returning the full submission records as Netl","description":"List the form submissions received by a Netlify site across all its forms, returning the full submission records as Netlify provides them. Use for \"What form submissions did my Netlify site receive\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"site_id":{"description":"Site ID, as returned by list_sites (the id field).","maxLength":200,"title":"Site Id","type":"string"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results per page (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["site_id"],"title":"list_site_submissionsArguments","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_form_submissions":{"post":{"operationId":"list_form_submissions","summary":"List the submissions of one Netlify form, returning the full submission records as Netlify provides them. Use for \"Show ","description":"List the submissions of one Netlify form, returning the full submission records as Netlify provides them. Use for \"Show the latest submissions of Netlify form 5f2a0000000000000000form\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"form_id":{"description":"Form ID, as returned by list_site_forms.","maxLength":200,"title":"Form Id","type":"string"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results per page (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["form_id"],"title":"list_form_submissionsArguments","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}}}}