Checkly (oberoende utgivare) (förhandsversion)

Checkly är övervakningsplattformen för den moderna stacken: programmerbar, flexibel och kärleksfull JavaScript. Övervaka och verifiera dina viktiga webbplatstransaktioner. Samla automatiskt in felspårningar, skärmbilder och prestandamått för varje kontroll du kör.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster	Class	Regioner
Copilot Studio	Premie	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Logiska appar	Norm	Alla Logic Apps-regioner utom följande:      – Azure Government-regioner      – Regioner i Azure Kina      - US Department of Defense (DoD)
Power Apps	Premie	Alla Power Apps-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Power Automate	Premie	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)

Kontakt
Namn	Troy Taylor
URL	https://www.hitachisolutions.com
E-postmeddelande	ttaylor@hitachisolutions.com

Metadata för anslutningsprogram
Utgivare	Troy Taylor
Webbplats	https://www.checklyhq.com/
Sekretesspolicy	https://www.checklyhq.com/privacy
Kategorier	IT-åtgärder

Skapa en anslutning

Anslutningsappen stöder följande autentiseringstyper:

Standardinställning	Parametrar för att skapa anslutning.	Alla regioner	Går inte att dela

Standard

Tillämpligt: Alla regioner

Parametrar för att skapa anslutning.

Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.

Namn	Typ	Description	Krävs
Konto-ID	securestring	Konto-ID för det här API:et.	Sann
API-nyckel (i formatet "Bearer apiKey")	securestring	API-nyckeln (i formatet "Bearer apiKey") för det här API:et	Sann

Begränsningsgränser

Name	Anrop	Förnyelseperiod
API-anrop per anslutning	100	60 sekunder

Åtgärder

Få kontrollstatusmärke	Få kontrollstatusikonen.
Generera en ny API-nyckel för en privat plats	Skapar en API-nyckel på den privata platsen.
Genererar en anpassningsbar rapport för alla mått för webbläsarkontroll	Genererar en rapport med aggregerad eller icke-aggregerad statistik för en specifik webbläsarkontroll över ett angivet tidsfönster.
Genererar en rapport med sammanställd statistik för kontroller och kontrollgrupper	Genererar en rapport med aggregerad statistik för alla kontroller eller en filtrerad uppsättning kontroller under ett angivet tidsfönster.
Get group status badge (Hämta gruppstatusmärke)	Hämta gruppstatusmärke.
Hämta alla kontroller i en specifik grupp med gruppinställningar tillämpade	Visar en lista över alla kontroller i en specifik kontrollgrupp med de gruppinställningar som tillämpas.
Hämta checkgruppsutlösaren	Söker efter utlösaren för kontrollgruppen.
Hämta checkutlösaren	Söker efter checkutlösaren.
Hämta en aviseringskanal	Visa information om en specifik aviseringskanal.
Hämta en kontroll	Visa information om ett specifikt API eller webbläsarkontroll.
Hämta en kontroll i en specifik grupp med gruppinställningar tillämpade	Visa information om en kontroll i en specifik kontrollgrupp med gruppinställningarna tillämpade.
Hämta en kontrollgrupp	Visa information om en specifik kontrollgrupp.
Hämta en miljövariabel	Visa information om en specifik miljövariabel. Använder nyckelfältet för markering.
Hämta en privat plats	Visa information om en specifik privat plats.
Hämta ett kodfragment	Visa information om ett specifikt kodfragment.
Hämta ett kontrollresultat	Visa information om ett specifikt kontrollresultat.
Hämta ett underhållsperiod	Visa information om ett specifikt underhållsperiod.
Hämta hälsomått för privat plats från ett tidsfönster	Hämta hälsomått för privat plats från ett tidsfönster.
Hämta information om kontrollstatus	Visa aktuell statusinformation för en specifik kontroll.
Lista aviseringar för en specifik kontroll	Visar en lista över alla aviseringar för en specifik kontroll.
Skapa checkgruppsutlösaren	Skapar utlösaren för kontrollgruppen.
Skapa en API-kontroll	Skapar en ny API-kontroll. Returnerar en 402 när du överskrider gränsen för din plan. När du använder globalAlertSettingkan du alertSettingnull
Skapa en aviseringskanal	Skapar en ny aviseringskanal.
Skapa en instrumentpanel	Skapar en ny instrumentpanel. Returnerar en 409 när du försöker skapa en instrumentpanel med en anpassad URL eller anpassad domän som redan har tagits.
Skapa en kontroll [INAKTUELL]	[INAKTUELL] Den här slutpunkten tas bort måndagen den 4 juli 2022. Använd POST /checks/api i stället eller POST /checks/browser. Skapar ett nytt API eller en ny webbläsarkontroll. Returnerar en 402 när du överskrider gränsen för din plan. När du använder globalAlertSettingskan du alertSettingsnull
Skapa en kontrollgrupp	Skapar en ny kontrollgrupp. Du kan lägga till kontroller i gruppen genom att ange groupId-egenskapen för enskilda kontroller.
Skapa en miljövariabel	Skapar en ny miljövariabel.
Skapa en privat plats	Skapar en ny privat plats.
Skapa en webbläsarkontroll	Skapar en ny webbläsarkontroll. Returnerar en 402 när du överskrider gränsen för din plan. När du använder globalAlertSettingkan du alertSettingnull
Skapa ett kodfragment	Skapar ett nytt kodfragment.
Skapa ett underhållsperiod	Skapar en ny underhållsperiod.
Skapa kontrollutlösaren	Skapar kontrollutlösaren.
Ta bort checkgruppsutlösaren	Tar bort utlösaren för kontrollgrupper.
Ta bort checkutlösaren	Tar bort checkutlösaren.
Ta bort en aviseringskanal	Tar bort en aviseringskanal permanent.
Ta bort en befintlig API-nyckel för en privat plats	Tar bort en API-nyckel permanent från en privat plats.
Ta bort en instrumentpanel	Tar bort en instrumentpanel permanent.
Ta bort en kontroll	Permanent tar bort ett API eller en webbläsarkontroll och alla dess relaterade status- och resultatdata.
Ta bort en kontrollgrupp	Tar bort en kontrollgrupp permanent. Du kan inte ta bort en kontrollgrupp om den fortfarande innehåller kontroller.
Ta bort en miljövariabel	Tar bort en miljövariabel permanent. Använder nyckelfältet som identifierare för borttagning.
Ta bort en privat plats	Tar bort en privat plats permanent.
Ta bort en underhållsperiod	Tar bort ett underhållsperiod permanent.
Ta bort ett kodfragment	Tar bort ett kodfragment permanent.
Uppdatera en API-kontroll	Uppdaterar en API-kontroll.
Uppdatera en aviseringskanal	Uppdatera en aviseringskanal.
Uppdatera en instrumentpanel	Uppdaterar en instrumentpanel. Returnerar en 409 när du försöker skapa en instrumentpanel med en anpassad URL eller anpassad domän som redan har tagits.
Uppdatera en kontroll [INAKTUELL]	[INAKTUELL] Den här slutpunkten tas bort måndagen den 4 juli 2022. Använd PUT /checks/api/{id} i stället eller PUT /checks/browser/{id}. Uppdaterar ett nytt API eller en ny webbläsarkontroll.
Uppdatera en kontrollgrupp	Uppdaterar en kontrollgrupp.
Uppdatera en miljövariabel	Uppdaterar en miljövariabel. Använder nyckelfältet som identifierare för uppdatering. Uppdaterar endast värdet och den låsta egenskapen.
Uppdatera en privat plats	Uppdaterar en privat plats.
Uppdatera en webbläsarkontroll	Uppdaterar en webbläsarkontroll.
Uppdatera ett kodfragment	Uppdaterar ett kodfragment.
Uppdatera ett underhållsperiod	Uppdaterar ett underhållsperiod.
Uppdatera prenumerationerna för en aviseringskanal	Uppdatera prenumerationerna för en aviseringskanal. Använd det här alternativet om du vill lägga till en kontroll i en aviseringskanal så att fel- och återställningsaviseringar skickas ut för den kontrollen. Obs! När du skickar prenumerationsobjektet kan du bara ange ett checkId eller ett groupId, inte båda.
Visa en lista över alla aviseringar för ditt konto	Visar en lista över alla aviseringar för ditt konto.
Visa en lista över alla aviseringskanaler	Visar en lista över alla konfigurerade aviseringskanaler och deras prenumerationskontroller.
Visa en lista över alla instrumentpaneler	Visar en lista över alla aktuella instrumentpaneler i ditt konto.
Visa en lista över alla kodfragment	Visar en lista över alla aktuella kodfragment i ditt konto.
Visa en lista över alla kontroller	Visar en lista över alla aktuella kontroller i ditt konto.
Visa en lista över alla kontrollgrupper	Visar en lista över alla aktuella kontrollgrupper i ditt konto. Egenskapen checks är en matris med kontroll av UUID:er för praktiska hänvisningar. Den är skrivskyddad och du kan inte använda den för att lägga till kontroller i en grupp.
Visa en lista över alla kontrollstatusar	Visar aktuell statusinformation för alla kontroller i ditt konto. Kontrollstatusposterna uppdateras kontinuerligt när nya kontrollresultat kommer in.
Visa en lista över alla miljövariabler	Visar en lista över alla aktuella miljövariabler i ditt konto.
Visa en lista över alla privata platser	Visar en lista över alla privata platser i ditt konto.
Visa en lista över alla underhållsfönster	Visar en lista över alla underhållsperioder i ditt konto.
Visar en lista över alla kontrollresultat	Visar en lista över fullständiga, råa kontrollresultat för en specifik kontroll. Vi behåller råresultat i 30 dagar. Efter 30 dagar raderas de. Men vi behåller de samlade resultaten på obestämd tid. Du kan filtrera efter kontrolltyp och resultattyp för att begränsa listan. Använd parametrarna to och from för att ange ett datumintervall (UNIX-tidsstämpel i sekunder). Beroende på kontrolltypen kan vissa fält vara null. Den här slutpunkten returnerar data inom en tidsram på sex timmar. Om från och till params anges måste de ha högst sex timmars mellanrum. Om ingen har angetts kommer vi att överväga att param vara nu och från param till sex timmar tidigare. Om bara till param har angetts kommer vi att ställa in från till sex timmar tidigare. Tvärtom, om bara från param är inställd kommer vi att överväga att param vara sex timmar senare. Hastighetsbegränsning tillämpas på den här slutpunkten, du kan skicka högst 5 begäranden/10 sekunder.
Visar en lista över alla körningar som stöds	Visar en lista över alla körningskörningar som stöds och de inkluderade NPM-paketen för webbläsarkontroller och installations- och nedrivningsskript för API-kontroller.
Visar en lista över alla platser som stöds	Visar en lista över alla platser som stöds.
Visar information för en specifik körning	Visar information om alla inkluderade NPM-paket och deras version för en specifik körning.

Få kontrollstatusmärke

Åtgärds-ID:

GetV1BadgesChecksCheckid

Få kontrollstatusikonen.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kontrollera ID	checkId	True	string	Kontrollidentifieraren.
Stil	style		string	Stilen.
Theme	theme		string	Temat.
Svarstid	responseTime		boolean	Svarstiden.

Returer

response

string

Generera en ny API-nyckel för en privat plats

Åtgärds-ID:

PostV1PrivatelocationsIdKeys

Skapar en API-nyckel på den privata platsen.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	string	Identifieraren.

Returer

Body

privateLocationKeys

Genererar en anpassningsbar rapport för alla mått för webbläsarkontroll

Åtgärds-ID:

GetV2ReportingBrowserchecksId

Genererar en rapport med aggregerad eller icke-aggregerad statistik för en specifik webbläsarkontroll över ett angivet tidsfönster.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	string	Identifieraren.
Från	from		date	Anpassad starttid för rapportfönstret i unix-tidsstämpelformat. Om du ställer in en anpassad från tidsstämpel åsidosätts användningen av valfri förinställningWindow.
Till	to		date	Anpassad sluttid för rapporteringsfönstret i unix-tidsstämpelformat. Om du ställer in en anpassad tidsstämpel åsidosätts användningen av valfri förinställningWindow.
Förinställt fönster	presetWindow		string	Förinställda rapporteringsfönster används för att snabbt generera rapporter i vanliga fönster. Kan åsidosättas med hjälp av en anpassad till och från tidsstämpel.
Sammansättningsintervall	aggregationInterval		number	Tidsintervallet som ska användas för att aggregera mått i minuter. Till exempel är fem minuter 300, 24 timmar är 1440.
Gruppera efter	groupBy		string	Avgör hur seriedata grupperas.
Filtrera efter status	filterByStatus		array	Använd status för att filtrera efter resultatdata som misslyckas eller lyckas.
Metrics	metrics		array	måttalternativ för webbläsarkontroller.

Returer

Attributen.

Attributes

object

Genererar en rapport med sammanställd statistik för kontroller och kontrollgrupper

Åtgärds-ID:

GetV1Reporting

Genererar en rapport med aggregerad statistik för alla kontroller eller en filtrerad uppsättning kontroller under ett angivet tidsfönster.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Från	from		date	Anpassad starttid för rapportfönstret i unix-tidsstämpelformat. Om du ställer in en anpassad från tidsstämpel åsidosätts användningen av valfri förinställningWindow.
Till	to		date	Anpassad sluttid för rapporteringsfönstret i unix-tidsstämpelformat. Om du ställer in en anpassad tidsstämpel åsidosätts användningen av valfri förinställningWindow.
Förinställt fönster	presetWindow		string	Förinställda rapporteringsfönster används för att snabbt generera rapporter i vanliga fönster. Kan åsidosättas med hjälp av en anpassad till och från tidsstämpel.
Filtrera efter taggar	filterByTags		array	Använd taggar för att filtrera de kontroller som du vill se i rapporten.
Inaktiverad	deactivated		boolean	Filtrera kontroller efter aktiverad status.

Returer

Föremål

ReportingList

Get group status badge (Hämta gruppstatusmärke)

Åtgärds-ID:

GetV1BadgesGroupsGroupid

Hämta gruppstatusmärke.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
grupp-id	groupId	True	integer	Gruppidentifieraren.
Stil	style		string	Stilen.
Theme	theme		string	Temat.
Svarstid	responseTime		boolean	Svarstiden.

Returer

response

string

Hämta alla kontroller i en specifik grupp med gruppinställningar tillämpade

Åtgärds-ID:

GetV1CheckgroupsIdChecks

Visar en lista över alla kontroller i en specifik kontrollgrupp med de gruppinställningar som tillämpas.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	integer	Identifieraren.
Limit	limit		integer	Begränsa antalet resultat.
Nummer	page		number	Sidnumret.

Returer

Föremål

Model8

Hämta checkgruppsutlösaren

Åtgärds-ID:

GetV1TriggersCheckgroupsGroupid

Söker efter utlösaren för kontrollgruppen.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
grupp-id	groupId	True	integer	Gruppidentifieraren.

Returer

Body

CheckGroupTrigger

Hämta checkutlösaren

Åtgärds-ID:

GetV1TriggersChecksCheckid

Söker efter checkutlösaren.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kontrollera ID	checkId	True	string	Kontrollidentifieraren.

Returer

Body

CheckTrigger

