checkly

package module

Go to main page

Versions in this module

v1

v1.9.1

Feb 3, 2025

v1.9.0

Jan 28, 2025

Changes in this version

+ const ResponseData

type Client

+ CreateTCPCheck func(ctx context.Context, check TCPCheck) (*TCPCheck, error)

+ GetTCPCheck func(ctx context.Context, ID string) (*TCPCheck, error)

+ UpdateTCPCheck func(ctx context.Context, ID string, check TCPCheck) (*TCPCheck, error)

+ type TCPCheck struct

+ Activated bool

+ AlertChannelSubscriptions []AlertChannelSubscription

+ AlertSettings *AlertSettings

+ CreatedAt time.Time

+ DegradedResponseTime int

+ Frequency int

+ FrequencyOffset int

+ GroupID int64

+ GroupOrder int

+ ID string

+ Locations []string

+ MaxResponseTime int

+ Muted bool

+ Name string

+ PrivateLocations *[]string

+ Request TCPRequest

+ RetryStrategy *RetryStrategy

+ RunParallel bool

+ RuntimeID *string

+ ShouldFail bool

+ Tags []string

+ UpdatedAt time.Time

+ UseGlobalAlertSettings bool

+ type TCPRequest struct

+ Assertions []Assertion

+ Data string

+ Hostname string

+ IPFamily string

+ Port uint16

v1.8.1

Sep 2, 2024

Changes in this version

type EnvironmentVariable

+ Secret bool

v1.8.0

Jul 1, 2024

Changes in this version

type Client

+ GetStaticIPs func(ctx context.Context) ([]StaticIP, error)

+ type StaticIP struct

+ Address netip.Prefix

+ Region string

v1.7.3

Jun 21, 2024

Changes in this version

type Request

+ IPFamily string

v1.7.2

Feb 7, 2024

Changes in this version

type AlertSettings

+ ParallelRunFailureThreshold ParallelRunFailureThreshold

+ type ParallelRunFailureThreshold struct

+ Enabled bool

+ Percentage int

v1.7.1

Dec 15, 2023

Changes in this version

type Check

+ RunParallel bool

type Group

+ RunParallel bool

type MultiStepCheck

+ RunParallel bool

v1.7.0

Oct 31, 2023

Changes in this version

type Client

+ GetRuntime func(ctx context.Context, ID string) (*Runtime, error)

+ type MultiStepCheck struct

+ Activated bool

+ AlertChannelSubscriptions []AlertChannelSubscription

+ AlertSettings AlertSettings

+ CreatedAt time.Time

+ EnvironmentVariables []EnvironmentVariable

+ Frequency int

+ FrequencyOffset int

+ GroupID int64

+ GroupOrder int

+ ID string

+ Locations []string

+ Muted bool

+ Name string

+ PrivateLocations *[]string

+ RetryStrategy *RetryStrategy

+ RuntimeID *string

+ Script string

+ ShouldFail bool

+ Tags []string

+ Type string

+ UpdatedAt time.Time

+ UseGlobalAlertSettings bool

+ type Runtime struct

+ Description string

+ MultiStepSupport bool

+ Name string

+ RuntimeEndOfLife string

+ Stage string

v1.6.9

Sep 1, 2023

Changes in this version

type RetryStrategy

+ MaxRetries int

v1.6.8

Aug 30, 2023

Changes in this version

type Check

+ RetryStrategy *RetryStrategy

type Group

+ RetryStrategy *RetryStrategy

+ type RetryStrategy struct

+ BaseBackoffSeconds int

+ MaxAttempts int

+ MaxDurationSeconds int

+ SameRegion bool

+ Type string

v1.6.7

Aug 8, 2023

v1.6.6

Aug 3, 2023

Changes in this version

+ const TypeHeartbeat

type Check

+ Heartbeat Heartbeat

type Client

+ CreateHeartbeat func(ctx context.Context, check HeartbeatCheck) (*HeartbeatCheck, error)

