Version: 2.0.13
API
INFORMATION
API access is available only on OpenPanel Enterprise edition
Enable​
To enable OpenAdmin API access:
opencli api on
Example output
# opencli api on
Updated api to on
Disable​
To disable OpenAdmin API access:
opencli api off
Example output
# opencli api off
Updated api to off
Status​
To check current OpenAdmin API status:
opencli api status
Example output
# opencli api status
on
API list​
opencli api list displays all available api endpoints for the installed OpenAdmin version.
opencli api list
Example output
# opencli api list
Endpoint: /api/
Description: On GET returns api status, on POST returns access token
Type: GET POST
Examples:
curl -X GET http://localhost:2087/api/
curl -X POST http://localhost:2087/api/ -H "Content-Type: application/json" -d '{"username":"admin", "password":"kQsUFhwkzBCw3M57"}'
--------------------------------------------------------------------------------
Endpoint: /api/whoami
Description: protected route that can be accessed only with a token and returns a username
Type: GET
Examples:
--------------------------------------------------------------------------------
...
Was this helpful?