Authentication

All Squash APIs are currently not available for accounts under the free plan. For more details please go to our plans page.

Squash offers a REST API to interact with the service. The response body is in JSON format. Authentication is key based only.

API Keys

You can create API keys to access the service by going to the General Settings page.

Using the API Key

Squash expects a Squash-Key header on each API request. Here is an example on how to use it passing an API Key:

$ curl -i -H 'Squash-Key: B6mtwX0htEW0HaFp9X25UtJsiX1uBNHNsxAptnum2VxgXVwmrJfmd74En1a8MwFe' \
 'https://api.squashlabs.wpengine.com/a/assets/start/?repository=acme'