Administration API
Administration API documentation for JavaScript SDK
All URIs are relative to http://localhost:8080
| Method | HTTP request | Description |
|---|---|---|
| drainServer | POST /v1/admin:drain | Request the server to enter drain mode |
| purgeBackgroundJobs | POST /v1/admin/background-jobs:purge | Purge completed background jobs |
| reloadLicense | POST /v1/admin/license:reload | Reload the active license from disk |
drainServer
AdminDrainResponse drainServer(opts)
Request the server to enter drain mode
Initiates drain mode and optionally waits for the server to quiesce.
Example
import GoodMemClient from '@pairsystems/goodmem-client';
let apiInstance = new GoodMemClient.AdministrationApi();
let opts = {
'adminDrainRequest': new GoodMemClient.AdminDrainRequest() // AdminDrainRequest |
};
apiInstance.drainServer(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| adminDrainRequest | AdminDrainRequest | [optional] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
purgeBackgroundJobs
AdminPurgeJobsResponse purgeBackgroundJobs(opts)
Purge completed background jobs
Deletes terminal background jobs older than a retention cutoff.
Example
import GoodMemClient from '@pairsystems/goodmem-client';
let apiInstance = new GoodMemClient.AdministrationApi();
let opts = {
'adminPurgeJobsRequest': new GoodMemClient.AdminPurgeJobsRequest() // AdminPurgeJobsRequest |
};
apiInstance.purgeBackgroundJobs(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| adminPurgeJobsRequest | AdminPurgeJobsRequest | [optional] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
reloadLicense
AdminReloadLicenseResponse reloadLicense()
Reload the active license from disk
Triggers the server to reload its license file from the configured directory and returns metadata about the currently active license.
Example
import GoodMemClient from '@pairsystems/goodmem-client';
let apiInstance = new GoodMemClient.AdministrationApi();
apiInstance.reloadLicense().then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json