Hämta en aviseringskanal

Åtgärds-ID:

GetV1AlertchannelsId

Visa information om en specifik aviseringskanal.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	integer	Identifieraren.

Returer

Body

AlertChannel

Hämta en kontroll

Åtgärds-ID:

GetV1ChecksId

Visa information om ett specifikt API eller webbläsarkontroll.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	string	Identifieraren.

Returer

Body

Check

Hämta en kontroll i en specifik grupp med gruppinställningar tillämpade

Åtgärds-ID:

GetV1CheckgroupsGroupidChecksCheckid

Visa information om en kontroll i en specifik kontrollgrupp med gruppinställningarna tillämpade.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
grupp-id	groupId	True	integer	Gruppidentifieraren.
Kontrollera ID	checkId	True	string	Kontrollidentifieraren.

Returer

Body

CheckGroupCheck

Hämta en kontrollgrupp

Åtgärds-ID:

GetV1CheckgroupsId

Visa information om en specifik kontrollgrupp.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	integer	Identifieraren.

Returer

Body

CheckGroup

Hämta en miljövariabel

Åtgärds-ID:

GetV1VariablesKey

Visa information om en specifik miljövariabel. Använder nyckelfältet för markering.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Key	key	True	string	Nyckeln.

Returer

Body

EnvironmentVariable

Hämta en privat plats

Åtgärds-ID:

GetV1PrivatelocationsId

Visa information om en specifik privat plats.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	string	Identifieraren.

Returer

Body

privatelocationschema

Hämta ett kodfragment

Åtgärds-ID:

GetV1SnippetsId

Visa information om ett specifikt kodfragment.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	integer	Identifieraren.

Returer

Body

Snippet

Hämta ett kontrollresultat

Åtgärds-ID:

GetV1CheckresultsCheckidCheckresultid

Visa information om ett specifikt kontrollresultat.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kontrollera ID	checkId	True	string	Kontrollidentifieraren.
Kontrollera resultat-ID	checkResultId	True	string	Kontrollera resultatidentifieraren.

Returer

Body

CheckResult

Hämta ett underhållsperiod

Åtgärds-ID:

GetV1MaintenancewindowsId

Visa information om ett specifikt underhållsperiod.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	integer	Identifieraren.

Returer

Body

MaintenanceWindow

Hämta hälsomått för privat plats från ett tidsfönster

Åtgärds-ID:

GetV1PrivatelocationsIdMetrics

Hämta hälsomått för privat plats från ett tidsfönster.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	string	Identifieraren.
Från	from	True	date	Välj mått som börjar med den här UNIX-tidsstämpeln. Måste vara mindre än 15 dagar sedan.
Till	to	True	date	Välj mått upp till den här UNIX-tidsstämpeln.

Returer

Body

privateLocationsMetricsHistoryResponseSchema

Hämta information om kontrollstatus

Åtgärds-ID:

GetV1CheckstatusesCheckid

Visa aktuell statusinformation för en specifik kontroll.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kontrollera ID	checkId	True	string	Kontrollidentifieraren.

Returer

Body

CheckStatus

Lista aviseringar för en specifik kontroll

Åtgärds-ID:

GetV1CheckalertsCheckid

Visar en lista över alla aviseringar för en specifik kontroll.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kontrollera ID	checkId	True	string	Kontrollidentifieraren.
Limit	limit		integer	Begränsa antalet resultat.
Nummer	page		number	Sidnumret.
Från	from		date	Välj dokument från den här UNIX-tidsstämpeln (>= datum). Standardvärdet är nu – 6 timmar.
Till	to		date	Välj aviseringar fram till den här UNIX-tidsstämpeln (< datum). Standardvärdet är 6 timmar efter från.

Returer

Föremål

CheckAlertList

Skapa checkgruppsutlösaren

Åtgärds-ID:

PostV1TriggersCheckgroupsGroupid

Skapar utlösaren för kontrollgruppen.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
grupp-id	groupId	True	integer	Gruppidentifieraren.

Returer

Body

CheckGroupTrigger

Skapa en API-kontroll

Åtgärds-ID:

PostV1ChecksApi

Skapar en ny API-kontroll. Returnerar en 402 när du överskrider gränsen för din plan. När du använder globalAlertSettingkan du alertSettingnull

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Tilldela aviseringar automatiskt	autoAssignAlerts		boolean	Avgör om en ny kontroll automatiskt läggs till som prenumerant i alla befintliga aviseringskanaler när den skapas.
Namn	name	True	string	Namnet på kontrollen.
Aktiverat	activated	True	boolean	Avgör om kontrollen körs eller inte.
Dämpad	muted		boolean	Avgör om några meddelanden skickas ut när en kontroll misslyckas och/eller återställs.
Dubbelkoll	doubleCheck		boolean	Om du anger sant utlöses ett nytt försök när en kontroll misslyckas från den misslyckade regionen och en annan, slumpmässigt vald region innan kontrollen markeras som misslyckad.
Bör misslyckas	shouldFail		boolean	Gör det möjligt att invertera beteendet för när en kontroll anses misslyckas. Tillåter validering av felstatus som 404.
Kontrollera platslista	locations		array of string	En matris med en eller flera datacenterplatser där den här kontrollen ska köras.
Kontrollera tagglista	tags		array of string	Taggar för att organisera och filtrera kontroller.
Eskaleringstyp	escalationType		string	Avgör vilken typ av eskalering som ska användas.
Tröskelvärde för misslyckad körning	failedRunThreshold		number	Efter hur många misslyckade på varandra följande kontroller som kör ett aviseringsmeddelande ska skickas.
Tröskelvärde för minuter som misslyckas	minutesFailingThreshold		number	Efter hur många minuter efter att en kontroll har börjat misslyckas ska en avisering skickas.
Mängd	amount		number	Hur många påminnelser som ska skickas efter det första aviseringsmeddelandet.
Intervall	interval		number	Vid vilket intervall påminnelserna ska skickas.
Enabled	enabled		boolean	Avgör om aviseringsmeddelanden ska skickas för utgångna SSL-certifikat.
Tröskelvärde för avisering	alertThreshold		integer	Vid vilken tidpunkt du ska börja avisera på SSL-certifikat.
Använda globala aviseringsinställningar	useGlobalAlertSettings		boolean	När det är sant används inställningen för avisering på kontonivå, inte den aviseringsinställning som definierats vid den här kontrollen.
grupp-id	groupId		number	Identifieraren för den kontrollgrupp som den här kontrollen ingår i.
Gruppordning	groupOrder		number	Positionen för den här kontrollen i en kontrollgrupp. Den avgör i vilken ordning kontroller körs när en grupp utlöses från API:et eller från CI/CD.
Körnings-ID	runtimeId		string	Körningsversionen, d.v.s. en fast uppsättning körningsberoenden, som används för att köra den här kontrollen.
Aviseringskanal-ID	alertChannelId	True	number	Aviseringskanalidentifieraren.
Aktiverat	activated	True	boolean	Om aktiverad.
method	method	True	string
URL	url	True	string	URL-adressen.
Följ omdirigeringar	followRedirects		boolean	Om följer omdirigeringar.
Hoppa över SSL	skipSSL		boolean	Om du vill hoppa över SSL.
Body	body		string	Kroppen.
bodyType	bodyType		string
Key	key	True	string	Nyckeln.
Värde	value	True	string	Värdet.
Låst	locked		boolean	Om låst.
Källa	source		string	Källan.
Fastighet	property		string	Egenskapen.
Jämförelse	comparison		string	Jämförelsen.
Target	target		string	Målet.
Användarnamn	username	True	string	Användarnamnet.
Lösenord	password	True	string	Lösenordet.
Frekvens	frequency		integer	Hur ofta kontrollen ska köras på några minuter.
Ta bort kodfragment-ID	tearDownSnippetId		number	En identifierarreferens till ett kodfragment som ska användas i fasen teardown i en API-kontroll.
Konfigurera kodfragment-ID	setupSnippetId		number	En identifierarreferens till ett kodfragment som ska användas i konfigurationsfasen för en API-kontroll.
Frekvensförskjutning	frequencyOffset		integer	Används för att ställa in sekunder för kontrollfrekvenser under 1 minut och sprida kontroller över ett tidsintervall för frekvenser över 1 minut. Detta fungerar på följande sätt: Kontroller med en frekvens på 0 kan ha en frequencyOffset på 10, 20 eller 30, vilket innebär att de körs var 10:e, 20:e eller 30:e sekund. Kontroller med en frekvens som är lägre än och lika med 60 kan ha en frequencyOffset mellan 1 och ett maxvärde baserat på formeln Math.floor(frequency * 10), dvs. för en kontroll som körs var 5:e minut är maxfrekvensenOffset 50. Kontroller med en frekvens som är högre än 60 kan ha en frequencyOffset mellan 1 och ett maxvärde baserat på formeln Math.ceil(frequency /60), d.v.s. för en kontroll som körs var 720:e minut är maxfrekvensenOffset 12.
Skript för lokal installation	localSetupScript		string	En giltig Node.js kod som ska köras i installationsfasen.
Lokalt nedslitet skript	localTearDownScript		string	En giltig del av Node.js kod som ska köras i fasen för nedtagning.
Degraderad svarstid	degradedResponseTime		number	Svarstiden i millisekunder där en kontroll ska betraktas som degraderad.
Maximal svarstid	maxResponseTime		number	Svarstiden i millisekunder där en kontroll bör betraktas som misslyckad.
Privata platser	privateLocations		array of string	En matris med en eller flera privata platser där kontrollen ska köras.

Returer

Body

CheckAPI

Skapa en aviseringskanal

Åtgärds-ID:

PostV1Alertchannels

Skapar en ny aviseringskanal.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id		number	Identifieraren.
Kontrollera ID	checkId		guid	Kontrollidentifieraren.
grupp-id	groupId		number	Gruppidentifieraren.
Aktiverat	activated	True	boolean	Om aktiverad.
Typ	type	True	string	Typ.
Skapa konfiguration för aviseringskanal	config	True	object	Aviseringskanalen skapar konfiguration.
Skicka återställning	sendRecovery		boolean	Om skicka återställning.
Sändningsfel	sendFailure		boolean	Om sändningsfel.
Skicka degraderad	sendDegraded		boolean	Om sändningen har degraderats.
SSL-förfallodatum	sslExpiry		boolean	Avgör om en avisering ska skickas för utgångna SSL-certifikat.
Tröskelvärde för SSL-förfallodatum	sslExpiryThreshold		integer	Vid vilken tidpunkt du ska börja avisera på SSL-certifikat.

Returer

Body

AlertChannel

Skapa en instrumentpanel

Åtgärds-ID:

PostV1Dashboards

Skapar en ny instrumentpanel. Returnerar en 409 när du försöker skapa en instrumentpanel med en anpassad URL eller anpassad domän som redan har tagits.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Anpassad URL	customUrl		string	Ett underdomännamn under checklyhq.com. Måste vara unikt för alla användare.
Anpassad domän	customDomain		string	En anpassad användardomän, t.ex. status.example.com. Se dokumenten om hur du uppdaterar din DNS- och SSL-användning.
Logotyp	logo		string	En URL som pekar på en bildfil.
Webbikon	favicon		string	En URL som pekar på en bildfil som används som instrumentpanelsfavorit.
Länk	link		string	En URL-länk för omdirigering när instrumentpanelens logotyp klickas på.
Header	header		string	En text som visas överst på instrumentpanelen.
Description	description		string	En text som visas under rubriken eller rubriken på instrumentpanelen.
Width	width		string	Avgör om du vill använda helskärmsläge eller fokus i mitten.
Uppdateringsintervall	refreshRate		number	Hur ofta instrumentpanelen ska uppdateras på några sekunder.
Paginera	paginate		boolean	Avgör om sidnumreringen är på eller av.
Sidnumreringshastighet	paginationRate		number	Hur ofta sidnumrering ska utlösas i sekunder.
Kontroller per sida	checksPerPage		number	Antal kontroller som visas per sida.
Använda och operator	useTagsAndOperator		boolean	När du ska använda AND-operatorn för uppslag av taggar.
Dölj taggar	hideTags		boolean	Visa eller dölj taggarna på instrumentpanelen.
Lista över instrumentpanelstaggar	tags		array of string	En lista över en eller flera taggar som filtrerar vilka kontroller som ska visas på instrumentpanelen.

Returer

Body

Dashboard

Skapa en kontroll [INAKTUELL]

Åtgärds-ID:

PostV1Checks

[INAKTUELL] Den här slutpunkten tas bort måndagen den 4 juli 2022. Använd POST /checks/api i stället eller POST /checks/browser. Skapar ett nytt API eller en ny webbläsarkontroll. Returnerar en 402 när du överskrider gränsen för din plan. När du använder globalAlertSettingskan du alertSettingsnull

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Tilldela aviseringar automatiskt	autoAssignAlerts		boolean	Avgör om en ny kontroll automatiskt läggs till som prenumerant i alla befintliga aviseringskanaler när den skapas.
Namn	name	True	string	Namnet på kontrollen.
Aktiverat	activated	True	boolean	Avgör om kontrollen körs eller inte.
Dämpad	muted		boolean	Avgör om några meddelanden skickas ut när en kontroll misslyckas och/eller återställs.
Dubbelkoll	doubleCheck		boolean	Om du anger sant utlöses ett nytt försök när en kontroll misslyckas från den misslyckade regionen och en annan, slumpmässigt vald region innan kontrollen markeras som misslyckad.
Bör misslyckas	shouldFail		boolean	Gör det möjligt att invertera beteendet för när en kontroll anses misslyckas. Tillåter validering av felstatus som 404.
Kontrollera platslista	locations		array of string	En matris med en eller flera datacenterplatser där den här kontrollen ska köras.
Kontrollera tagglista	tags		array of string	Taggar för att organisera och filtrera kontroller.
Eskaleringstyp	escalationType		string	Avgör vilken typ av eskalering som ska användas.
Tröskelvärde för misslyckad körning	failedRunThreshold		number	Efter hur många misslyckade på varandra följande kontroller som kör ett aviseringsmeddelande ska skickas.
Tröskelvärde för minuter som misslyckas	minutesFailingThreshold		number	Efter hur många minuter efter att en kontroll har börjat misslyckas ska en avisering skickas.
Mängd	amount		number	Hur många påminnelser som ska skickas efter det första aviseringsmeddelandet.
Intervall	interval		number	Vid vilket intervall påminnelserna ska skickas.
Enabled	enabled		boolean	Avgör om aviseringsmeddelanden ska skickas för utgångna SSL-certifikat.
Tröskelvärde för avisering	alertThreshold		integer	Vid vilken tidpunkt du ska börja avisera på SSL-certifikat.
Använda globala aviseringsinställningar	useGlobalAlertSettings		boolean	När det är sant används inställningen för avisering på kontonivå, inte den aviseringsinställning som definierats vid den här kontrollen.
grupp-id	groupId		number	Identifieraren för den kontrollgrupp som den här kontrollen ingår i.
Gruppordning	groupOrder		number	Positionen för den här kontrollen i en kontrollgrupp. Den avgör i vilken ordning kontroller körs när en grupp utlöses från API:et eller från CI/CD.
Körnings-ID	runtimeId		string	Körningsversionen, d.v.s. en fast uppsättning körningsberoenden, som används för att köra den här kontrollen.
Aviseringskanal-ID	alertChannelId	True	number	Aviseringskanalidentifieraren.
Aktiverat	activated	True	boolean	Om aktiverad.
Kontrollera typ	checkType	True	string	Typ av kontroll.
Frekvens	frequency		integer	Hur ofta kontrollen ska köras på några minuter.
Frekvensförskjutning	frequencyOffset		integer	Används för att ställa in sekunder för kontrollfrekvenser under 1 minut (endast för API-kontroller) och sprida kontroller över ett tidsintervall för frekvenser över 1 minut. Detta fungerar på följande sätt: Kontroller med en frekvens på 0 kan ha en frequencyOffset på 10, 20 eller 30, vilket innebär att de körs var 10:e, 20:e eller 30:e sekund. Kontroller med en frekvens som är lägre än och lika med 60 kan ha en frequencyOffset mellan 1 och ett maxvärde baserat på formeln Math.floor(frequency * 10), dvs. för en kontroll som körs var 5:e minut är maxfrekvensenOffset 50. Kontroller med en frekvens som är högre än 60 kan ha en frequencyOffset mellan 1 och ett maxvärde baserat på formeln Math.ceil(frequency /60), d.v.s. för en kontroll som körs var 720:e minut är maxfrekvensenOffset 12.
Kontrollera begäran	request		object	Kontrollbegäran.
Script	script	True	string	Skriptet.
Key	key	True	string	Nyckeln för miljövariabeln (det här värdet kan inte ändras).
Värde	value	True	string	Värdet för miljövariabeln.
Låst	locked		boolean	Används endast i användargränssnittet för att dölja värdet som ett lösenord.
Konfigurera kodfragment-ID	setupSnippetId		number	En identifierarreferens till ett kodfragment som ska användas i konfigurationsfasen för en API-kontroll.
Ta bort kodfragment-ID	tearDownSnippetId		number	En identifierarreferens till ett kodfragment som ska användas i fasen teardown i en API-kontroll.
Skript för lokal installation	localSetupScript		string	En giltig Node.js kod som ska köras i installationsfasen.
Lokalt nedslitet skript	localTearDownScript		string	En giltig del av Node.js kod som ska köras i fasen för nedtagning.
Degraderad svarstid	degradedResponseTime		number	Svarstiden i millisekunder där en kontroll ska betraktas som degraderad.
Maximal svarstid	maxResponseTime		number	Svarstiden i millisekunder där en kontroll bör betraktas som misslyckad.
Privata platser	privateLocations		array of string	En matris med en eller flera privata platser där kontrollen ska köras.

