With the tools endpoint, you can perform actions on sites like:
- Clear site cache.
- Restart PHP.
- Update PHP
- Get and update a list of denied IP addresses.
Most of these tool endpoints will trigger longer tasks (from a few seconds to around a minute) on your environments. This is why they provide 202 Accepted response, with an operation_id in the body. To check the progress, you can use the /operations endpoint.
Clear Site Cache
Clearing site cache in progress
No or invalid API key provided to the request
Error occurred while trying to clear cache
- Payload
- curl
- Node.js
- Browser JavaScript
- PHP
{- "environment_id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1"
}- 202
- 401
- 500
{- "operation_id": "cache:clear-54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "message": "Clearing site cache in progress",
- "status": 202
}Restart an Environment's PHP Engine
Restarting PHP in progress
No or invalid API key provided to the request
Error occurred while trying to restart the PHP engine
- Payload
- curl
- Node.js
- Browser JavaScript
- PHP
{- "environment_id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1"
}- 202
- 401
- 500
{- "operation_id": "php:restart-54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "message": "Restarting PHP in progress",
- "status": 202
}Modify an Environment's PHP Version
Modifying PHP version in progress
No or invalid API key provided to the request
Error occurred while trying to modify PHP version
- Payload
- curl
- Node.js
- Browser JavaScript
- PHP
{- "environment_id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "php_version": "8.1"
}- 202
- 401
- 500
{- "operation_id": "php:modify-version-54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "message": "Modifying PHP version in progress",
- "status": 202
}Get list of denied IPs
Returns list of denied IPs
No or invalid API key provided to the request
Error occurred while trying to get list of denied IPs
- Payload
- curl
- Node.js
- Browser JavaScript
- PHP
{- "environment_id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1"
}- 200
- 401
- 500
{- "environment": {
- "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "ip_list": [
- "127.0.0.1"
]
}
}Update denied IP list
List of denied IPs was updated
No or invalid API key provided to the request
Error occurred while trying to update list of denied IPs
- Payload
- curl
- Node.js
- Browser JavaScript
- PHP
{- "environment_id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
- "ip_list": [
- "127.0.0.1"
]
}- 200
- 401
- 500
{- "result": null
}