SDKs Introduction
Our Software Development Kits (SDKs) provide integrations into several common programming languages making it simpler to manage monitoring resources using idiomatic code. Each wraps the StatusCake API, so you work with typed requests and responses instead of building HTTP calls by hand, and the SDK takes care of authentication, retries and backing off when the API asks for it.
At present we support the following languages:
Go
JavaScript
Python
Ruby
Some SDKs are currently in alpha and will not be given support at this time. We are currently working to deliver stable releases for each of these projects. Read more about alpha releases in the documentation.
What an SDK gives you​
- Typed requests and responses. Check types, check rates, regions and repeat intervals are values the compiler or editor can check, rather than strings and numbers you must get right yourself.
- Authentication. Give the client a token once and every request carries it.
- Retries and backoff. When the API says it is being asked too much, the client waits and tries again. How many times, and for how long, is configurable.
- Structured errors. A failed request becomes an error that tells you which parameters were wrong.
When to use an SDK​
Reach for an SDK when monitoring is something your own software manages: a service that registers a check for each tenant it provisions, a deployment tool that pauses checks while it works, or a report that reads uptime into your own systems.
If you are describing monitoring as configuration, the Terraform provider is usually a better fit. If your language has no SDK, call the API directly.
How these guides are organised​
The guides build on each other, and can also be read individually.
| Guide | What it covers |
|---|---|
| Installation | Adding an SDK to your project. |
| Authentication | Creating a client that can make requests. |
| Quick Start | Your first requests: list, create and delete a check. |
| Managing Resources | Creating, reading, updating and deleting each kind of resource. |
| Reading Results | History, periods of downtime and alerts for a check. |
| Pagination | Reading every result of a large list. |
| Error Handling | Telling a failure from a validation problem. |
| Configuration | Retries, throttling, HTTP clients and debugging. |
| Backoff Strategies | Choosing how long to wait between retries. |
The Go SDK is the most complete, and the guides after the Quick Start use it for their examples. The other SDKs are in alpha, so consult their repositories for the current state of any feature.
Next Steps​
Install the SDK for your language.