Returer

Body

Check

Skapa en kontrollgrupp

Åtgärds-ID:

PostV1Checkgroups

Skapar en ny kontrollgrupp. Du kan lägga till kontroller i gruppen genom att ange groupId-egenskapen för enskilda kontroller.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Tilldela aviseringar automatiskt	autoAssignAlerts		boolean	Avgör om en ny kontroll automatiskt läggs till som prenumerant i alla befintliga aviseringskanaler när den skapas.
Namn	name	True	string	Namnet på kontrollgruppen.
Aktiverat	activated		boolean	Avgör om kontrollerna i gruppen körs eller inte.
Dämpad	muted		boolean	Avgör om några meddelanden skickas ut när en incheckning i den här gruppen misslyckas och/eller återställs.
Kontrollera grupptagglista	tags		array of string	Taggar för att organisera och filtrera kontroller.
Kontrollera gruppplatslista	locations		array of string	En matris med en eller flera datacenterplatser där kontrollerna ska köras.
Konkurens	concurrency		number	Avgör hur många kontroller som anropas samtidigt när du utlöser en kontrollgrupp från CI/CD eller via API:et.
URL	url		string	Bas-URL:en för den här gruppen som du kan referera till med variabeln {{GROUP_BASE_URL}} i alla gruppkontroller.
Key	key	True	string	Nyckeln.
Värde	value	True	string	Värdet.
Låst	locked		boolean	Om låst.
Källa	source		string	Källan.
Fastighet	property		string	Egenskapen.
Jämförelse	comparison		string	Jämförelsen.
Target	target		string	Målet.
Användarnamn	username	True	string	Användarnamnet.
Lösenord	password	True	string	Lösenordet.
Kontrollera standardvärden för gruppskapa webbläsarkontroll	browserCheckDefaults		object	Standardinställningarna för kontrollgruppen skapa webbläsarkontroll.
Körnings-ID	runtimeId		string	Körningsversionen, d.v.s. en fast uppsättning körningsberoenden, som används för att köra kontroller i den här gruppen.
Key	key	True	string	Nyckeln för miljövariabeln (det här värdet kan inte ändras).
Värde	value	True	string	Värdet för miljövariabeln.
Låst	locked		boolean	Används endast i användargränssnittet för att dölja värdet som ett lösenord.
Dubbelkoll	doubleCheck		boolean	Om du anger sant utlöses ett nytt försök när en kontroll misslyckas från den misslyckade regionen och en annan, slumpmässigt vald region innan kontrollen markeras som misslyckad.
Använda globala aviseringsinställningar	useGlobalAlertSettings		boolean	När det är sant används inställningen för avisering på kontonivå, inte aviseringsinställningen som definierats i den här kontrollgruppen.
Eskaleringstyp	escalationType		string	Avgör vilken typ av eskalering som ska användas.
Tröskelvärde för misslyckad körning	failedRunThreshold		number	Efter hur många misslyckade på varandra följande kontroller som kör ett aviseringsmeddelande ska skickas.
Tröskelvärde för minuter som misslyckas	minutesFailingThreshold		number	Efter hur många minuter efter att en kontroll har börjat misslyckas ska en avisering skickas.
Mängd	amount		number	Hur många påminnelser som ska skickas efter det första aviseringsmeddelandet.
Intervall	interval		number	Vid vilket intervall påminnelserna ska skickas.
Enabled	enabled		boolean	Avgör om aviseringsmeddelanden ska skickas för utgångna SSL-certifikat.
Tröskelvärde för avisering	alertThreshold		integer	Vid vilken tidpunkt du ska börja avisera på SSL-certifikat.
Aviseringskanal-ID	alertChannelId	True	number	Aviseringskanalidentifieraren.
Aktiverat	activated	True	boolean	Om aktiverad.
Konfigurera kodfragment-ID	setupSnippetId		number	En identifierarreferens till ett kodfragment som ska användas i installationsfasen för en API-kontroll i den här gruppen.
Ta bort kodfragment-ID	tearDownSnippetId		number	En identifierarreferens till ett kodfragment som ska användas i fasen för nedtagning av en API-kontroll i den här gruppen.
Skript för lokal installation	localSetupScript		string	En giltig Node.js kod som ska köras i installationsfasen för en API-kontroll i den här gruppen.
Lokalt nedslitet skript	localTearDownScript		string	En giltig del av Node.js kod som ska köras i fasen för nedtagning av en API-kontroll i den här gruppen.
Kontrollera privata platser	privateLocations		array of string	En matris med en eller flera privata platser där kontrollerna ska köras.

Returer

Body

CheckGroup

Skapa en miljövariabel

Åtgärds-ID:

PostV1Variables

Skapar en ny miljövariabel.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Key	key	True	string	Nyckeln för miljövariabeln (det här värdet kan inte ändras).
Värde	value	True	string	Värdet för miljövariabeln.
Låst	locked		boolean	Används endast i användargränssnittet för att dölja värdet som ett lösenord.

Returer

Body

EnvironmentVariable

Skapa en privat plats

Åtgärds-ID:

PostV1Privatelocations

Skapar en ny privat plats.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Namn	name	True	string	Namnet som tilldelats den privata platsen.
Snigelnamn	slugName	True	string	Giltigt snigelnamn.
Icon	icon		string	Ikonen.

Returer

Body

commonPrivateLocationSchemaResponse

Skapa en webbläsarkontroll

Åtgärds-ID:

PostV1ChecksBrowser

Skapar en ny webbläsarkontroll. Returnerar en 402 när du överskrider gränsen för din plan. När du använder globalAlertSettingkan du alertSettingnull

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Tilldela aviseringar automatiskt	autoAssignAlerts		boolean	Avgör om en ny kontroll automatiskt läggs till som prenumerant i alla befintliga aviseringskanaler när den skapas.
Namn	name	True	string	Namnet på kontrollen.
Aktiverat	activated	True	boolean	Avgör om kontrollen körs eller inte.
Dämpad	muted		boolean	Avgör om några meddelanden skickas ut när en kontroll misslyckas och/eller återställs.
Dubbelkoll	doubleCheck		boolean	Om du anger sant utlöses ett nytt försök när en kontroll misslyckas från den misslyckade regionen och en annan, slumpmässigt vald region innan kontrollen markeras som misslyckad.
Bör misslyckas	shouldFail		boolean	Gör det möjligt att invertera beteendet för när en kontroll anses misslyckas. Tillåter validering av felstatus som 404.
Kontrollera platslista	locations		array of string	En matris med en eller flera datacenterplatser där den här kontrollen ska köras.
Kontrollera tagglista	tags		array of string	Taggar för att organisera och filtrera kontroller.
Eskaleringstyp	escalationType		string	Avgör vilken typ av eskalering som ska användas.
Tröskelvärde för misslyckad körning	failedRunThreshold		number	Efter hur många misslyckade på varandra följande kontroller som kör ett aviseringsmeddelande ska skickas.
Tröskelvärde för minuter som misslyckas	minutesFailingThreshold		number	Efter hur många minuter efter att en kontroll har börjat misslyckas ska en avisering skickas.
Mängd	amount		number	Hur många påminnelser som ska skickas efter det första aviseringsmeddelandet.
Intervall	interval		number	Vid vilket intervall påminnelserna ska skickas.
Enabled	enabled		boolean	Avgör om aviseringsmeddelanden ska skickas för utgångna SSL-certifikat.
Tröskelvärde för avisering	alertThreshold		integer	Vid vilken tidpunkt du ska börja avisera på SSL-certifikat.
Använda globala aviseringsinställningar	useGlobalAlertSettings		boolean	När det är sant används inställningen för avisering på kontonivå, inte den aviseringsinställning som definierats vid den här kontrollen.
grupp-id	groupId		number	Identifieraren för den kontrollgrupp som den här kontrollen ingår i.
Gruppordning	groupOrder		number	Positionen för den här kontrollen i en kontrollgrupp. Den avgör i vilken ordning kontroller körs när en grupp utlöses från API:et eller från CI/CD.
Körnings-ID	runtimeId		string	Körningsversionen, d.v.s. en fast uppsättning körningsberoenden, som används för att köra den här kontrollen.
Aviseringskanal-ID	alertChannelId	True	number	Aviseringskanalidentifieraren.
Aktiverat	activated	True	boolean	Om aktiverad.
Key	key	True	string	Nyckeln för miljövariabeln (det här värdet kan inte ändras).
Värde	value	True	string	Värdet för miljövariabeln.
Låst	locked		boolean	Används endast i användargränssnittet för att dölja värdet som ett lösenord.
Frekvens	frequency		integer	Hur ofta kontrollen ska köras på några minuter.
Script	script	True	string	En giltig del av Node.js javascript-kod som beskriver en webbläsarinteraktion med Puppeteer- eller Playwright-ramverken.
Privata platser	privateLocations		array of string	En matris med en eller flera privata platser där kontrollen ska köras.

Returer

Body

CheckBrowser

Skapa ett kodfragment

Åtgärds-ID:

PostV1Snippets

Skapar ett nytt kodfragment.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Namn	name	True	string	Kodfragmentets namn.
Script	script	True	string	Din Node.js kod som interagerar med API-kontrolllivscykeln eller fungerar som en del för webbläsarkontroller.

Returer

Body

Snippet

Skapa ett underhållsperiod

Åtgärds-ID:

PostV1Maintenancewindows

Skapar en ny underhållsperiod.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Namn	name	True	string	Namnet på underhållsfönstret.
Lista över underhållsfönstertaggar	tags		array of string	Namnen på underhållsfönstret för kontroller och grupper bör gälla för.
Startar vid	startsAt	True	date	Startdatumet för underhållsfönstret.
Slutar vid	endsAt	True	date	Slutdatum för underhållsperioden.
Upprepa intervall	repeatInterval		number	Underhållsfönstrets upprepningsintervall från den första förekomsten.
Upprepa enhet	repeatUnit	True	string	Upprepningsstrategin för underhållsfönstret.
Upprepa slutar vid	repeatEndsAt		date	Slutdatumet då underhållsperioden ska sluta upprepas.

Returer

Body

MaintenanceWindow

Skapa kontrollutlösaren

Åtgärds-ID:

PostV1TriggersChecksCheckid

Skapar kontrollutlösaren.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kontrollera ID	checkId	True	string	Kontrollidentifieraren.

Returer

Body

CheckTrigger

Ta bort checkgruppsutlösaren

Åtgärds-ID:

DeleteV1TriggersCheckgroupsGroupid

Tar bort utlösaren för kontrollgrupper.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
grupp-id	groupId	True	integer	Gruppidentifieraren.

Ta bort checkutlösaren

Åtgärds-ID:

DeleteV1TriggersChecksCheckid

Tar bort checkutlösaren.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kontrollera ID	checkId	True	string	Kontrollidentifieraren.

Ta bort en aviseringskanal

Åtgärds-ID:

DeleteV1AlertchannelsId

Tar bort en aviseringskanal permanent.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	integer	Identifieraren.

Ta bort en befintlig API-nyckel för en privat plats

Åtgärds-ID:

DeleteV1PrivatelocationsIdKeysKeyid

Tar bort en API-nyckel permanent från en privat plats.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	string	Identifieraren.
Nyckel-ID	keyId	True	string	Nyckelidentifieraren.

Ta bort en instrumentpanel

Åtgärds-ID:

DeleteV1DashboardsDashboardid

Tar bort en instrumentpanel permanent.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	dashboardId	True	string	Instrumentpanelsidentifieraren.

Ta bort en kontroll

Åtgärds-ID:

DeleteV1ChecksId

Permanent tar bort ett API eller en webbläsarkontroll och alla dess relaterade status- och resultatdata.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	string	Identifieraren.

Ta bort en kontrollgrupp

Åtgärds-ID:

DeleteV1CheckgroupsId

Tar bort en kontrollgrupp permanent. Du kan inte ta bort en kontrollgrupp om den fortfarande innehåller kontroller.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	integer	Identifieraren.

Ta bort en miljövariabel

Åtgärds-ID:

DeleteV1VariablesKey

Tar bort en miljövariabel permanent. Använder nyckelfältet som identifierare för borttagning.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Key	key	True	string	Nyckeln.

Ta bort en privat plats

Åtgärds-ID:

DeleteV1PrivatelocationsId

Tar bort en privat plats permanent.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	string	Identifieraren.

Ta bort en underhållsperiod

Åtgärds-ID:

DeleteV1MaintenancewindowsId

Tar bort ett underhållsperiod permanent.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	integer	Identifieraren.

Ta bort ett kodfragment

Åtgärds-ID:

DeleteV1SnippetsId

Tar bort ett kodfragment permanent.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	integer	Identifieraren.

