Skip to main content
An API is available for those running multiple explorers or users who prefer a programatic approach to Autoscout management.
  • You will need a valid API key to use the API → https://deploy.blockscout.com/api-keys
  • API Base URL: The base URL for the Autoscout API is https://autoscout.services.blockscout.com
The Autoscout API swagger file with all endpoints and usage notes is available at https://blockscout.github.io/swaggers/services/autoscout/main/index.html

​
Create an Instance

Send a POST request to the /api/v1/instances endpoint with the required configuration. 
x-api-key: YOUR_API_KEY
Content-Type: application/json

​
Start Instance

Send a POST request to/api/v1/instances/{instance_id}/status:update Use the instance id returned in the previous step. 
x-api-key: YOUR_API_KEY
Content-Type: application/json

​
Check Deployment Status

Send a GET request to the /api/v1/instances/{instance_id}/deployments/currentendpoint. 
x-api-key: YOUR_API_KEY

​
Update an Instance

  1. Send a PATCH request to the /api/v1/instances/{instance_id}/config endpoint with the config changes.
x-api-key: YOUR_API_KEY
Content-Type: application/json
  1. Restart the instance by sending a POST request to the /api/v1/instances/{instance_id}/status:update endpoint with the action “RESTART”.
x-api-key: YOUR_API_KEY
Content-Type: application/json

​
Stop an Instance

Send a POST request to the /api/v1/instances//status:update endpoint with the action “STOP”.
Important Note: Stopping an instance will result in all data being deleted. Ensure that you have backed up any necessary data before stopping the instance.
x-api-key: YOUR_API_KEY
Content-Type: application/json