+ GetHeartbeatCheck func(ctx context.Context, ID string) (*HeartbeatCheck, error)

+ UpdateHeartbeat func(ctx context.Context, ID string, check HeartbeatCheck) (*HeartbeatCheck, error)

+ type Heartbeat struct

+ Grace int

+ GraceUnit string

+ Period int

+ PeriodUnit string

+ PingToken string

+ type HeartbeatCheck struct

+ Activated bool

+ AlertChannelSubscriptions []AlertChannelSubscription

+ AlertSettings AlertSettings

+ CreatedAt time.Time

+ Heartbeat Heartbeat

+ ID string

+ Muted bool

+ Name string

+ Tags []string

+ UpdatedAt time.Time

+ UseGlobalAlertSettings bool

v1.6.5

Jun 29, 2023

Changes in this version

+ const AlertTypeCall

type AlertChannel

+ CALL *AlertChannelCall

+ type AlertChannelCall struct

+ Name string

+ Number string

v1.6.4

Jun 6, 2023

Changes in this version

type Dashboard

+ IsPrivate bool

+ Keys []DashboardKey

+ type DashboardKey struct

+ CreatedAt string

+ Id string

+ MaskedKey string

+ RawKey string

+ UpdatedAt string

v1.6.3

Mar 17, 2023

Changes in this version

type AlertChannelWebhook

+ WebhookType string

v1.6.2

Oct 14, 2022

Changes in this version

type Dashboard

+ ChecksPerPage int

+ Description string

+ Favicon string

+ Link string

+ UseTagsAndOperator bool

v1.6.1

Jun 22, 2022

Changes in this version

type Check

+ PrivateLocations *[]string

type Group

+ PrivateLocations *[]string

v1.6.0

Jun 21, 2022

Changes in this version

type Client

+ CreateCheck func(ctx context.Context, check Check) (*Check, error)

+ CreatePrivateLocation func(ctx context.Context, pl PrivateLocation) (*PrivateLocation, error)

+ DeleteCheck func(ctx context.Context, ID string) error

+ DeletePrivateLocation func(ctx context.Context, ID string) error

+ GetCheck func(ctx context.Context, ID string) (*Check, error)

+ GetPrivateLocation func(ctx context.Context, ID string) (*PrivateLocation, error)

+ UpdateCheck func(ctx context.Context, ID string, check Check) (*Check, error)

+ UpdatePrivateLocation func(ctx context.Context, ID string, pl PrivateLocation) (*PrivateLocation, error)

type Dashboard

+ CreatedAt string

+ UpdatedAt string

type Group

+ CreatedAt time.Time

+ UpdatedAt time.Time

+ type Location struct

+ Name string

+ Region string

+ type PrivateLocation struct

+ AgentCount int

+ CreatedAt string

+ ID string

+ Icon string

+ Keys []PrivateLocationKey

+ LastSeen string

+ Name string

+ SlugName string

+ UpdatedAt string

+ type PrivateLocationKey struct

+ CreatedAt string

+ Id string

+ MaskedKey string

+ RawKey string

+ UpdatedAt string

v1.5.7

Feb 4, 2022

v1.5.6

Feb 4, 2022

Changes in this version

type Request

+ SkipSSL bool

v1.5.5

Jan 27, 2022

Changes in this version

type Client

+ SetChecklySource func(source string)

v1.5.4

Jan 27, 2022

v1.5.3

Jan 27, 2022

v1.5.2

Jan 5, 2022

Changes in this version

type TriggerCheck

+ URL string

type TriggerGroup

+ URL string

v1.5.1

Dec 15, 2021

v1.5.0

Dec 14, 2021

Changes in this version

type Client

+ CreateTriggerCheck func(ctx context.Context, checkID string) (*TriggerCheck, error)

+ CreateTriggerGroup func(ctx context.Context, groupID int64) (*TriggerGroup, error)