Uppdatera en API-kontroll

Åtgärds-ID:

PutV1ChecksApiId

Uppdaterar en API-kontroll.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	string	Identifieraren.
Tilldela aviseringar automatiskt	autoAssignAlerts		boolean	Avgör om en ny kontroll automatiskt läggs till som prenumerant i alla befintliga aviseringskanaler när den skapas.
Namn	name		string	Namnet på kontrollen.
Aktiverat	activated		boolean	Avgör om kontrollen körs eller inte.
Dämpad	muted		boolean	Avgör om några meddelanden skickas ut när en kontroll misslyckas och/eller återställs.
Dubbelkoll	doubleCheck		boolean	Om du anger sant utlöses ett nytt försök när en kontroll misslyckas från den misslyckade regionen och en annan, slumpmässigt vald region innan kontrollen markeras som misslyckad.
Bör misslyckas	shouldFail		boolean	Gör det möjligt att invertera beteendet för när en kontroll anses misslyckas. Tillåter validering av felstatus som 404.
Kontrollera platslista	locations		array of string	En matris med en eller flera datacenterplatser där den här kontrollen ska köras.
Kontrollera tagglista	tags		array of string	Taggar för att organisera och filtrera kontroller.
Eskaleringstyp	escalationType		string	Avgör vilken typ av eskalering som ska användas.
Tröskelvärde för misslyckad körning	failedRunThreshold		number	Efter hur många misslyckade på varandra följande kontroller som kör ett aviseringsmeddelande ska skickas.
Tröskelvärde för minuter som misslyckas	minutesFailingThreshold		number	Efter hur många minuter efter att en kontroll har börjat misslyckas ska en avisering skickas.
Mängd	amount		number	Hur många påminnelser som ska skickas efter det första aviseringsmeddelandet.
Intervall	interval		number	Vid vilket intervall påminnelserna ska skickas.
Enabled	enabled		boolean	Avgör om aviseringsmeddelanden ska skickas för utgångna SSL-certifikat.
Tröskelvärde för avisering	alertThreshold		integer	Vid vilken tidpunkt du ska börja avisera på SSL-certifikat.
Använda globala aviseringsinställningar	useGlobalAlertSettings		boolean	När det är sant används inställningen för avisering på kontonivå, inte den aviseringsinställning som definierats vid den här kontrollen.
grupp-id	groupId		number	Identifieraren för den kontrollgrupp som den här kontrollen ingår i.
Gruppordning	groupOrder		number	Positionen för den här kontrollen i en kontrollgrupp. Den avgör i vilken ordning kontroller körs när en grupp utlöses från API:et eller från CI/CD.
Körnings-ID	runtimeId		string	Körningsversionen, d.v.s. en fast uppsättning körningsberoenden, som används för att köra den här kontrollen.
Aviseringskanal-ID	alertChannelId	True	number	Aviseringskanalidentifieraren.
Aktiverat	activated	True	boolean	Om aktiverad.
method	method	True	string
URL	url	True	string	URL-adressen.
Följ omdirigeringar	followRedirects		boolean	Om du vill följa omdirigeringar.
Hoppa över SSL	skipSSL		boolean	Om du vill hoppa över SSL.
Body	body		string	Kroppen.
Kroppstyp	bodyType		string	Brödtexttypen.
Key	key	True	string	Nyckeln.
Värde	value	True	string	Värdet.
Låst	locked		boolean	Om låst.
Källa	source		string	Källan.
Fastighet	property		string	Egenskapen.
Jämförelse	comparison		string	Jämförelsen.
Target	target		string	Målet.
Användarnamn	username	True	string	Användarnamnet.
Lösenord	password	True	string	Lösenordet.
Frekvens	frequency		integer	Hur ofta kontrollen ska köras på några minuter.
Ta bort kodfragment-ID	tearDownSnippetId		number	En identifierarreferens till ett kodfragment som ska användas i fasen teardown i en API-kontroll.
Konfigurera kodfragment-ID	setupSnippetId		number	En identifierarreferens till ett kodfragment som ska användas i konfigurationsfasen för en API-kontroll.
Frekvensförskjutning	frequencyOffset		integer	Används för att ställa in sekunder för kontrollfrekvenser under 1 minut och sprida kontroller över ett tidsintervall för frekvenser över 1 minut. Detta fungerar på följande sätt: Kontroller med en frekvens på 0 kan ha en frequencyOffset på 10, 20 eller 30, vilket innebär att de körs var 10:e, 20:e eller 30:e sekund. Kontroller med en frekvens som är lägre än och lika med 60 kan ha en frequencyOffset mellan 1 och ett maxvärde baserat på formeln Math.floor(frequency * 10), dvs. för en kontroll som körs var 5:e minut är maxfrekvensenOffset 50. Kontroller med en frekvens som är högre än 60 kan ha en frequencyOffset mellan 1 och ett maxvärde baserat på formeln Math.ceil(frequency /60), d.v.s. för en kontroll som körs var 720:e minut är maxfrekvensenOffset 12.
Skript för lokal installation	localSetupScript		string	En giltig Node.js kod som ska köras i installationsfasen.
Lokalt nedslitet skript	localTearDownScript		string	En giltig del av Node.js kod som ska köras i fasen för nedtagning.
Degraderad svarstid	degradedResponseTime		number	Svarstiden i millisekunder där en kontroll ska betraktas som degraderad.
Maximal svarstid	maxResponseTime		number	Svarstiden i millisekunder där en kontroll bör betraktas som misslyckad.
Privata platser	privateLocations		array of string	En matris med en eller flera privata platser där kontrollen ska köras.

Returer

Body

CheckAPI

Uppdatera en aviseringskanal

Åtgärds-ID:

PutV1AlertchannelsId

Uppdatera en aviseringskanal.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	integer	Identifieraren.
ID-nummer	id		number	Identifieraren.
Kontrollera ID	checkId		guid	Kontrollidentifieraren.
grupp-id	groupId		number	Gruppidentifieraren.
Aktiverat	activated	True	boolean	Om aktiverad.
Typ	type	True	string	Typ.
Skapa konfiguration för aviseringskanal	config	True	object	Aviseringskanalen skapar konfiguration.
Skicka återställning	sendRecovery		boolean	Om skicka återställning.
Sändningsfel	sendFailure		boolean	Om sändningsfel.
Skicka degraderad	sendDegraded		boolean	Om sändningen har degraderats.
SSL-förfallodatum	sslExpiry		boolean	Avgör om en avisering ska skickas för utgångna SSL-certifikat.
Tröskelvärde för SSL-förfallodatum	sslExpiryThreshold		integer	Vid vilken tidpunkt du ska börja avisera på SSL-certifikat.

Returer

Body

AlertChannel

Uppdatera en instrumentpanel

Åtgärds-ID:

PutV1DashboardsDashboardid

Uppdaterar en instrumentpanel. Returnerar en 409 när du försöker skapa en instrumentpanel med en anpassad URL eller anpassad domän som redan har tagits.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	dashboardId	True	string	Instrumentpanelsidentifieraren.
Anpassad URL	customUrl		string	Ett underdomännamn under checklyhq.com. Måste vara unikt för alla användare.
Anpassad domän	customDomain		string	En anpassad användardomän, t.ex. status.example.com. Se dokumenten om hur du uppdaterar din DNS- och SSL-användning.
Logotyp	logo		string	En URL som pekar på en bildfil.
Webbikon	favicon		string	En URL som pekar på en bildfil som används som instrumentpanelsfavorit.
Länk	link		string	En URL-länk för omdirigering när instrumentpanelens logotyp klickas på.
Header	header		string	En text som visas överst på instrumentpanelen.
Description	description		string	En text som visas under rubriken eller rubriken på instrumentpanelen.
Width	width		string	Avgör om du vill använda helskärmsläge eller fokus i mitten.
Uppdateringsintervall	refreshRate		number	Hur ofta instrumentpanelen ska uppdateras på några sekunder.
Paginera	paginate		boolean	Avgör om sidnumreringen är på eller av.
Sidnumreringshastighet	paginationRate		number	Hur ofta sidnumrering ska utlösas i sekunder.
Kontroller per sida	checksPerPage		number	Antal kontroller som visas per sida.
Använda och operator	useTagsAndOperator		boolean	När du ska använda AND-operatorn för uppslag av taggar.
Dölj taggar	hideTags		boolean	Visa eller dölj taggarna på instrumentpanelen.
Lista över instrumentpanelstaggar	tags		array of string	En lista över en eller flera taggar som filtrerar vilka kontroller som ska visas på instrumentpanelen.

Returer

Body

Dashboard

Uppdatera en kontroll [INAKTUELL]

Åtgärds-ID:

PutV1ChecksId

[INAKTUELL] Den här slutpunkten tas bort måndagen den 4 juli 2022. Använd PUT /checks/api/{id} i stället eller PUT /checks/browser/{id}. Uppdaterar ett nytt API eller en ny webbläsarkontroll.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	string	Identifieraren.
Tilldela aviseringar automatiskt	autoAssignAlerts		boolean	Avgör om en ny kontroll automatiskt läggs till som prenumerant i alla befintliga aviseringskanaler när den skapas.
Namn	name		string	Namnet på kontrollen.
Aktiverat	activated		boolean	Avgör om kontrollen körs eller inte.
Dämpad	muted		boolean	Avgör om några meddelanden skickas ut när en kontroll misslyckas och/eller återställs.
Dubbelkoll	doubleCheck		boolean	Om du anger sant utlöses ett nytt försök när en kontroll misslyckas från den misslyckade regionen och en annan, slumpmässigt vald region innan kontrollen markeras som misslyckad.
Bör misslyckas	shouldFail		boolean	Gör det möjligt att invertera beteendet för när en kontroll anses misslyckas. Tillåter validering av felstatus som 404.
Kontrollera platslista	locations		array of string	En matris med en eller flera datacenterplatser där den här kontrollen ska köras.
Kontrollera tagglista	tags		array of string	Taggar för att organisera och filtrera kontroller.
Eskaleringstyp	escalationType		string	Avgör vilken typ av eskalering som ska användas.
Tröskelvärde för misslyckad körning	failedRunThreshold		number	Efter hur många misslyckade på varandra följande kontroller som kör ett aviseringsmeddelande ska skickas.
Tröskelvärde för minuter som misslyckas	minutesFailingThreshold		number	Efter hur många minuter efter att en kontroll har börjat misslyckas ska en avisering skickas.
Mängd	amount		number	Hur många påminnelser som ska skickas efter det första aviseringsmeddelandet.
Intervall	interval		number	Vid vilket intervall påminnelserna ska skickas.
Enabled	enabled		boolean	Avgör om aviseringsmeddelanden ska skickas för utgångna SSL-certifikat.
Tröskelvärde för avisering	alertThreshold		integer	Vid vilken tidpunkt du ska börja avisera på SSL-certifikat.
Använda globala aviseringsinställningar	useGlobalAlertSettings		boolean	När det är sant används inställningen för avisering på kontonivå, inte den aviseringsinställning som definierats vid den här kontrollen.
grupp-id	groupId		number	Identifieraren för den kontrollgrupp som den här kontrollen ingår i.
Gruppordning	groupOrder		number	Positionen för den här kontrollen i en kontrollgrupp. Den avgör i vilken ordning kontroller körs när en grupp utlöses från API:et eller från CI/CD.
Körnings-ID	runtimeId		string	Körningsversionen, d.v.s. en fast uppsättning körningsberoenden, som används för att köra den här kontrollen.
Aviseringskanal-ID	alertChannelId	True	number	Aviseringskanalidentifieraren.
Aktiverat	activated	True	boolean	Om aktiverad.
Kontrollera typ	checkType		string	Typ av kontroll.
Frekvens	frequency		integer	Hur ofta kontrollen ska köras på några minuter.
Frekvensförskjutning	frequencyOffset		integer	Används för att ställa in sekunder för kontrollfrekvenser under 1 minut (endast för API-kontroller) och sprida kontroller över ett tidsintervall för frekvenser över 1 minut. Detta fungerar på följande sätt: Kontroller med en frekvens på 0 kan ha en frequencyOffset på 10, 20 eller 30, vilket innebär att de körs var 10:e, 20:e eller 30:e sekund. Kontroller med en frekvens som är lägre än och lika med 60 kan ha en frequencyOffset mellan 1 och ett maxvärde baserat på formeln Math.floor(frequency * 10), dvs. för en kontroll som körs var 5:e minut är maxfrekvensenOffset 50. Kontroller med en frekvens som är högre än 60 kan ha en frequencyOffset mellan 1 och ett maxvärde baserat på formeln Math.ceil(frequency /60), d.v.s. för en kontroll som körs var 720:e minut är maxfrekvensenOffset 12.
Kontrollera begäran	request	True	object	Kontrollbegäran.
Script	script	True	string	Skriptet.
Key	key	True	string	Nyckeln för miljövariabeln (det här värdet kan inte ändras).
Värde	value	True	string	Värdet för miljövariabeln.
Låst	locked		boolean	Används endast i användargränssnittet för att dölja värdet som ett lösenord.
Konfigurera kodfragment-ID	setupSnippetId		number	En identifierarreferens till ett kodfragment som ska användas i konfigurationsfasen för en API-kontroll.
Ta bort kodfragment-ID	tearDownSnippetId		number	En identifierarreferens till ett kodfragment som ska användas i fasen teardown i en API-kontroll.
Skript för lokal installation	localSetupScript		string	En giltig Node.js kod som ska köras i installationsfasen.
Lokalt nedslitet skript	localTearDownScript		string	En giltig del av Node.js kod som ska köras i fasen för nedtagning.
Degraderad svarstid	degradedResponseTime		number	Svarstiden i millisekunder där en kontroll ska betraktas som degraderad.
Maximal svarstid	maxResponseTime		number	Svarstiden i millisekunder där en kontroll bör betraktas som misslyckad.
Privata platser	privateLocations		array of string	En matris med en eller flera privata platser där kontrollen ska köras.

Returer

Body

Check

Uppdatera en kontrollgrupp

Åtgärds-ID:

PutV1CheckgroupsId

