API-referens för statussidor
Hämta dina statussidor
Endpoint:
GET /v2/pages?page=:page&per_page=:per_page
- Standardvärdet för page är 1.
- Standardvärdet för per_page är 50 och maxvärdet är 100 poster per sida.
Exempelsvar:
[{"id": "ckf01fonve9i40a32oas5b0uw","subdomain": "nasa","name": "Nasa","logoUrl": null,"faviconUrl": null,"websiteUrl": null,"customDomain": null,"publicEmail": null,"twitter": null,"status": "UP","subscribeBySms": null,"language": "en","useLargeHeader": true,"brandColor": "#111","okColor": "rgba(51, 177, 126, 1)","disruptedColor": null,"degradedColor": null,"downColor": null,"noticeColor": null,"unknownColor": null,"googleAnalytics": null,"smsService": null,"htmlInMeta": null,"htmlAboveHeader": null,"htmlBelowHeader": null,"htmlAboveFooter": null,"htmlBelowFooter": null,"htmlBelowSummary": null,"launchDate": null,"cssGlobal": null,"onboarded": null,"createdAt": "2020-09-12T19:03:48.379Z","updatedAt": "2020-09-12T19:04:03.731Z"}]
Skapa en statussida
Endpoint:
POST /v1/pages
Exempelanrop:
{"email": "ali@instatus.com","name": "Nasa","subdomain": "nasa","components": ["Website", "App", "API"],"logoUrl": "https://instatus.com/sample.png","faviconUrl": "https://instatus.com/favicon-32x32.png","websiteUrl": "https://instatus.com","language": "en","useLargeHeader": true,"brandColor": "#111","okColor": "#33B17E","disruptedColor": "#FF8C03","degradedColor": "#ECC94B","downColor": "#DC123D","noticeColor": "#70808F","unknownColor": "#DFE0E1","googleAnalytics": "UA-00000000-1","subscribeBySms": true,"smsService": "twilio","twilioSid": "YOUR_TWILIO_SID","twilioToken": "YOUR_TWILIO_TOKEN","twilioSender": "YOUR_TWILIO_SENDER","esendexUsername": "YOUR_ESENDEX_USERNAME","esendexPassword": "YOUR_ESENDEX_PASSWORD","esendexAccountRef": "YOUR_ESENDEX_ACCOUNT_REF","nexmoKey": null,"nexmoSecret": null,"nexmoSender": null,"htmlInMeta": null,"htmlAboveHeader": null,"htmlBelowHeader": null,"htmlAboveFooter": null,"htmlBelowFooter": null,"htmlBelowSummary": null,"cssGlobal": null,"launchDate": null,"dateFormat": "MMMMMM d, yyyy","dateFormatShort": "MMM yyyy","timeFormat": "p"}
Exempelsvar:
{"id": "ckg8auvrglcx309501fcjb2vl","createdAt": "2020-10-13T18:29:25.708Z","subdomain": "nasa","logoUrl": null,"faviconUrl": null,"websiteUrl": null,"name": "Nasa","status": "UP","color": null,"language": null,"googleAnalytics": null,"publicEmail": null,"customDomain": null,"useLargeHeader": true,"disableDarkMode": null,"twitter": null,"subscribeBySms": null,"brandColor": null,"okColor": null,"disruptedColor": null,"downColor": null,"degradedColor": null,"noticeColor": null,"htmlInMeta": null,"htmlAboveHeader": null,"htmlBelowHeader": null,"htmlAboveFooter": null,"htmlBelowFooter": null,"htmlBelowSummary": null,"cssGlobal": null,"onboarded": null,"launchDate": null,"dateFormat": "MMMMMM d, yyyy","dateFormatShort": "MMM yyyy","timeFormat": "p","private": false,"useAllowList": false,"allowList": [],"components": [{"id": "ckg8auwlzlcxd09506r3g6y8z","name": "Website","status": "OPERATIONAL","showUptime": true,"order": null,"group": null,"incidents": []},{"id": "ckg8auwv7lcxm09506jjate2o","name": "App","status": "OPERATIONAL","showUptime": true,"order": null,"group": null,"incidents": []},{"id": "ckg8aux4oo3ik0a35parnbunk","name": "API","status": "OPERATIONAL","showUptime": true,"order": null,"group": null,"incidents": []}]}
Uppdatera en statussida
Endpoint:
PUT /v2/:page_id
Exempelanrop:
{"id": "ckg8auvrglcx309501fcjb2vl","name": "Nasa","status": "UP","subdomain": "nasa","logoUrl": "https://instatus.com/sample.png","faviconUrl": "https://instatus.com/favicon-32x32.png","websiteUrl": "https://instatus.com","language": "en","publicEmail": "hello@nasa.gov","useLargeHeader": true,"brandColor": "#111","okColor": "#33B17E","disruptedColor": "#FF8C03","degradedColor": "#ECC94B","downColor": "#DC123D","noticeColor": "#70808F","unknownColor": "#DFE0E1","googleAnalytics": "UA-00000000-1","subscribeBySms": true,"smsService": "twilio","twilioSid": "YOUR_TWILIO_SID","twilioToken": "YOUR_TWILIO_TOKEN","twilioSender": "YOUR_TWILIO_SENDER","esendexUsername": "YOUR_ESENDEX_USERNAME","esendexPassword": "YOUR_ESENDEX_PASSWORD","esendexAccountRef": "YOUR_ESENDEX_ACCOUNT_REF","nexmoKey": null,"nexmoSecret": null,"nexmoSender": null,"htmlInMeta": null,"htmlAboveHeader": null,"htmlBelowHeader": null,"htmlAboveFooter": null,"htmlBelowFooter": null,"htmlBelowSummary": null,"cssGlobal": null,"launchDate": null,"dateFormat": "MMMMMM d, yyyy","dateFormatShort": "MMM yyyy","timeFormat": "p","private": false,"useAllowList": false,"subscriberConfirmationMode": "REQUIRED","translations": {"name": {"fr": "nasa"}}}
Bekräftelsemejl
Använd subscriberConfirmationMode för att styra vad som händer när någon prenumererar:
REQUIRED— prenumeranter måste bekräfta via e-post innan de får uppdateringar. Standard.WELCOME— prenumeranter läggs till direkt och får ett välkomstmejl. Endast Pro.NONE— prenumeranter läggs till direkt utan något mejl. Endast Pro.
autoConfirmSubscribers är utfasad. För bakåtkompatibilitet motsvarar true värdet NONE och false värdet REQUIRED.
Exempelsvar:
{"id": "ckg8auvrglcx309501fcjb2vl","createdAt": "2020-10-13T18:29:25.708Z","subdomain": "nasa","name": "Nasa","status": "UP","logoUrl": null,"faviconUrl": null,"websiteUrl": null,"color": null,"language": null,"googleAnalytics": null,"publicEmail": "hello@nasa.gov","customDomain": null,"useLargeHeader": true,"disableDarkMode": null,"twitter": null,"subscribeBySms": null,"brandColor": null,"okColor": null,"disruptedColor": null,"downColor": null,"degradedColor": null,"noticeColor": null,"htmlInMeta": null,"htmlAboveHeader": null,"htmlBelowHeader": null,"htmlAboveFooter": null,"htmlBelowFooter": null,"htmlBelowSummary": null,"cssGlobal": null,"onboarded": null,"launchDate": null,"dateFormat": "MMMMMM d, yyyy","dateFormatShort": "MMM yyyy","timeFormat": "p","private": false,"useAllowList": false,"allowList": [],"subscriberConfirmationMode": "REQUIRED","components": [{"id": "ckg8auwlzlcxd09506r3g6y8z","name": "Website","status": "OPERATIONAL","showUptime": true,"order": null,"group": null,"incidents": []},{"id": "ckg8auwv7lcxm09506jjate2o","name": "App","status": "OPERATIONAL","showUptime": true,"order": null,"group": null,"incidents": []},{"id": "ckg8aux4oo3ik0a35parnbunk","name": "API","status": "OPERATIONAL","showUptime": true,"order": null,"group": null,"incidents": []}],"translations": {"name": {"fr": "nasa"}}}
Radera en statussida
Endpoint:
DELETE /v2/:page_id
Exempelsvar:
{"id": "ckf1d4f6a4aaf0a356vqg0rdm"}