+ DeleteTriggerCheck func(ctx context.Context, checkID string) error

+ DeleteTriggerGroup func(ctx context.Context, groupID int64) error

+ GetTriggerCheck func(ctx context.Context, checkID string) (*TriggerCheck, error)

+ GetTriggerGroup func(ctx context.Context, groupID int64) (*TriggerGroup, error)

+ type TriggerCheck struct

+ CalledAt string

+ CheckId string

+ CreatedAt string

+ ID int64

+ Token string

+ UpdatedAt string

+ type TriggerGroup struct

+ CalledAt string

+ CreatedAt string

+ GroupId int64

+ ID int64

+ Token string

+ UpdatedAt string

v1.4.0

Nov 9, 2021

Changes in this version

type Client

+ CreateDashboard func(ctx context.Context, dashboard Dashboard) (*Dashboard, error)

+ CreateMaintenanceWindow func(ctx context.Context, mw MaintenanceWindow) (*MaintenanceWindow, error)

+ DeleteDashboard func(ctx context.Context, ID string) error

+ DeleteMaintenanceWindow func(ctx context.Context, ID int64) error

+ GetDashboard func(ctx context.Context, ID string) (*Dashboard, error)

+ GetMaintenanceWindow func(ctx context.Context, ID int64) (*MaintenanceWindow, error)

+ SetAccountId func(ID string)

+ UpdateDashboard func(ctx context.Context, ID string, dashboard Dashboard) (*Dashboard, error)

+ UpdateMaintenanceWindow func(ctx context.Context, ID int64, mw MaintenanceWindow) (*MaintenanceWindow, error)

+ type Dashboard struct

+ CustomDomain string

+ CustomUrl string

+ DashboardID string

+ Header string

+ HideTags bool

+ ID int64

+ Logo string

+ Paginate bool

+ PaginationRate int

+ RefreshRate int

+ Tags []string

+ Width string

+ type MaintenanceWindow struct

+ CreatedAt string

+ EndsAt string

+ ID int64

+ Name string

+ RepeatEndsAt string

+ RepeatInterval int

+ RepeatUnit string

+ StartsAt string

+ Tags []string

+ UpdatedAt string

v1.3.1

Oct 15, 2021

v1.3.0

Jul 14, 2021

Changes in this version

type Check

+ RuntimeID *string

type Group

+ RuntimeID *string

v1.2.0

Jun 2, 2021

Changes in this version

type AlertChannel

+ Pagerduty *AlertChannelPagerduty

+ type AlertChannelPagerduty struct

+ Account string

+ ServiceKey string

+ ServiceName string

v1.1.0

May 21, 2021

Changes in this version

type Check

+ FrequencyOffset int

v1.0.1

Feb 25, 2021

v1.0.0

Feb 17, 2021

v0

v0.5.6

Feb 25, 2021

v0.5.5

Feb 17, 2021

v0.5.4

Feb 25, 2021

v0.5.3

Jan 21, 2021

v0.5.2

Jan 21, 2021

v0.5.1

Jan 21, 2021

Changes in this version

type AlertChannel

+ SSLExpiry *bool

+ SSLExpiryThreshold *int

+ SendDegraded *bool

+ SendFailure *bool

+ SendRecovery *bool

v0.5.0

Jan 11, 2021

v0.4.9

Jan 11, 2021

v0.4.8

Jan 11, 2021

Changes in this version

+ const AlertTypeEmail

+ const AlertTypeOpsgenie

+ const AlertTypePagerduty

+ const AlertTypeSMS

+ const AlertTypeSlack

+ const AlertTypeWebhook

+ func AlertChannelConfigFromJSON(channelType string, cfgJSON []byte) (interface{}, error)

type AlertChannel

+ Email *AlertChannelEmail

+ Opsgenie *AlertChannelOpsgenie

+ SMS *AlertChannelSMS

+ Slack *AlertChannelSlack