Uppdaterar en kontrollgrupp.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	integer	Identifieraren.
Tilldela aviseringar automatiskt	autoAssignAlerts		boolean	Avgör om en ny kontroll automatiskt läggs till som prenumerant i alla befintliga aviseringskanaler när den skapas.
Namn	name		string	Namnet på kontrollgruppen.
Aktiverat	activated		boolean	Avgör om kontrollerna i gruppen körs eller inte.
Dämpad	muted		boolean	Avgör om några meddelanden skickas ut när en incheckning i den här gruppen misslyckas och/eller återställs.
Kontrollera grupptagglista	tags		array of string	Taggar för att organisera och filtrera kontroller.
Kontrollera gruppplatslista	locations		array of string	En matris med en eller flera datacenterplatser där kontrollerna ska köras.
Konkurens	concurrency		number	Avgör hur många kontroller som anropas samtidigt när du utlöser en kontrollgrupp från CI/CD eller via API:et.
URL	url		string	Bas-URL:en för den här gruppen som du kan referera till med variabeln {{GROUP_BASE_URL}} i alla gruppkontroller.
Key	key	True	string	Nyckeln.
Värde	value	True	string	Värdet.
Låst	locked		boolean	Om låst.
Källa	source		string	Källan.
Fastighet	property		string	Egenskapen.
Jämförelse	comparison		string	Jämförelsen.
Target	target		string	Målet.
Användarnamn	username	True	string	Användarnamnet.
Lösenord	password	True	string	Lösenordet.
Kontrollera standardvärden för gruppskapa webbläsarkontroll	browserCheckDefaults		object	Standardinställningarna för kontrollgruppen skapa webbläsarkontroll.
Körnings-ID	runtimeId		string	Körningsversionen, d.v.s. en fast uppsättning körningsberoenden, som används för att köra kontroller i den här gruppen.
Key	key	True	string	Nyckeln för miljövariabeln (det här värdet kan inte ändras).
Värde	value	True	string	Värdet för miljövariabeln.
Låst	locked		boolean	Används endast i användargränssnittet för att dölja värdet som ett lösenord.
Dubbelkoll	doubleCheck		boolean	Om du anger sant utlöses ett nytt försök när en kontroll misslyckas från den misslyckade regionen och en annan, slumpmässigt vald region innan kontrollen markeras som misslyckad.
Använda globala aviseringsinställningar	useGlobalAlertSettings		boolean	När det är sant används inställningen för avisering på kontonivå, inte aviseringsinställningen som definierats i den här kontrollgruppen.
Eskaleringstyp	escalationType		string	Avgör vilken typ av eskalering som ska användas.
Tröskelvärde för misslyckad körning	failedRunThreshold		number	Efter hur många misslyckade på varandra följande kontroller som kör ett aviseringsmeddelande ska skickas.
Tröskelvärde för minuter som misslyckas	minutesFailingThreshold		number	Efter hur många minuter efter att en kontroll har börjat misslyckas ska en avisering skickas.
Mängd	amount		number	Hur många påminnelser som ska skickas efter det första aviseringsmeddelandet.
Intervall	interval		number	Vid vilket intervall påminnelserna ska skickas.
Enabled	enabled		boolean	Avgör om aviseringsmeddelanden ska skickas för utgångna SSL-certifikat.
Tröskelvärde för avisering	alertThreshold		integer	Vid vilken tidpunkt du ska börja avisera på SSL-certifikat.
Aviseringskanal-ID	alertChannelId	True	number	Aviseringskanalidentifieraren.
Aktiverat	activated	True	boolean	Om aktiverad.
Konfigurera kodfragment-ID	setupSnippetId		number	En identifierarreferens till ett kodfragment som ska användas i installationsfasen för en API-kontroll i den här gruppen.
Ta bort kodfragment-ID	tearDownSnippetId		number	En identifierarreferens till ett kodfragment som ska användas i fasen för nedtagning av en API-kontroll i den här gruppen.
Skript för lokal installation	localSetupScript		string	En giltig Node.js kod som ska köras i installationsfasen för en API-kontroll i den här gruppen.
Lokalt nedslitet skript	localTearDownScript		string	En giltig del av Node.js kod som ska köras i fasen för nedtagning av en API-kontroll i den här gruppen.
Kontrollera privata platser	privateLocations		array of string	En matris med en eller flera privata platser där kontrollerna ska köras.

Returer

Body

CheckGroup

Uppdatera en miljövariabel

Åtgärds-ID:

PutV1VariablesKey

Uppdaterar en miljövariabel. Använder nyckelfältet som identifierare för uppdatering. Uppdaterar endast värdet och den låsta egenskapen.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Key	key	True	string	Nyckeln.
Key	key		string	Nyckeln för miljövariabeln (det här värdet kan inte ändras).
Värde	value	True	string	Värdet för miljövariabeln.
Låst	locked		boolean	Används endast i användargränssnittet för att dölja värdet som ett lösenord.

Returer

Body

EnvironmentVariable

Uppdatera en privat plats

Åtgärds-ID:

PutV1PrivatelocationsId

Uppdaterar en privat plats.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	string	Identifieraren.
Namn	name	True	string	Namnet som tilldelats den privata platsen.
Icon	icon		string	Ikonen.

Returer

Body

commonPrivateLocationSchemaResponse

Uppdatera en webbläsarkontroll

Åtgärds-ID:

PutV1ChecksBrowserId

Uppdaterar en webbläsarkontroll.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	string	Identifieraren.
Tilldela aviseringar automatiskt	autoAssignAlerts		boolean	Avgör om en ny kontroll automatiskt läggs till som prenumerant i alla befintliga aviseringskanaler när den skapas.
Namn	name		string	Namnet på kontrollen.
Aktiverat	activated		boolean	Avgör om kontrollen körs eller inte.
Dämpad	muted		boolean	Avgör om några meddelanden skickas ut när en kontroll misslyckas och/eller återställs.
Dubbelkoll	doubleCheck		boolean	Om du anger sant utlöses ett nytt försök när en kontroll misslyckas från den misslyckade regionen och en annan, slumpmässigt vald region innan kontrollen markeras som misslyckad.
Bör misslyckas	shouldFail		boolean	Gör det möjligt att invertera beteendet för när en kontroll anses misslyckas. Tillåter validering av felstatus som 404.
Kontrollera platslista	locations		array of string	En matris med en eller flera datacenterplatser där den här kontrollen ska köras.
Kontrollera tagglista	tags		array of string	Taggar för att organisera och filtrera kontroller.
Eskaleringstyp	escalationType		string	Avgör vilken typ av eskalering som ska användas.
Tröskelvärde för misslyckad körning	failedRunThreshold		number	Efter hur många misslyckade på varandra följande kontroller som kör ett aviseringsmeddelande ska skickas.
Tröskelvärde för minuter som misslyckas	minutesFailingThreshold		number	Efter hur många minuter efter att en kontroll har börjat misslyckas ska en avisering skickas.
Mängd	amount		number	Hur många påminnelser som ska skickas efter det första aviseringsmeddelandet.
Intervall	interval		number	Vid vilket intervall påminnelserna ska skickas.
Enabled	enabled		boolean	Avgör om aviseringsmeddelanden ska skickas för utgångna SSL-certifikat.
Tröskelvärde för avisering	alertThreshold		integer	Vid vilken tidpunkt du ska börja avisera på SSL-certifikat.
Använda globala aviseringsinställningar	useGlobalAlertSettings		boolean	När det är sant används inställningen för avisering på kontonivå, inte den aviseringsinställning som definierats vid den här kontrollen.
grupp-id	groupId		number	Identifieraren för den kontrollgrupp som den här kontrollen ingår i.
Gruppordning	groupOrder		number	Positionen för den här kontrollen i en kontrollgrupp. Den avgör i vilken ordning kontroller körs när en grupp utlöses från API:et eller från CI/CD.
Körnings-ID	runtimeId		string	Körningsversionen, d.v.s. en fast uppsättning körningsberoenden, som används för att köra den här kontrollen.
Aviseringskanal-ID	alertChannelId	True	number	Aviseringskanalidentifieraren.
Aktiverat	activated	True	boolean	Om aktiverad.
Key	key	True	string	Nyckeln för miljövariabeln (det här värdet kan inte ändras).
Värde	value	True	string	Värdet för miljövariabeln.
Låst	locked		boolean	Används endast i användargränssnittet för att dölja värdet som ett lösenord.
Frekvens	frequency		integer	Hur ofta kontrollen ska köras på några minuter.
Script	script		string	En giltig del av Node.js javascript-kod som beskriver en webbläsarinteraktion med Puppeteer- eller Playwright-ramverken.
Privata platser	privateLocations		array of string	En matris med en eller flera privata platser där kontrollen ska köras.

Returer

Body

CheckBrowser

Uppdatera ett kodfragment

Åtgärds-ID:

PutV1SnippetsId

Uppdaterar ett kodfragment.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	integer	Identifieraren.
Namn	name	True	string	Kodfragmentets namn.
Script	script	True	string	Din Node.js kod som interagerar med API-kontrolllivscykeln eller fungerar som en del för webbläsarkontroller.

Returer

Body

Snippet

Uppdatera ett underhållsperiod

Åtgärds-ID:

PutV1MaintenancewindowsId

Uppdaterar ett underhållsperiod.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	integer	Identifieraren.
Namn	name	True	string	Namnet på underhållsfönstret.
Lista över underhållsfönstertaggar	tags		array of string	Namnen på underhållsfönstret för kontroller och grupper bör gälla för.
Startar vid	startsAt	True	date	Startdatumet för underhållsfönstret.
Slutar vid	endsAt	True	date	Slutdatum för underhållsperioden.
Upprepa intervall	repeatInterval		number	Underhållsfönstrets upprepningsintervall från den första förekomsten.
Upprepa enhet	repeatUnit	True	string	Upprepningsstrategin för underhållsfönstret.
Upprepa slutar vid	repeatEndsAt		date	Slutdatumet då underhållsperioden ska sluta upprepas.

Returer

Body

MaintenanceWindow

Uppdatera prenumerationerna för en aviseringskanal

Åtgärds-ID:

PutV1AlertchannelsIdSubscriptions

Uppdatera prenumerationerna för en aviseringskanal. Använd det här alternativet om du vill lägga till en kontroll i en aviseringskanal så att fel- och återställningsaviseringar skickas ut för den kontrollen. Obs! När du skickar prenumerationsobjektet kan du bara ange ett checkId eller ett groupId, inte båda.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	integer	Identifieraren.
Kontrollera ID	checkId		guid	Du kan antingen skicka ett checkId eller ett groupId, men inte båda.
grupp-id	groupId		number	Du kan antingen skicka ett checkId eller ett groupId, men inte båda.
Aktiverat	activated	True	boolean	Om aktiverad.

Returer

Body

AlertChanelSubscription

Visa en lista över alla aviseringar för ditt konto

Åtgärds-ID:

GetV1Checkalerts

Visar en lista över alla aviseringar för ditt konto.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Limit	limit		integer	Begränsa antalet resultat.
Nummer	page		number	Sidnumret.
Från	from		date	Välj dokument från den här UNIX-tidsstämpeln (>= datum). Standardvärdet är nu – 6 timmar.
Till	to		date	Välj aviseringar fram till den här UNIX-tidsstämpeln (< datum). Standardvärdet är 6 timmar efter från.

Returer

Föremål

CheckAlertList

Visa en lista över alla aviseringskanaler

Åtgärds-ID:

GetV1Alertchannels

Visar en lista över alla konfigurerade aviseringskanaler och deras prenumerationskontroller.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Limit	limit		integer	Begränsa antalet resultat.
Nummer	page		number	Sidnumret.

Returer

Föremål

AlertChannelList

Visa en lista över alla instrumentpaneler

Åtgärds-ID:

GetV1Dashboards

Visar en lista över alla aktuella instrumentpaneler i ditt konto.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Limit	limit		integer	Begränsa antalet resultat.
Nummer	page		number	Sidnumret.

Returer

Föremål

DashboardsList

Visa en lista över alla kodfragment

Åtgärds-ID:

GetV1Snippets

Visar en lista över alla aktuella kodfragment i ditt konto.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Limit	limit		integer	Begränsa antalet resultat.
Nummer	page		number	Sidnumret.

Returer

Föremål

SnippetList

Visa en lista över alla kontroller

Åtgärds-ID:

GetV1Checks

Visar en lista över alla aktuella kontroller i ditt konto.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Limit	limit		integer	Begränsa antalet resultat.
Nummer	page		number	Sidnumret.
API-kontroll-URL-filter	apiCheckUrlFilterPattern		string	Filtrerar resultatet efter en sträng som finns i URL:en för en API-kontroll, till exempel en domän som www.myapp.com. Returnerar endast API-kontroller.

Returer

Föremål

CheckList

Visa en lista över alla kontrollgrupper

Åtgärds-ID:

GetV1Checkgroups

Visar en lista över alla aktuella kontrollgrupper i ditt konto. Egenskapen checks är en matris med kontroll av UUID:er för praktiska hänvisningar. Den är skrivskyddad och du kan inte använda den för att lägga till kontroller i en grupp.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Limit	limit		integer	Begränsa antalet resultat.
Nummer	page		number	Sidnumret.

Returer

Föremål

CheckGroupList

Visa en lista över alla kontrollstatusar

Åtgärds-ID:

GetV1Checkstatuses

Visar aktuell statusinformation för alla kontroller i ditt konto. Kontrollstatusposterna uppdateras kontinuerligt när nya kontrollresultat kommer in.

Returer

Föremål

CheckStatusList

Visa en lista över alla miljövariabler

Åtgärds-ID:

GetV1Variables

Visar en lista över alla aktuella miljövariabler i ditt konto.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Limit	limit		integer	Begränsa antalet resultat.
Nummer	page		number	Sidnumret.

Returer

Föremål

EnvironmentVariableList

Visa en lista över alla privata platser

Åtgärds-ID:

GetV1Privatelocations

Visar en lista över alla privata platser i ditt konto.

Returer

Föremål

privateLocationsListSchema

Visa en lista över alla underhållsfönster

Åtgärds-ID:

GetV1Maintenancewindows

Visar en lista över alla underhållsperioder i ditt konto.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Limit	limit		integer	Begränsa antalet resultat.
Nummer	page		number	Sidnumret.

Returer

Listan över underhållsperioder.

Föremål

MaintenanceWindowList

Visar en lista över alla kontrollresultat

Åtgärds-ID:

GetV1CheckresultsCheckid

Visar en lista över fullständiga, råa kontrollresultat för en specifik kontroll. Vi behåller råresultat i 30 dagar. Efter 30 dagar raderas de. Men vi behåller de samlade resultaten på obestämd tid. Du kan filtrera efter kontrolltyp och resultattyp för att begränsa listan. Använd parametrarna to och from för att ange ett datumintervall (UNIX-tidsstämpel i sekunder). Beroende på kontrolltypen kan vissa fält vara null. Den här slutpunkten returnerar data inom en tidsram på sex timmar. Om från och till params anges måste de ha högst sex timmars mellanrum. Om ingen har angetts kommer vi att överväga att param vara nu och från param till sex timmar tidigare. Om bara till param har angetts kommer vi att ställa in från till sex timmar tidigare. Tvärtom, om bara från param är inställd kommer vi att överväga att param vara sex timmar senare. Hastighetsbegränsning tillämpas på den här slutpunkten, du kan skicka högst 5 begäranden/10 sekunder.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Kontrollera ID	checkId	True	string	Kontrollidentifieraren.
Limit	limit		integer	Begränsa antalet resultat.
Nummer	page		number	Sidnumret.
Från	from		date	Välj dokument från den här UNIX-tidsstämpeln (>= datum). Standardvärdet är nu – 6 timmar.
Till	to		date	Välj aviseringar fram till den här UNIX-tidsstämpeln (< datum). Standardvärdet är 6 timmar efter från.
Plats	location		string	Ange en datacenterplats, t.ex. eu-west-1 för att filtrera efter plats
Kontrollera typ	checkType		string	Typ av kontroll.
Har fel	hasFailures		boolean	Kontrollresultatet har ett eller flera fel.

Returer

Föremål

CheckResultList

Visar en lista över alla körningar som stöds

Åtgärds-ID:

GetV1Runtimes

Visar en lista över alla körningskörningar som stöds och de inkluderade NPM-paketen för webbläsarkontroller och installations- och nedrivningsskript för API-kontroller.

