API endpoints
Learn about the available endpoints for the Administration API in Exasol.
This article describes the endpoints for administering an Exasol database using the Administration REST API.
-
For an introduction to the Administration API, see Administration REST API.
-
For examples, see API examples.
-
For more details about endpoints and schemas, see the API specification in
https://$NODE_IP:4444/openapi.json.
Endpoints
Common endpoints
| Endpoint | Method | Description |
|---|---|---|
/api/v1/databases
|
GET
|
Get databases |
/api/v1/databases/{databaseID}
|
GET
|
Get database |
/api/v1/databases/{databaseID}/parameters
|
GET
|
List database parameters |
DELETE
|
Remove database parameters |
|
PATCH
|
Add database parameters |
|
PUT
|
Replace database parameters |
|
/api/v1/databases/{databaseID}/start
|
PUT
|
Start database |
/api/v1/databases/{databaseID}/stop
|
PUT
|
Stop database |
/api/v1/databases/{databaseID}/volumes
|
GET
|
Get volumes |
/api/v1/databases/{databaseID}/volumes
|
POST
|
Create volume |
/api/v1/databases/{databaseID}/backups
|
GET
|
Get backups |
/api/v1/databases/{databaseID}/backups/abort
|
PUT
|
Abort backup |
/api/v1/databases/{databaseID}/backups/bulk_delete
|
POST
|
Delete backups |
/api/v1/databases/{databaseID}/backups/restore
|
PUT
|
Restore backup |
/api/v1/databases/{databaseID}/backups/start
|
PUT
|
Start backup |
/api/v1/license
|
POST
|
Upload license |
Additional endpoints for AWS native deployments
| Endpoint | Method | Description |
|---|---|---|
/api/v1/databases/{databaseID}/clusters
|
GET
|
Get clusters |
POST
|
Create cluster | |
/api/v1/databases/{databaseID}/clusters/{clusterID}
|
GET
|
Get cluster |
DELETE
|
Delete cluster | |
/api/v1/databases/{databaseID}/clusters/{clusterID}/connect
|
GET
|
Get connection information |
/api/v1/databases/{databaseID}/clusters/{clusterID}/scale
|
PUT
|
Scale cluster size |
/api/v1/databases/{databaseID}/clusters/{clusterID}/start
|
PUT
|
Start cluster |
/api/v1/databases/{databaseID}/clusters/{clusterID}/stop
|
PUT
|
Stop cluster |
