{"openapi":"3.1.0","info":{"title":"Freshservice Status Page (BYOK) API","version":"0.1.0","description":"Freshservice Status Page (BYOK) lets an AI assistant read your own Freshservice Status Page data through the Freshservice Status Page API with a key you supply (Freshservice API key). Read-only: 6 tools (list_status_pages, list_service_components, list_incidents, list_incident_statuses, list_maintenances, list_maintenance_statuses). 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-freshservice-status-page.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-freshservice-status-page/docs"},"termsOfService":"https://connectorbay.com/byok-freshservice-status-page/terms"},"servers":[{"url":"https://byok-freshservice-status-page.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-freshservice-status-page/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_status_pages":{"post":{"operationId":"list_status_pages","summary":"List the status pages of the account with name, domain, custom domain, privacy flag and workspace. Use for \"Which status","description":"List the status pages of the account with name, domain, custom domain, privacy flag and workspace. Use for \"Which status pages does my Freshservice account have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Your Freshservice subdomain (for example 'acme' for acme.freshservice.com).","maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Domain","type":"string"},"workspace_id":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only status pages of this workspace id. Without it, pages from all workspaces are listed.","title":"Workspace Id"}},"required":["domain"],"title":"list_status_pagesArguments","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_service_components":{"post":{"operationId":"list_service_components","summary":"List a status page's service components with their groups, position and current status code. Use for \"What is the curren","description":"List a status page's service components with their groups, position and current status code. Use for \"What is the current status of each component on my Freshservice status page\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Your Freshservice subdomain (for example 'acme' for acme.freshservice.com).","maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Domain","type":"string"},"status_page_id":{"description":"Status page id from list_status_pages.","title":"Status Page Id","type":"integer"}},"required":["domain","status_page_id"],"title":"list_service_componentsArguments","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_incidents":{"post":{"operationId":"list_incidents","summary":"List a status page's incidents with title, description, status code, start and end times, impacted services and linked t","description":"List a status page's incidents with title, description, status code, start and end times, impacted services and linked ticket id. Use for \"Which incidents were reported on my Freshservice status page\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Your Freshservice subdomain (for example 'acme' for acme.freshservice.com).","maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Domain","type":"string"},"status_page_id":{"description":"Status page id from list_status_pages.","title":"Status Page Id","type":"integer"}},"required":["domain","status_page_id"],"title":"list_incidentsArguments","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_incident_statuses":{"post":{"operationId":"list_incident_statuses","summary":"List the incident status labels of a status page (for example Investigating, Resolved) with position and colour. Use for","description":"List the incident status labels of a status page (for example Investigating, Resolved) with position and colour. Use for \"Which incident statuses can a Freshservice status page use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Your Freshservice subdomain (for example 'acme' for acme.freshservice.com).","maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Domain","type":"string"},"status_page_id":{"description":"Status page id from list_status_pages.","title":"Status Page Id","type":"integer"}},"required":["domain","status_page_id"],"title":"list_incident_statusesArguments","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_maintenances":{"post":{"operationId":"list_maintenances","summary":"List a status page's planned maintenances with title, description, status code, start and end times and impacted service","description":"List a status page's planned maintenances with title, description, status code, start and end times and impacted services. Use for \"Which maintenances are planned on my Freshservice status page\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Your Freshservice subdomain (for example 'acme' for acme.freshservice.com).","maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Domain","type":"string"},"status_page_id":{"description":"Status page id from list_status_pages.","title":"Status Page Id","type":"integer"}},"required":["domain","status_page_id"],"title":"list_maintenancesArguments","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_maintenance_statuses":{"post":{"operationId":"list_maintenance_statuses","summary":"List the maintenance status labels of a status page (for example Planned, In progress) with position and colour. Use for","description":"List the maintenance status labels of a status page (for example Planned, In progress) with position and colour. Use for \"Which maintenance statuses can a Freshservice status page use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"description":"Your Freshservice subdomain (for example 'acme' for acme.freshservice.com).","maxLength":63,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Domain","type":"string"},"status_page_id":{"description":"Status page id from list_status_pages.","title":"Status Page Id","type":"integer"}},"required":["domain","status_page_id"],"title":"list_maintenance_statusesArguments","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}}}}