Authentication

Looking for the deprecated V1 docs? They are still available here.

Vestaboard owners can request access for a Local API enablement token here. Fill out the form in its entirety and submit your request for local API access.

In order to be eligible to use the local API, your Vestaboard needs to be paired and available for a firmware update.

Once your request for your local API enablement token is processed, you will receive an email with your token.

You can then make an API request to your Vestaboard to enable your local API. This is a one-time API call that will enable your local API and respond with an API token you can use to authenticate all of your future requests.

CURL

curl -X POST -H "X-Vestaboard-Local-Api-Enablement-Token: YOUR_API_ENABLEMENT_TOKEN" http://vestaboard.local:7000/local-api/enablement

Javascript

await fetch("http://vestaboard.local:7000/local-api/enablement", {
  headers: {
    "Content-Type": "application/json",
    "X-Vestaboard-Local-Api-Enablement-Token": "YOUR_API_ENABLEMENT_TOKEN",
  },
  method: "POST",
}).then((res) => res.json());

Example Response

{
  "message": "Local API enabled",
  "apiKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

After receiving your API key, you can use it on your requests to read and write to your Vestaboard by passing it through the X-Vestaboard-Local-Api-Key header on your API requests.