uptime-client-go

module
v2.0.0-...-b02a9ef Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 7, 2024 License: MIT

README

uptime-client-go

A Go client library for Uptime.com

Supported resources:

  • Checks
  • Dashboards
  • Tags
  • Outages
  • Integrations
  • Probe servers
  • Contact groups (partial)

Installation

Command line tool (upctl)

Downdload the latest release from the releases page or install from sources:

go install github.com/uptime-com/uptime-client-go/v2/cmd/upctl@latest
Authentication

Obtain API token from Uptime.com and set it as an environment variable:

export UPCTL_TOKEN=your-api-token
Library
go get -u github.com/uptime-com/uptime-client-go/v2@latest

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.

Original version was created by Kyle Gentle, with support from Elias Laham and the Dev Team at Uptime.com.

Contributors

See contributors page.

Directories

Path Synopsis
cmd
internal
pkg

Jump to

Keyboard shortcuts

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