Bloodbath API
  • Bloodbath API
  • Getting started
    • Acquire your API key
    • Schedule your first event
    • Being on the beta release
  • API
    • Working with REST
    • Working with GraphQL
  • Open source libraries
  • Ruby
  • Python
  • Node
  • FAQ
    • What protocols can be used?
    • What's the maximum payload size?
    • What's the correct format to build headers?
    • Wrong format when sending my body over the REST API
Powered by GitBook
On this page
  • First things first
  • Where to find my API key?
  • How to check my API key is valid?

Was this helpful?

  1. Getting started

Acquire your API key

Bloodbath APIs use API keys to authenticate requests.

PreviousBloodbath APINextSchedule your first event

Last updated 3 years ago

Was this helpful?

First things first

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authentication to the API is performed via .

All API requests must be made over . Calls made over plain HTTP will fail. API requests without authentication will also fail.

Where to find my API key?

The easiest way to generate and get your API key is to via our dashboard. Once you've signed up you can go to the which will have your key.

You can use this key to communicate will all Bloodbath APIs.

How to check my API key is valid?

To make sure your API key is valid and working, you can try the ping endpoint via cURL

curl <https://api.bloodbath.io/rest/ping> \\
  -H "Authorization: Bearer <Replace this with your API key>"

# OK Response
{
  "received_at": "2021-05-12T00:41:55.733297Z"
}
Bearer Authentication
HTTPS
sign-up on Bloodbath
settings section