Returer

Föremål

RuntimeList

Visar en lista över alla platser som stöds

Åtgärds-ID:

GetV1Locations

Visar en lista över alla platser som stöds.

Returer

Föremål

LocationList

Visar information för en specifik körning

Åtgärds-ID:

GetV1RuntimesId

Visar information om alla inkluderade NPM-paket och deras version för en specifik körning.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
ID-nummer	id	True	string	Identifieraren.

Returer

Body

Runtime

Definitioner

AlertChannelConfig

Konfigurationen av aviseringskanalen.

Name	Sökväg	Typ	Description
Konfiguration av aviseringskanal		object	Konfigurationen av aviseringskanalen.

AlertChanelSubscription

Name	Sökväg	Typ	Description
ID-nummer	id	number	Identifieraren.
Kontrollera ID	checkId	guid	Kontrollidentifieraren.
grupp-id	groupId	number	Gruppidentifieraren.
Aktiverat	activated	boolean	Om aktiverad.

AlertChanelSubscriptionList

Alla kontroller prenumererar på den här kanalen.

Name	Sökväg	Typ	Description
Föremål		AlertChanelSubscription

AlertChannel

Name	Sökväg	Typ	Description
ID-nummer	id	number	Identifieraren.
Typ	type	string	Typ av aviseringskanal, d.v.s. E-post eller SLACK.
Konfiguration av aviseringskanal	config	AlertChannelConfig	Konfigurationen av aviseringskanalen.
Prenumerationslista för aviseringskanal	subscriptions	AlertChanelSubscriptionList	Alla kontroller prenumererar på den här kanalen.
Skicka återställning	sendRecovery	boolean	Om skicka återställning.
Sändningsfel	sendFailure	boolean	Om sändningsfel.
Skicka degraderad	sendDegraded	boolean	Om sändningen har degraderats.
SSL-förfallodatum	sslExpiry	boolean	Avgör om en avisering ska skickas för utgångna SSL-certifikat.
Tröskelvärde för SSL-förfallodatum	sslExpiryThreshold	integer	Vid vilken tidpunkt du ska börja avisera på SSL-certifikat.
Skapad vid	created_at	date-time	När den skapas på.
Uppdaterad kl	updated_at	date-time	När den uppdateras på.

AlertChannelList

Name	Sökväg	Typ	Description
Föremål		AlertChannel

CheckAlert

Name	Sökväg	Typ	Description
ID-nummer	id	string	Den unika identifieraren för den här aviseringen.
Namn	name	string	Namnet på kontrollen.
Kontrollera ID	checkId	string	Identifieraren för kontrollen som den här aviseringen tillhör.
Aviseringstyp	alertType	string	Typ av avisering.
Kontrollera typ	checkType	string	Typ av kontroll.
Körningsplats	runLocation	string	Vilken datacenterplats den här kontrollaviseringen utlöstes från.
Svarstid	responseTime	number	Beskriver den tid det tog att köra relevanta delar av den här kontrollen. All tid för installation av timersystem som krävs för att börja köra den här kontrollen i backend checkly ingår inte i detta.
Error	error	string	Eventuella specifika felmeddelanden som var en del av den misslyckade kontrollen som utlöste aviseringen.
Statuskod	statusCode	string	Statuskoden för svaret. Gäller endast FÖR API-kontroller.
Skapad vid	created_at	date	Datum och tid då den här kontrollaviseringen skapades.
Startade på	startedAt	date	Datum och tid då den här kontrollaviseringen startades.

CheckAlertList

Name	Sökväg	Typ	Description
Föremål		CheckAlert

CheckGroupTagList

Taggar för att organisera och filtrera kontroller.

Name	Sökväg	Typ	Description
Föremål		string

CheckGroupLocationList

En matris med en eller flera datacenterplatser där kontrollerna ska köras.

Name	Sökväg	Typ	Description
Föremål		string

KeyValue

Name	Sökväg	Typ	Description
Key	key	string	Nyckeln.
Värde	value	string	Värdet.
Låst	locked	boolean	Om låst.

Rubriklista

Name	Sökväg	Typ	Description
Föremål		KeyValue

QueryParameterList

Name	Sökväg	Typ	Description
Föremål		KeyValue

Påstående

Name	Sökväg	Typ	Description
Källa	source	string	Källan.
Fastighet	property	string	Egenskapen.
Jämförelse	comparison	string	Jämförelsen.
Target	target	string	Målet.

AssertionList

Kontrollera den huvudsakliga dokumentationen om kontroller för specifika värden som reguljära uttryck och JSON-sökvägsbeskrivningar som du kan använda i egenskapsfältet.

Name	Sökväg	Typ	Description
Föremål		Assertion

BasicAuth

Name	Sökväg	Typ	Description
Användarnamn	username	string	Användarnamnet.
Lösenord	password	string	Lösenordet.

CheckGroupAPICheckDefaults

Name	Sökväg	Typ	Description
URL	url	string	Bas-URL:en för den här gruppen som du kan referera till med variabeln {{GROUP_BASE_URL}} i alla gruppkontroller.
headers	headers	HeaderList
queryParameters (på engelska)	queryParameters	QueryParameterList
Kontrolllista	assertions	AssertionList	Kontrollera den huvudsakliga dokumentationen om kontroller för specifika värden som reguljära uttryck och JSON-sökvägsbeskrivningar som du kan använda i egenskapsfältet.
basicAuth	basicAuth	BasicAuth

CheckGroupBrowserCheckDefaults

Standardinställningarna för kontrollgruppens webbläsare.

Name	Sökväg	Typ	Description
Kontrollera standardvärden för gruppwebbläsare		object	Standardinställningarna för kontrollgruppens webbläsare.

EnvironmentVariable

Name	Sökväg	Typ	Description
Key	key	string	Nyckeln för miljövariabeln (det här värdet kan inte ändras).
Värde	value	string	Värdet för miljövariabeln.
Låst	locked	boolean	Används endast i användargränssnittet för att dölja värdet som ett lösenord.

EnvironmentVariableList

Name	Sökväg	Typ	Description
Föremål		EnvironmentVariable

AlertSettingsRunBasedEscalation

Name	Sökväg	Typ	Description
Tröskelvärde för misslyckad körning	failedRunThreshold	number	Efter hur många misslyckade på varandra följande kontroller som kör ett aviseringsmeddelande ska skickas.

AlertSettingsTimeBasedEscalation

Name	Sökväg	Typ	Description
Tröskelvärde för minuter som misslyckas	minutesFailingThreshold	number	Efter hur många minuter efter att en kontroll har börjat misslyckas ska en avisering skickas.

AlertSettingsReminders

Name	Sökväg	Typ	Description
Mängd	amount	number	Hur många påminnelser som ska skickas efter det första aviseringsmeddelandet.
Intervall	interval	number	Vid vilket intervall påminnelserna ska skickas.

AlertSettingsSSLCertificates

[INAKTUELL] sslCertificates är inaktuell och används inte längre. Ignorera det, tas bort i en framtida version.

Name	Sökväg	Typ	Description
Enabled	enabled	boolean	Avgör om aviseringsmeddelanden ska skickas för utgångna SSL-certifikat.
Tröskelvärde för avisering	alertThreshold	integer	Vid vilken tidpunkt du ska börja avisera på SSL-certifikat.

CheckGroupAlertSettings

Aviseringsinställningar.

Name	Sökväg	Typ	Description
Eskaleringstyp	escalationType	string	Avgör vilken typ av eskalering som ska användas.
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
Påminnelser	reminders	AlertSettingsReminders
SSL-certifikat för aviseringsinställningar	sslCertificates	AlertSettingsSSLCertificates	[INAKTUELL] sslCertificates är inaktuell och används inte längre. Ignorera det, tas bort i en framtida version.

Modell1

Prenumeration på aviseringskanal.

Name	Sökväg	Typ	Description
Aviseringskanal-ID	alertChannelId	number	Aviseringskanalidentifieraren.
Aktiverat	activated	boolean	Om aktiverad.

AlertChannelSubscriptionCreateList

Lista över prenumerationer på aviseringskanaler.

Name	Sökväg	Typ	Description
Prenumeration på aviseringskanal		Model1	Prenumeration på aviseringskanal.

privateLocations

En matris med en eller flera privata platser där kontrollen ska köras.

Name	Sökväg	Typ	Description
Föremål		string

CheckGroup

Name	Sökväg	Typ	Description
ID-nummer	id	number	Identifieraren.
Namn	name	string	Namnet på kontrollgruppen.
Aktiverat	activated	boolean	Avgör om kontrollerna i gruppen körs eller inte.
Dämpad	muted	boolean	Avgör om några meddelanden skickas ut när en incheckning i den här gruppen misslyckas och/eller återställs.
Kontrollera grupptagglista	tags	CheckGroupTagList	Taggar för att organisera och filtrera kontroller.
Kontrollera gruppplatslista	locations	CheckGroupLocationList	En matris med en eller flera datacenterplatser där kontrollerna ska köras.
Konkurens	concurrency	number	Avgör hur många kontroller som anropas samtidigt när du utlöser en kontrollgrupp från CI/CD eller via API:et.
apiCheckDefaults	apiCheckDefaults	CheckGroupAPICheckDefaults
Kontrollera standardvärden för gruppwebbläsare	browserCheckDefaults	CheckGroupBrowserCheckDefaults	Standardinställningarna för kontrollgruppens webbläsare.
environmentVariables	environmentVariables	EnvironmentVariableList
Dubbelkoll	doubleCheck	boolean	Om du anger sant utlöses ett nytt försök när en kontroll misslyckas från den misslyckade regionen och en annan, slumpmässigt vald region innan kontrollen markeras som misslyckad.
Använda globala aviseringsinställningar	useGlobalAlertSettings	boolean	När det är sant används inställningen för avisering på kontonivå, inte aviseringsinställningen som definierats i den här kontrollgruppen.
Kontrollera inställningar för gruppaviseringar	alertSettings	CheckGroupAlertSettings	Aviseringsinställningar.
Skapa lista över prenumerationer för aviseringskanal	alertChannelSubscriptions	AlertChannelSubscriptionCreateList	Lista över prenumerationer på aviseringskanaler.
Konfigurera kodfragment-ID	setupSnippetId	number	En identifierarreferens till ett kodfragment som ska användas i installationsfasen för en API-kontroll i den här gruppen.
Ta bort kodfragment-ID	tearDownSnippetId	number	En identifierarreferens till ett kodfragment som ska användas i fasen för nedtagning av en API-kontroll i den här gruppen.
Skript för lokal installation	localSetupScript	string	En giltig Node.js kod som ska köras i installationsfasen för en API-kontroll i den här gruppen.
Lokalt nedslitet skript	localTearDownScript	string	En giltig del av Node.js kod som ska köras i fasen för nedtagning av en API-kontroll i den här gruppen.
Körnings-ID	runtimeId	string	Körningsversionen, d.v.s. en fast uppsättning körningsberoenden, som används för att köra kontroller i den här gruppen.
Privata platser	privateLocations	privateLocations	En matris med en eller flera privata platser där kontrollen ska köras.
Skapad vid	created_at	date	När den skapas på.
Uppdaterad kl	updated_at	date-time	När den uppdateras på.

CheckGroupList

Name	Sökväg	Typ	Description
Föremål		CheckGroup

CheckLocationList

En matris med en eller flera datacenterplatser där den här kontrollen ska köras.

Name	Sökväg	Typ	Description
Föremål		string

CheckTagList

Taggar för att organisera och filtrera kontroller.

Name	Sökväg	Typ	Description
Föremål		string

CheckAlertSettings

Aviseringsinställningar.

Name	Sökväg	Typ	Description
Eskaleringstyp	escalationType	string	Avgör vilken typ av eskalering som ska användas.
runBasedEscalation	runBasedEscalation	AlertSettingsRunBasedEscalation
timeBasedEscalation	timeBasedEscalation	AlertSettingsTimeBasedEscalation
Påminnelser	reminders	AlertSettingsReminders
SSL-certifikat för aviseringsinställningar	sslCertificates	AlertSettingsSSLCertificates	[INAKTUELL] sslCertificates är inaktuell och används inte längre. Ignorera det, tas bort i en framtida version.

CheckAlertChannelSubscription

Name	Sökväg	Typ	Description
Aviseringskanal-ID	alertChannelId	number	Aviseringskanalidentifieraren.
Aktiverat	activated	boolean	Om aktiverad.

CheckAlertChannelSubscriptionList

Name	Sökväg	Typ	Description
Föremål		CheckAlertChannelSubscription

CheckRequest

Kontrollbegäran.

Name	Sökväg	Typ	Description
Kontrollera begäran		object	Kontrollbegäran.

CheckEnvironmentVariableList

Nyckel/värde-par för att ange miljövariabler under kontrollkörningen. Dessa är endast relevanta för webbläsarkontroller. Använd globala miljövariabler när det är möjligt.

Name	Sökväg	Typ	Description
Föremål		EnvironmentVariable

CheckAlertEmail

Name	Sökväg	Typ	Description
Address	address	string	Adressen.

CheckAlertEmailList

Name	Sökväg	Typ	Description
Föremål		CheckAlertEmail

Modell4

Name	Sökväg	Typ	Description
Föremål		KeyValue

Modell 5

Name	Sökväg	Typ	Description
Föremål		KeyValue

CheckAlertWebhook

Name	Sökväg	Typ	Description
Namn	name	string	Namnet.
URL	url	string	URL-adressen.
Metod	method	string	Metoden.
headers	headers	Model4
queryParameters (på engelska)	queryParameters	Model5

CheckAlertWebhookList

Name	Sökväg	Typ	Description
Föremål		CheckAlertWebhook

CheckAlertSlack

Name	Sökväg	Typ	Description
URL	url	string	URL-adressen.

CheckAlertSlackList

Name	Sökväg	Typ	Description
Föremål		CheckAlertSlack

CheckAlertSMS

Name	Sökväg	Typ	Description
Nummer	number	string	Talet.
Namn	name	string	Namnet.

CheckAlertSMSList

Name	Sökväg	Typ	Description
Föremål		CheckAlertSMS

CheckAlertChannels

Name	Sökväg	Typ	Description
Mejladress	email	CheckAlertEmailList
webhook-funktion	webhook	CheckAlertWebhookList
slak	slack	CheckAlertSlackList
sms	sms	CheckAlertSMSList

CheckGroupCheck