+ Webhook *AlertChannelWebhook

+ func (a *AlertChannel) GetConfig() (cfg map[string]interface{})

+ func (a *AlertChannel) SetConfig(cfg interface{})

+ type AlertChannelEmail struct

+ Address string

+ type AlertChannelOpsgenie struct

+ APIKey string

+ Name string

+ Priority string

+ Region string

+ type AlertChannelSMS struct

+ Name string

+ Number string

+ type AlertChannelSlack struct

+ Channel string

+ WebhookURL string

+ type AlertChannelSubscription struct

+ Activated bool

+ ChannelID int64

+ type AlertChannelWebhook struct

+ Headers []KeyValue

+ Method string

+ Name string

+ QueryParameters []KeyValue

+ Template string

+ URL string

+ WebhookSecret string

type Client

+ func (c *Client) CreateAlertChannel(ac AlertChannel) (*AlertChannel, error)

+ func (c *Client) DeleteAlertChannel(ID int64) error

+ func (c *Client) GetAlertChannel(ID int64) (*AlertChannel, error)

+ func (c *Client) UpdateAlertChannel(ID int64, ac AlertChannel) (*AlertChannel, error)

v0.4.7

Sep 30, 2020

v0.4.6

Sep 29, 2020

Changes in this version

type Client

+ func (c *Client) CreateEnvironmentVariable(envVar EnvironmentVariable) (EnvironmentVariable, error)

+ func (c *Client) CreateSnippet(snippet Snippet) (Snippet, error)

+ func (c *Client) DeleteEnvironmentVariable(key string) error

+ func (c *Client) DeleteSnippet(ID int64) error

+ func (c *Client) GetEnvironmentVariable(key string) (EnvironmentVariable, error)

+ func (c *Client) GetSnippet(ID int64) (Snippet, error)

+ func (c *Client) UpdateEnvironmentVariable(key string, envVar EnvironmentVariable) (EnvironmentVariable, error)

+ func (c *Client) UpdateSnippet(ID int64, snippet Snippet) (Snippet, error)

+ type Snippet struct

+ CreatedAt time.Time

+ ID int64

+ Name string

+ Script string

+ UpdatedAt time.Time

v0.4.5

Sep 16, 2020

v0.4.4

Sep 3, 2020

Changes in this version

+ type ApiCheckResult struct

+ type BrowserCheckResult struct

+ type CheckResult struct

+ ApiCheckResult *ApiCheckResult

+ Attempts int64

+ BrowserCheckResult *BrowserCheckResult

+ CheckID string

+ CheckRunID int64

+ CreatedAt time.Time

+ HasErrors bool

+ HasFailures bool

+ ID string

+ IsDegraded bool

+ Name string

+ OverMaxResponseTime bool

+ ResponseTime int64

+ RunLocation string

+ StartedAt time.Time

+ StoppedAt time.Time

+ type CheckResultsFilter struct

+ CheckType CheckType

+ From int64

+ HasFailures bool

+ Limit int64

+ Location string

+ Page int64

+ To int64

+ type CheckType string

type Client

+ func (c *Client) GetCheckResult(checkID, checkResultID string) (CheckResult, error)

+ func (c *Client) GetCheckResults(checkID string, filters *CheckResultsFilter) ([]CheckResult, error)

v0.4.3

Jul 29, 2020

v0.4.2

Jun 17, 2020

v0.4.1

Jun 5, 2020

v0.4.0

Jun 3, 2020

Changes in this version

+ type APICheckDefaults struct

+ Assertions []Assertion

+ BaseURL string

+ BasicAuth BasicAuth

+ Headers []KeyValue

+ QueryParameters []KeyValue

+ type BrowserCheckDefaults struct

type Check

+ GroupID int64

+ GroupOrder int

type Client

+ func (c *Client) CreateGroup(group Group) (Group, error)

+ func (c *Client) DeleteGroup(ID int64) error

