Categorygithub.com/uptime-com/uptime-client-go
modulepackage
1.3.0
Repository: https://github.com/uptime-com/uptime-client-go.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
13
Dependents
4
Files
765 SLOC

# README

go-uptime

A Go client library for Uptime.com

Supported resources:

  • Checks
  • Tags
  • Outages
  • Integrations

Installation

go get -u github.com/uptime-com/uptime-client-go

Run Tests

go test -v ./uptime

Documentation

To view godocs locally, run godoc. Open http://localhost:6060 in a web browser and navigate to the go-uptime package under Third party.

The Uptime.com API Docs may also be a useful reference.

Usage Examples

Please see the examples directory for usage examples.

Credits

Contributions are welcome! Please feel free to fork and submit a pull request with any improvements.

go-uptime was originally created by Kyle Gentle, with support from Elias Laham and the Dev Team at Uptime.com.

Contributors

# Packages

No description provided by the author

# Functions

Int is a helper function that allocations a new int value to store v and returns a pointer to it.
Int64 is a helper function that allocations a new int64 value to store v and returns a pointer to it.
NewClient returns a new client for the Client.com API.

# Structs

Alert represents an alert generated during an outage.
Check represents a check in Uptime.com.
CheckListOptions specifies the optional parameters to the CheckService.List method.
No description provided by the author
No description provided by the author
CheckStats represents the check statistics for a given day.
CheckStatsOptions specifies the parameters to the CheckService.Stats method.
CheckStatsResponse represents the API's response to a Stats query.
CheckStatsTotals represents the 'totals' section of check statistics in Uptime.com.
Client manages communication with the Uptime.com API.
Config represents the configuration for an Client.com client.
No description provided by the author
Integration represents an integration in Uptime.com.
No description provided by the author
No description provided by the author
No description provided by the author
Outage represents an outage reported by Uptime.com.
OutageListOptions specifies the optional parameters to the OutagesService.List and OutagesService.ListByServiceType methods.
OutageListResponse represents a page of Outage results returned by the Uptime.com API.
Tag represents a check tag in Uptime.com.
No description provided by the author
TagListOptions specifies the optional parameters to the TagService.List method.
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
OutageService handles communication with the outage related methods of the Uptime.com API.
No description provided by the author