Name	Sökväg	Typ	Description
ID-nummer	id	string	Identifieraren.
Namn	name	string	Namnet på kontrollen.
Aktiverat	activated	boolean	Avgör om kontrollen körs eller inte.
Dämpad	muted	boolean	Avgör om några meddelanden skickas ut när en kontroll misslyckas och/eller återställs.
Dubbelkoll	doubleCheck	boolean	Om du anger sant utlöses ett nytt försök när en kontroll misslyckas från den misslyckade regionen och en annan, slumpmässigt vald region innan kontrollen markeras som misslyckad.
Bör misslyckas	shouldFail	boolean	Gör det möjligt att invertera beteendet för när en kontroll anses misslyckas. Tillåter validering av felstatus som 404.
Kontrollera platslista	locations	CheckLocationList	En matris med en eller flera datacenterplatser där den här kontrollen ska köras.
Kontrollera tagglista	tags	CheckTagList	Taggar för att organisera och filtrera kontroller.
Kontrollera aviseringsinställningar	alertSettings	CheckAlertSettings	Aviseringsinställningar.
Använda globala aviseringsinställningar	useGlobalAlertSettings	boolean	När det är sant används inställningen för avisering på kontonivå, inte den aviseringsinställning som definierats vid den här kontrollen.
grupp-id	groupId	number	Identifieraren för den kontrollgrupp som den här kontrollen ingår i.
Gruppordning	groupOrder	number	Positionen för den här kontrollen i en kontrollgrupp. Den avgör i vilken ordning kontroller körs när en grupp utlöses från API:et eller från CI/CD.
Körnings-ID	runtimeId	string	Körningsversionen, d.v.s. en fast uppsättning körningsberoenden, som används för att köra den här kontrollen.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Kontrollera typ	checkType	string	Typ av kontroll.
Frekvens	frequency	integer	Hur ofta kontrollen ska köras på några minuter.
Frekvensförskjutning	frequencyOffset	integer	Frekvensförskjutningen.
Kontrollera begäran	request	CheckRequest	Kontrollbegäran.
Script	script	string	Skriptet.
Kontrollera miljövariabellistan	environmentVariables	CheckEnvironmentVariableList	Nyckel/värde-par för att ange miljövariabler under kontrollkörningen. Dessa är endast relevanta för webbläsarkontroller. Använd globala miljövariabler när det är möjligt.
Konfigurera kodfragment-ID	setupSnippetId	number	En identifierarreferens till ett kodfragment som ska användas i konfigurationsfasen för en API-kontroll.
Ta bort kodfragment-ID	tearDownSnippetId	number	En identifierarreferens till ett kodfragment som ska användas i fasen teardown i en API-kontroll.
Skript för lokal installation	localSetupScript	string	En giltig Node.js kod som ska köras i installationsfasen.
Lokalt nedslitet skript	localTearDownScript	string	En giltig del av Node.js kod som ska köras i fasen för nedtagning.
Degraderad svarstid	degradedResponseTime	number	Svarstiden i millisekunder där en kontroll ska betraktas som degraderad.
Maximal svarstid	maxResponseTime	number	Svarstiden i millisekunder där en kontroll bör betraktas som misslyckad.
alertChannels	alertChannels	CheckAlertChannels
Privata platser	privateLocations	privateLocations	En matris med en eller flera privata platser där kontrollen ska köras.
Skapad vid	created_at	date	När den skapas på.
Uppdaterad kl	updated_at	date-time	När den uppdateras på.

Modell 8

Name	Sökväg	Typ	Description
Föremål		CheckGroupCheck

Påståenden

Lista över API-kontrollkontroller.

Name	Sökväg	Typ	Description
Föremål		string

headers

Rubrikerna.

Name	Sökväg	Typ	Description
Headers		object	Rubrikerna.

params

Parametrarna.

Name	Sökväg	Typ	Description
Params		object	Parametrarna.

request

Begäran för API:et.

Name	Sökväg	Typ	Description
method	method	string
URL	url	string
data	data	string
Headers	headers	headers	Rubrikerna.
Params	params	params	Parametrarna.

Timings

Tidsinställningar.

Name	Sökväg	Typ	Description
Timings		object	Tidsinställningar.

timingPhases

Tidsfaserna.

Name	Sökväg	Typ	Description
Tidsfaser		object	Tidsfaserna.

response

API-svaret.

Name	Sökväg	Typ	Description
Läge	status	number	Status.
Statustext	statusText	string	Statustexten.
Body	body	string	Kroppen.
Headers	headers	headers	Rubrikerna.
Timings	timings	timings	Tidsinställningar.
Tidsfaser	timingPhases	timingPhases	Tidsfaserna.

jobLog

Jobbloggen.

Name	Sökväg	Typ	Description
Jobblogg		object	Jobbloggen.

jobAssets

Tillgångar som genererats från kontrollkörningen.

Name	Sökväg	Typ	Description
Föremål		string

CheckResultAPI

Svarsdata för en API-kontroll.

Name	Sökväg	Typ	Description
Assertions	assertions	assertions	Lista över API-kontrollkontroller.
Begäran	request	request	Begäran för API:et.
Svar	response	response	API-svaret.
Fel vid begäran	requestError	string	Beskriver om ett fel uppstod i begäran.
Jobblogg	jobLog	jobLog	Jobbloggen.
Jobbtillgångar	jobAssets	jobAssets	Tillgångar som genererats från kontrollkörningen.

Felaktigheter

Lista över fel vid kontrollkörningen.

Name	Sökväg	Typ	Description
Föremål		string

Modell9

Kontrollera resultatet av körningsloggen.

Name	Sökväg	Typ	Description
Föremål		string

traceSummary

Spårningssammanfattningen.

Name	Sökväg	Typ	Description
Spårningssammanfattning		object	Spårningssammanfattningen.

Sidor

Lista över sidor som används vid kontrollkörningen.

Name	Sökväg	Typ	Description
Föremål		string

CheckResultBrowser

Svarsdata för en webbläsarkontroll.

Name	Sökväg	Typ	Description
Typ	type	string	Den typ av ramverk som kontrollen använder.
Errors	errors	errors	Lista över fel vid kontrollkörningen.
Avslutningstid	endTime	number	Sluttid för kontrollkörningen.
Starttid	startTime	number	Starttid för kontrollkörningen.
Körningsversion	runtimeVersion	string	Aktiv körningsversion.
Kontrollera körningsloggen	jobLog	Model9	Kontrollera resultatet av körningsloggen.
Jobbtillgångar	jobAssets	jobAssets	Tillgångar som genererats från kontrollkörningen.
Spårningssammanfattning	traceSummary	traceSummary	Spårningssammanfattningen.
Sidor	pages	pages	Lista över sidor som används vid kontrollkörningen.

CheckResult

Name	Sökväg	Typ	Description
ID-nummer	id	string	Den unika identifieraren för det här resultatet.
Namn	name	string	Namnet på kontrollen.
Kontrollera ID	checkId	string	Identifieraren för kontrollen.
Har fel	hasFailures	boolean	Beskriver om ett fel har inträffat under den här kontrollkörningen. Detta bör vara ditt huvudfokus för att utvärdera BETEENDE för API- eller webbläsarkontroll. Påståenden som misslyckas, tidsgränser eller misslyckade skript matchar alla för att det här värdet ska vara sant.
Har fel	hasErrors	boolean	Beskriver om ett internt fel har inträffat i Checklys serverdel. Detta bör vara falskt i nästan alla fall.
Är degraderad	isDegraded	boolean	En kontroll försämras om den överskrider den nedbrytningsgräns som angetts av fältet degraderadResponseTime vid kontrollen. Gäller endast för API-kontroller.
Över maximal svarstid	overMaxResponseTime	boolean	Ställ in på true om svarstiden överskrider den gräns som anges av fältet maxResponseTime vid kontrollen. Gäller endast för API-kontroller.
Körningsplats	runLocation	string	Vilken datacenterplats det här kontrollresultatet kommer från.
Startade på	startedAt	date-time	Den startades då.
Stoppad vid	stoppedAt	date-time	Den stoppades vid tidpunkten.
Skapad vid	created_at	date-time	När den skapas på.
Svarstid	responseTime	number	Beskriver den tid det tog att köra relevanta delar av den här kontrollen. All tid för installation av timersystem som krävs för att börja köra den här kontrollen i backend checkly ingår inte i detta.
Kontrollera resultat-API	apiCheckResult	CheckResultAPI	Svarsdata för en API-kontroll.
Resultat för webbläsarkontroll	browserCheckResult	CheckResultBrowser	Svarsdata för en webbläsarkontroll.
Kontrollera körnings-ID	checkRunId	number	Identifieraren för den specifika kontrollkörning som skapade det här kontrollresultatet.
Försök	attempts	number	Hur ofta den här kontrollen gjordes på nytt. Detta är större än 0 när dubbelkontroll är aktiverat.

CheckResultList

Name	Sökväg	Typ	Description
Föremål		CheckResult

CheckStatus

Name	Sökväg	Typ	Description
Namn	name	string	Namnet på kontrollen.
Kontrollera ID	checkId	string	Identifieraren för kontrollen som den här statusen tillhör.
Har fel	hasFailures	boolean	Beskriver om den här kontrollen misslyckas för närvarande. Om något av försäkran för en API-kontroll misslyckas är det här värdet sant. Om en webbläsarkontroll misslyckas av någon anledning är detta sant.
Har fel	hasErrors	boolean	Beskriver om det inte går att utföra den här kontrollen på grund av ett fel utanför den normala åtgärden. Detta bör vara mycket sällsynt och endast när det finns ett fel i backend checkly.
Är degraderad	isDegraded	boolean	En kontroll försämras om den överskrider den nedbrytningsgräns som angetts av fältet degraderadResponseTime vid kontrollen. Gäller endast för API-kontroller.
Längsta körning	longestRun	number	Den längsta svarstiden någonsin för den här kontrollen.
Kortast körning	shortestRun	number	Den kortaste svarstiden någonsin för den här kontrollen.
Plats för senaste körning	lastRunLocation	string	Vilken plats kontrollen senast kördes på.
Körnings-ID för senaste kontroll	lastCheckRunId	string	Den unika inkrementella identifieraren för varje kontrollkörning.
Återstående SSL-dagar	sslDaysRemaining	number	Hur många dagar återstår tills det aktuella SSL-certifikatet upphör att gälla.
Skapad vid	created_at	date	När den skapas på.
Uppdaterad kl	updated_at	date-time	När den uppdateras på.

CheckStatusList

Name	Sökväg	Typ	Description
Föremål		CheckStatus

Check

Name	Sökväg	Typ	Description
ID-nummer	id	string	Identifieraren.
Namn	name	string	Namnet på kontrollen.
Aktiverat	activated	boolean	Avgör om kontrollen körs eller inte.
Dämpad	muted	boolean	Avgör om några meddelanden skickas ut när en kontroll misslyckas och/eller återställs.
Dubbelkoll	doubleCheck	boolean	Om du anger sant utlöses ett nytt försök när en kontroll misslyckas från den misslyckade regionen och en annan, slumpmässigt vald region innan kontrollen markeras som misslyckad.
Bör misslyckas	shouldFail	boolean	Gör det möjligt att invertera beteendet för när en kontroll anses misslyckas. Tillåter validering av felstatus som 404.
Kontrollera platslista	locations	CheckLocationList	En matris med en eller flera datacenterplatser där den här kontrollen ska köras.
Kontrollera tagglista	tags	CheckTagList	Taggar för att organisera och filtrera kontroller.
Kontrollera aviseringsinställningar	alertSettings	CheckAlertSettings	Aviseringsinställningar.
Använda globala aviseringsinställningar	useGlobalAlertSettings	boolean	När det är sant används inställningen för avisering på kontonivå, inte den aviseringsinställning som definierats vid den här kontrollen.
grupp-id	groupId	number	Identifieraren för den kontrollgrupp som den här kontrollen ingår i.
Gruppordning	groupOrder	number	Positionen för den här kontrollen i en kontrollgrupp. Den avgör i vilken ordning kontroller körs när en grupp utlöses från API:et eller från CI/CD.
Körnings-ID	runtimeId	string	Körningsversionen, d.v.s. en fast uppsättning körningsberoenden, som används för att köra den här kontrollen.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Kontrollera typ	checkType	string	Typ av kontroll.
Frekvens	frequency	integer	Hur ofta kontrollen ska köras på några minuter.
Frekvensförskjutning	frequencyOffset	integer	Frekvensförskjutningen.
Kontrollera begäran	request	CheckRequest	Kontrollbegäran.
Script	script	string	Skriptet.
Kontrollera miljövariabellistan	environmentVariables	CheckEnvironmentVariableList	Nyckel/värde-par för att ange miljövariabler under kontrollkörningen. Dessa är endast relevanta för webbläsarkontroller. Använd globala miljövariabler när det är möjligt.
Konfigurera kodfragment-ID	setupSnippetId	number	En identifierarreferens till ett kodfragment som ska användas i konfigurationsfasen för en API-kontroll.
Ta bort kodfragment-ID	tearDownSnippetId	number	En identifierarreferens till ett kodfragment som ska användas i fasen teardown i en API-kontroll.
Skript för lokal installation	localSetupScript	string	En giltig Node.js kod som ska köras i installationsfasen.
Lokalt nedslitet skript	localTearDownScript	string	En giltig del av Node.js kod som ska köras i fasen för nedtagning.
Degraderad svarstid	degradedResponseTime	number	Svarstiden i millisekunder där en kontroll ska betraktas som degraderad.
Maximal svarstid	maxResponseTime	number	Svarstiden i millisekunder där en kontroll bör betraktas som misslyckad.
alertChannels	alertChannels	CheckAlertChannels
Privata platser	privateLocations	privateLocations	En matris med en eller flera privata platser där kontrollen ska köras.
Skapad vid	created_at	date	När den skapas på.
Uppdaterad kl	updated_at	date-time	När den uppdateras på.

Checklista

Name	Sökväg	Typ	Description
Föremål		Check

Modell 14

Name	Sökväg	Typ	Description
Föremål		KeyValue

Modell 15

Name	Sökväg	Typ	Description
Föremål		KeyValue

Modell 16

Avgör begäran om att kontrollen ska köras.

Name	Sökväg	Typ	Description
method	method	string
URL	url	string	URL-adressen.
Följ omdirigeringar	followRedirects	boolean	Om du vill följa omdirigeringar.
Hoppa över SSL	skipSSL	boolean	Om du vill hoppa över SSL.
Body	body	string	Kroppen.
Kroppstyp	bodyType	string	Brödtexttypen.
headers	headers	Model14
queryParameters (på engelska)	queryParameters	Model15
Kontrolllista	assertions	AssertionList	Kontrollera den huvudsakliga dokumentationen om kontroller för specifika värden som reguljära uttryck och JSON-sökvägsbeskrivningar som du kan använda i egenskapsfältet.
basicAuth	basicAuth	BasicAuth

CheckAPI