+ func (c *Client) GetGroup(ID int64) (Group, error)

+ func (c *Client) UpdateGroup(ID int64, group Group) (Group, error)

+ type Group struct

+ APICheckDefaults APICheckDefaults

+ Activated bool

+ AlertChannelSubscriptions []Subscription

+ AlertSettings AlertSettings

+ BrowserCheckDefaults BrowserCheckDefaults

+ Concurrency int

+ DoubleCheck bool

+ EnvironmentVariables []EnvironmentVariable

+ ID int64

+ LocalSetupScript string

+ LocalTearDownScript string

+ Locations []string

+ Muted bool

+ Name string

+ SetupSnippetID int64

+ Tags []string

+ TearDownSnippetID int64

+ UseGlobalAlertSettings bool

v0.3.0

May 15, 2020

Changes in this version

+ const Contains

+ const Equals

+ const GreaterThan

+ const Headers

+ const IsEmpty

+ const JSONBody

+ const LessThan

+ const NotContains

+ const NotEmpty

+ const NotEquals

+ const ResponseTime

+ const RunBased

+ const StatusCode

+ const TextBody

+ const TimeBased

+ const TypeAPI

+ const TypeBrowser

+ type AlertChannel struct

+ Config map[string]interface{}

+ CreatedAt time.Time

+ ID string

+ Type string

+ UpdatedAt time.Time

+ type AlertSettings struct

+ EscalationType string

+ Reminders Reminders

+ RunBasedEscalation RunBasedEscalation

+ SSLCertificates SSLCertificates

+ TimeBasedEscalation TimeBasedEscalation

+ type Assertion struct

+ ArrayIndex int

+ ArraySelector int

+ Comparison string

+ Edit bool

+ Order int

+ Property string

+ Source string

+ Target string

+ type BasicAuth struct

+ Password string

+ Username string

+ type Check struct

+ Activated bool

+ AlertChannelSubscriptions []Subscription

+ AlertSettings AlertSettings

+ CreatedAt time.Time

+ DegradedResponseTime int

+ DoubleCheck bool

+ EnvironmentVariables []EnvironmentVariable

+ Frequency int

+ ID string

+ LocalSetupScript string

+ LocalTearDownScript string

+ Locations []string

+ MaxResponseTime int

+ Muted bool

+ Name string

+ Request Request

+ SSLCheck bool

+ SSLCheckDomain string

+ Script string

+ SetupSnippetID int64

+ ShouldFail bool

+ Tags []string

+ TearDownSnippetID int64

+ Type string

+ UpdatedAt time.Time

+ UseGlobalAlertSettings bool

+ type Client struct

+ Debug io.Writer

+ HTTPClient *http.Client

+ URL string

+ func NewClient(apiKey string) Client

+ func (c *Client) Create(check Check) (string, error)

+ func (c *Client) Delete(ID string) error

+ func (c *Client) Get(ID string) (Check, error)

+ func (c *Client) MakeAPICall(method string, URL string, data []byte) (statusCode int, response string, err error)

+ func (c *Client) Update(ID string, check Check) error

+ type EnvironmentVariable struct

+ Key string

+ Locked bool

+ Value string

+ type KeyValue struct

+ Key string

+ Locked bool

+ Value string

+ type Reminders struct

+ Amount int

+ Interval int

+ type Request struct

+ Assertions []Assertion

+ BasicAuth BasicAuth

+ Body string

+ BodyType string

+ FollowRedirects bool

+ Headers []KeyValue

+ Method string

+ QueryParameters []KeyValue

+ URL string

+ type RunBasedEscalation struct

+ FailedRunThreshold int

+ type SSLCertificates struct

+ AlertThreshold int

+ Enabled bool

+ type Subscription struct

+ Activated bool

+ AlertChannelID int64

+ CheckID string

+ ID string

+ type TimeBasedEscalation struct

+ MinutesFailingThreshold int

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL