Installation

Installation of each StatusCake API SDK should be performed through the respective package manager, or directly from GitHub where appropriate. This guide will prefer the use of a dependency manager unless otherwise stated.

Use the following steps to install the StatusCake API SDK for the desired language:

info

Some SDK 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 here.

Go

Install statuscake-go

go get github.com/StatusCakeDev/statuscake-go

JavaScript (alpha)

Install statuscake-js

npm install -D statuscake-js

Python (alpha)

Install statuscake-py

pip install statuscake-py

Ruby (alpha)

Install statuscake-rb

bundle add statuscake-rb

Create a Client

Once the desired SDK(s) is installed the next step is to create an authenticated API client. You can view and manage your API tokens from the StatusCake account panel.

note

API tokens must be kept private. In the event that one is exposed a new one should be generated.

Go

Create a Client

package main

import (
  "github.com/StatusCakeDev/statuscake-go"
  "github.com/StatusCakeDev/statuscake-go/credentials"
)

func main() {
  bearer := credentials.NewBearerWithStaticToken("my-api-token")
  client := statuscake.NewClient(statuscake.WithRequestCredentials(bearer))
}

JavaScript (alpha)

Create a Client

import 'isomorphic-fetch';
import {
  Configuration,
} from '@statuscake/statuscake-js';

const config = new Configuration({
  headers: {
    'Authorization': `Bearer ${apiToken}`,
  },
});

Python (alpha)

Create a Client

from statuscake import ApiClient

client = ApiClient(
  header_name='Authorization',
  header_value='Bearer %s' % api_token,
)

Ruby (alpha)

Create a Client

require 'statuscake'

client = StatusCake::ApiClient.new

# Constructing these options is a temporary fix until a client wide
# authentication mechanism has been realised.
opts = { header_params: { 'Authorization' => "Bearer #{api_token}" } }

List Uptime Checks

With the API client configured you may make requests to the StatusCake API using the available methods. In this document we will list all uptime checks for the given workspace.

Go

List Uptime Checks

package main

import (
  "context"
  "fmt"

  "github.com/StatusCakeDev/statuscake-go"
  "github.com/StatusCakeDev/statuscake-go/credentials"
)

func main() {
  bearer := credentials.NewBearerWithStaticToken("my-api-token")
  client := statuscake.NewClient(statuscake.WithRequestCredentials(bearer))

  res, err := client.ListUptimeTests(context.Background()).Execute()
  if err != nil {
    panic(err)
  }

  fmt.Printf("%+v\n", res.Data)
}

JavaScript (alpha)

List Uptime Checks

import 'isomorphic-fetch';
import {
  Configuration,
  UptimeApi,
} from '@statuscake/statuscake-js';

const config = new Configuration({
  headers: {
    'Authorization': `Bearer ${apiToken}`,
  },
});

const service = new UptimeApi(config);
service.listUptimeTests()
  .then((tests) => console.log(JSON.stringify(tests)))
  .catch(console.log);

Python (alpha)

List Uptime Checks

from statuscake import ApiClient
from statuscake.apis import UptimeApi

client = ApiClient(
  header_name='Authorization',
  header_value='Bearer %s' % api_token,
)

service = UptimeApi(api_client=client)
tests = service.list_uptime_tests()

print(tests)

Ruby (alpha)

List Uptime Checks

require 'statuscake'

client = StatusCake::ApiClient.new

# Constructing these options is a temporary fix until a client wide
# authentication mechanism has been realised.
opts = { header_params: { 'Authorization' => "Bearer #{api_token}" } }

service = StatusCake::UptimeApi.new(client)
tests = service.list_uptime_tests(opts)

puts tests

Next steps

There are many other methods available within each SDK to manage StatusCake monitoring resource that are not covered in this document. See the respective SDK GitHub repositories for example usage.

Next learn about configuration options available in the SDKs.