Name	Sökväg	Typ	Description
ID-nummer	id	string	Identifieraren.
Namn	name	string	Namnet på kontrollen.
Aktiverat	activated	boolean	Avgör om kontrollen körs eller inte.
Dämpad	muted	boolean	Avgör om några meddelanden skickas ut när en kontroll misslyckas och/eller återställs.
Dubbelkoll	doubleCheck	boolean	Om du anger sant utlöses ett nytt försök när en kontroll misslyckas från den misslyckade regionen och en annan, slumpmässigt vald region innan kontrollen markeras som misslyckad.
Bör misslyckas	shouldFail	boolean	Gör det möjligt att invertera beteendet för när en kontroll anses misslyckas. Tillåter validering av felstatus som 404.
Kontrollera platslista	locations	CheckLocationList	En matris med en eller flera datacenterplatser där den här kontrollen ska köras.
Kontrollera tagglista	tags	CheckTagList	Taggar för att organisera och filtrera kontroller.
Kontrollera aviseringsinställningar	alertSettings	CheckAlertSettings	Aviseringsinställningar.
Använda globala aviseringsinställningar	useGlobalAlertSettings	boolean	När det är sant används inställningen för avisering på kontonivå, inte den aviseringsinställning som definierats vid den här kontrollen.
grupp-id	groupId	number	Identifieraren för den kontrollgrupp som den här kontrollen ingår i.
Gruppordning	groupOrder	number	Positionen för den här kontrollen i en kontrollgrupp. Den avgör i vilken ordning kontroller körs när en grupp utlöses från API:et eller från CI/CD.
Körnings-ID	runtimeId	string	Körningsversionen, d.v.s. en fast uppsättning körningsberoenden, som används för att köra den här kontrollen.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Kontrollera begäran	request	Model16	Avgör begäran om att kontrollen ska köras.
Frekvens	frequency	integer	Hur ofta kontrollen ska köras på några minuter.
Frekvensförskjutning	frequencyOffset	integer	Används för att ställa in sekunder för kontrollfrekvenser under 1 minut (endast för API-kontroller) och sprida kontroller över ett tidsintervall för frekvenser över 1 minut. Detta fungerar på följande sätt: Kontroller med en frekvens på 0 kan ha en frequencyOffset på 10, 20 eller 30, vilket innebär att de körs var 10:e, 20:e eller 30:e sekund. Kontroller med en frekvens som är lägre än och lika med 60 kan ha en frequencyOffset mellan 1 och ett maxvärde baserat på formeln Math.floor(frequency * 10), dvs. för en kontroll som körs var 5:e minut är maxfrekvensenOffset 50. Kontroller med en frekvens som är högre än 60 kan ha en frequencyOffset mellan 1 och ett maxvärde baserat på formeln Math.ceil(frequency /60), d.v.s. för en kontroll som körs var 720:e minut är maxfrekvensenOffset 12.
Ta bort kodfragment-ID	tearDownSnippetId	number	En identifierarreferens till ett kodfragment som ska användas i fasen teardown i en API-kontroll.
Konfigurera kodfragment-ID	setupSnippetId	number	En identifierarreferens till ett kodfragment som ska användas i konfigurationsfasen för en API-kontroll.
Skript för lokal installation	localSetupScript	string	En giltig Node.js kod som ska köras i installationsfasen.
Lokalt nedslitet skript	localTearDownScript	string	En giltig del av Node.js kod som ska köras i fasen för nedtagning.
Degraderad svarstid	degradedResponseTime	number	Svarstiden i millisekunder där en kontroll ska betraktas som degraderad.
Maximal svarstid	maxResponseTime	number	Svarstiden i millisekunder där en kontroll bör betraktas som misslyckad.
Privata platser	privateLocations	privateLocations	En matris med en eller flera privata platser där kontrollen ska köras.
Kontrollera typ	checkType	string	Kontrolltypen.
alertChannels	alertChannels	CheckAlertChannels
Skapad vid	created_at	date	När den skapas på.
Uppdaterad kl	updated_at	date-time	När den uppdateras på.

CheckBrowser

Name	Sökväg	Typ	Description
ID-nummer	id	string	Identifieraren.
Namn	name	string	Namnet på kontrollen.
Aktiverat	activated	boolean	Avgör om kontrollen körs eller inte.
Dämpad	muted	boolean	Avgör om några meddelanden skickas ut när en kontroll misslyckas och/eller återställs.
Dubbelkoll	doubleCheck	boolean	Om du anger sant utlöses ett nytt försök när en kontroll misslyckas från den misslyckade regionen och en annan, slumpmässigt vald region innan kontrollen markeras som misslyckad.
Bör misslyckas	shouldFail	boolean	Gör det möjligt att invertera beteendet för när en kontroll anses misslyckas. Tillåter validering av felstatus som 404.
Kontrollera platslista	locations	CheckLocationList	En matris med en eller flera datacenterplatser där den här kontrollen ska köras.
Kontrollera tagglista	tags	CheckTagList	Taggar för att organisera och filtrera kontroller.
Kontrollera aviseringsinställningar	alertSettings	CheckAlertSettings	Aviseringsinställningar.
Använda globala aviseringsinställningar	useGlobalAlertSettings	boolean	När det är sant används inställningen för avisering på kontonivå, inte den aviseringsinställning som definierats vid den här kontrollen.
grupp-id	groupId	number	Identifieraren för den kontrollgrupp som den här kontrollen ingår i.
Gruppordning	groupOrder	number	Positionen för den här kontrollen i en kontrollgrupp. Den avgör i vilken ordning kontroller körs när en grupp utlöses från API:et eller från CI/CD.
Körnings-ID	runtimeId	string	Körningsversionen, d.v.s. en fast uppsättning körningsberoenden, som används för att köra den här kontrollen.
alertChannelSubscriptions	alertChannelSubscriptions	CheckAlertChannelSubscriptionList
Kontrollera typ	checkType	string	Kontrolltypen.
Frekvens	frequency	integer	Hur ofta kontrollen ska köras på några minuter.
Script	script	string	En giltig del av Node.js javascript-kod som beskriver en webbläsarinteraktion med Puppeteer- eller Playwright-ramverken.
Privata platser	privateLocations	privateLocations	En matris med en eller flera privata platser där kontrollen ska köras.
alertChannels	alertChannels	CheckAlertChannels
Skapad vid	created_at	date	När den skapas på.
Uppdaterad kl	updated_at	date-time	När den uppdateras på.

DashboardTagList

En lista över en eller flera taggar som filtrerar vilka kontroller som ska visas på instrumentpanelen.

Name	Sökväg	Typ	Description
Föremål		string

Dashboard

Name	Sökväg	Typ	Description
Anpassad domän	customDomain	string	En anpassad användardomän, t.ex. status.example.com. Se dokumenten om hur du uppdaterar din DNS- och SSL-användning.
Anpassad URL	customUrl	string	Ett underdomännamn under checklyhq.com. Måste vara unikt för alla användare.
Logotyp	logo	string	En URL som pekar på en bildfil.
Webbikon	favicon	string	En URL som pekar på en bildfil som används som instrumentpanelsfavorit.
Länk	link	string	En URL-länk för omdirigering när instrumentpanelens logotyp klickas på.
Header	header	string	En text som visas överst på instrumentpanelen.
Description	description	string	En text som visas under rubriken eller rubriken på instrumentpanelen.
Width	width	string	Avgör om du vill använda helskärmsläge eller fokus i mitten.
Uppdateringsintervall	refreshRate	number	Hur ofta instrumentpanelen ska uppdateras på några sekunder.
Paginera	paginate	boolean	Avgör om sidnumreringen är på eller av.
Sidnumreringshastighet	paginationRate	number	Hur ofta sidnumrering ska utlösas i sekunder.
Kontroller per sida	checksPerPage	number	Antal kontroller som visas per sida.
Använda och operator	useTagsAndOperator	boolean	När du ska använda AND-operatorn för uppslag av taggar.
Dölj taggar	hideTags	boolean	Visa eller dölj taggarna på instrumentpanelen.
Lista över instrumentpanelstaggar	tags	DashboardTagList	En lista över en eller flera taggar som filtrerar vilka kontroller som ska visas på instrumentpanelen.
Instrumentpanels-ID	dashboardId	string	Instrumentpanelsidentifieraren.

InstrumentpanelerLista

Name	Sökväg	Typ	Description
Föremål		Dashboard

Plats

Name	Sökväg	Typ	Description
Region	region	string	Den unika identifieraren för den här platsen.
Namn	name	string	Eget namn på den här platsen.

Platslista

Name	Sökväg	Typ	Description
Föremål		Location

UnderhållWindowTagList

Namnen på underhållsfönstret för kontroller och grupper bör gälla för.

Name	Sökväg	Typ	Description
Föremål		string

UnderhållWindow

Name	Sökväg	Typ	Description
ID-nummer	id	number	Identifieraren för underhållsfönstret.
Namn	name	string	Namnet på underhållsfönstret.
Lista över underhållsfönstertaggar	tags	MaintenanceWindowTagList	Namnen på underhållsfönstret för kontroller och grupper bör gälla för.
Startar vid	startsAt	date	Startdatumet för underhållsfönstret.
Slutar vid	endsAt	date	Slutdatum för underhållsperioden.
Upprepa intervall	repeatInterval	number	Underhållsfönstrets upprepningsintervall från den första förekomsten.
Upprepa enhet	repeatUnit	string	Upprepningsstrategin för underhållsfönstret.
Upprepa slutar vid	repeatEndsAt	date	Slutdatumet då underhållsperioden ska sluta upprepas.
Skapad vid	created_at	date	Datumet då underhållsperioden skapades.
Uppdaterad kl	updated_at	date	Det sista datumet då underhållsperioden uppdaterades.

UnderhållWindowList

Listan över underhållsperioder.

Name	Sökväg	Typ	Description
Föremål		MaintenanceWindow

CheckAssignment

Name	Sökväg	Typ	Description
ID-nummer	id	guid	Identifieraren.
Kontrollera ID	checkId	guid	Identifieraren för kontrollen.
Privat plats-ID	privateLocationId	guid	Identifieraren för den tilldelade privata platsen.

checkAssignments

Kontrollera att den här privata platsen har tilldelats.

Name	Sökväg	Typ	Description
Föremål		CheckAssignment

GroupAssignment

Name	Sökväg	Typ	Description
ID-nummer	id	guid	Identifieraren.
grupp-id	groupId	number	Identifieraren för gruppen.
Privat plats-ID	privateLocationId	guid	Identifieraren för den tilldelade privata platsen.

groupAssignments

Gruppen som den här privata platsen har tilldelats.

Name	Sökväg	Typ	Description
Föremål		GroupAssignment

privateLocationKeys

Name	Sökväg	Typ	Description
ID-nummer	id	guid	Identifieraren.
Rånyckel	rawKey	string	Den råa nyckeln.
Maskerad nyckel	maskedKey	string	Värdet för den maskerade nyckeln.
Skapad vid	created_at	date	När den skapas på.
Uppdaterad kl	updated_at	date	När den uppdateras på.

Nycklar

Name	Sökväg	Typ	Description
Föremål		privateLocationKeys

privatelocationschema

Name	Sökväg	Typ	Description
ID-nummer	id	guid	Identifieraren.
Namn	name	string	Namnet som tilldelats den privata platsen.
Snigelnamn	slugName	string	Giltigt snigelnamn.
Icon	icon	string	Ikonen för privat plats.
Skapad vid	created_at	date	När den skapas på.
Uppdaterad kl	updated_at	date	När den uppdateras på.
Kontrollera tilldelningar	checkAssignments	checkAssignments	Kontrollera att den här privata platsen har tilldelats.
Grupptilldelningar	groupAssignments	groupAssignments	Gruppen som den här privata platsen har tilldelats.
Nycklar	keys	keys
Senast sedd	lastSeen	date	Det senast sedda datumet.
Antal agenter	agentCount	number	Agentantalet.

privateLocationsListSchema

Name	Sökväg	Typ	Description
Föremål		privatelocationschema

commonPrivateLocationSchemaResponse

Name	Sökväg	Typ	Description
ID-nummer	id	guid	Identifieraren.
Namn	name	string	Namnet som tilldelats den privata platsen.
Snigelnamn	slugName	string	Giltigt snigelnamn.
Icon	icon	string	Ikonen för privat plats.
Skapad vid	created_at	date	När den skapas på.
Uppdaterad kl	updated_at	date	När den uppdateras på.
Kontrollera tilldelningar	checkAssignments	checkAssignments	Kontrollera att den här privata platsen har tilldelats.
Grupptilldelningar	groupAssignments	groupAssignments	Gruppen som den här privata platsen har tilldelats.
Nycklar	keys	keys

Tidsstämplar

Name	Sökväg	Typ	Description
Tidsstämpel		date-time	Tidsstämpeln.

queueSize

Köstorleken.

Name	Sökväg	Typ	Description
Föremål		number

äldstaScheduledCheckRun

Name	Sökväg	Typ	Description
Föremål		number

privateLocationsMetricsHistoryResponseSchema

Name	Sökväg	Typ	Description
Tidsstämplar	timestamps	timestamps
Köstorlek	queueSize	queueSize	Köstorleken.
äldstaScheduledCheckRun	oldestScheduledCheckRun	oldestScheduledCheckRun

ReportingTagList

Kontrollera taggar.

Name	Sökväg	Typ	Description
Föremål		string

ReportingAggregate

Name	Sökväg	Typ	Description
Lyckat förhållande	successRatio	number	Lyckat förhållande för kontrollen över det valda datumintervallet. Procentandelen är i decimalform.
Average	avg	number	Genomsnittlig svarstid för kontrollen över det valda datumintervallet i millisekunder.
P95	p95	number	P95-svarstid för kontrollen över det valda datumintervallet i millisekunder.
P99	p99	number	P99-svarstiden för kontrollen över det valda datumintervallet i millisekunder.

Rapportering

Name	Sökväg	Typ	Description
Namn	name	string	Kontrollera namnet.
Kontrollera ID	checkId	string	Kontrollera ID.
Kontrollera typ	checkType	string	Kontrollera typ.
Inaktiverad	deactivated	boolean	Kontrollera att den är inaktiverad.
Rapporttagglista	tags	ReportingTagList	Kontrollera taggar.
aggregate	aggregate	ReportingAggregate

ReportingList

Name	Sökväg	Typ	Description
Föremål		Reporting

Runtime

Name	Sökväg	Typ	Description
Namn	name	string	Det unika namnet på den här körningen.
Etapp	stage	string	Aktuellt livscykelstadium för en körning.
Slut på körning	runtimeEndOfLife	string	Datum då en körning tas bort från vår plattform.
Förinställning	default	boolean	Anger om detta är den aktuella standardkörningen som tillhandahålls av Checkly.
Description	description	string	En kort, läsbar beskrivning av de viktigaste uppdateringarna i den här körningen.
String	dependencies.string	string	Strängen.

RuntimeList

Name	Sökväg	Typ	Description
Föremål		Runtime

Utdrag

Name	Sökväg	Typ	Description
ID-nummer	id	number	Identifieraren.
Namn	name	string	Kodfragmentets namn.
Script	script	string	Din Node.js kod som interagerar med API-kontrolllivscykeln eller fungerar som en del för webbläsarkontroller.
Skapad vid	created_at	date-time	När den skapas på.
Uppdaterad kl	updated_at	date-time	När den uppdateras på.

Kodfragmentlista

Name	Sökväg	Typ	Description
Föremål		Snippet

CheckGroupTrigger

Name	Sökväg	Typ	Description
ID-nummer	id	number	Identifieraren.
Bevis	token	string	Token.
Skapad vid	created_at	date	När den skapas på.
Anropad på	called_at	date	När du anropas.
Uppdaterad kl	updated_at	date	När den uppdateras på.
grupp-id	groupId	number	Gruppidentifieraren.

CheckTrigger

Name	Sökväg	Typ	Description
ID-nummer	id	number	Identifieraren.
Bevis	token	string	Token.
Skapad vid	created_at	date	När den skapas på.
Anropad på	called_at	date	När du anropas.
Uppdaterad kl	updated_at	date	När den uppdateras på.
Kontrollera ID	checkId	string	Kontrollidentifieraren.

objekt

Detta är typen 'objekt'.

snöre

Det här är den grundläggande datatypen "string".