Administrative management methods
The management API includes administrative management methods.
Add license
You can add a license for your HCP for cloud scale system. You must provide a valid license file for the licensed function to function. The method decrypts, validates, and stores the license file.
POST https://host_ip:9099/mapi/v1/license/add
The request body is:
{
"value": "license_file"
}
| Parameter | Required | Type | Description |
| value | Yes | String | The file path of your HCP for cloud scale license. |
Not applicable.
|
Status code |
HTTP name |
Description |
| 200 | OK | The request was executed successfully. |
| 401 | Unauthorized | Access was denied because credentials were noit valid. |
| 405 | Method Not Allowed | The specified HTTP method is not allowed for administrative data. Resend using POST. |
Request example:
POST https://10.10.24.195:9099/mapi/v1/license/add
JSON request:
{
"value": "hcpcs_license.plk"
}
Get serial number
You can retrieve the current serial number of your HCP for cloud scale system.
POST https://host_ip:9099/mapi/v1/serial_number/get
Not applicable.
The response body is:
{
"value": "serial_number"
}
|
Parameter |
Type |
Description |
| value | String | The serial number of your HCP for cloud scale system. |
|
Status code |
HTTP name |
Description |
| 200 | OK | The request was executed successfully. |
| 401 | Unauthorized | Access was denied because credentials are not valid. |
| 405 | Method Not Allowed | The specified HTTP method is not allowed for administrative data. Resend using POST. |
Request example:
POST https://10.10.24.195:9099/mapi/v1/serial_number/get
JSON response:
{
"value": "SerialNumber48692"
}
Get system events
You can retrieve the 100 most recent system events.
POST https://host_ip:9099/mapi/v1/system/info
Not applicable.
The response body is:
{
"events": [
{
"severity": "INFO|WARNING|SEVERE",
"subject": "event_subject",
"message": "event_message",
"subsystem": "event_subsystem",
"timestamp": date_time
},
.
.
.
]
}
|
Parameter |
Type |
Description |
| severity | String | The severity of the event:
|
| subject | String | Summary of the event. |
| message | String | Details about the event. |
| subsystem | String | The event category (for example, User, Bucket, or S3 settings). |
| timestamp | 64-bit integer | The date and time, in milliseconds since 1 January 1970 GMT, when the event was generated. |
|
Status code |
HTTP name |
Description |
| 200 | OK | The request was executed successfully. |
| 401 | Unauthorized | Access was denied because credentials are not valid. |
| 405 | Method Not Allowed | The specified HTTP method is not allowed for administrative data. Resend using POST. |
Request example:
POST https://10.10.24.195:9099/mapi/v1/system/info
JSON response:
{
"events": [
{
"severity": "INFO",
"subject": "User admin@company.com authenticated",
"message": "User admin@company.com with Id d3c01db4-ac18-4d90-a321-899bb210baf7 authenticated successfully to the Administration App.",
"subsystem": "User",
"timestamp": 1559547959735
},
{
"severity": "INFO",
"subject": "Unexpectedly failed authentication request by user admin@company.com",
"message": "An authentication request unexpectedly failed for username admin@company.com.",
"subsystem": "User",
"timestamp": 1559547646844
}
]
}
List licenses
You can retrieve information about the current licenses for your HCP for cloud scale system.
POST https://host_ip:9099/mapi/v1/license/list
Not applicable.
The response body is:
{
"featureName": "feature",
"uploadDate": "date_time",
"expirationDate": "date_time0",
"valid": {true|false},
"message": "message"
}
|
Parameter |
Type |
Description |
| featureName | String | Name of the licensed feature. |
| uploadDate | The date and time, in the format Ddd Mmm dd hh:mm:ss TMZ yyyy, when the license was uploaded. | |
| expirationDate | The date and time, in the format Ddd Mmm dd hh:mm:ss TMZ yyyy, when the license expires. | |
| valid | Boolean | If true, the license is valid. If false, the license is invalid. |
| message | String | State of the license:
|
|
Status code |
HTTP name |
Description |
| 200 | OK | The request was executed successfully. |
| 401 | Unauthorized | Access was denied because credentials are not valid. |
| 405 | Method Not Allowed | The specified HTTP method is not allowed for administrative data. Resend using POST. |
Request example:
POST https://10.10.24.195:9099/mapi/v1/license/list
JSON response:
{
"featureName": "DARE",
"uploadDate": "Tue Jun 16 00:00:00 GMT 2020",
"expirationDate": "Sat Oct 24 10:24:54 GMT 2020",
"valid": true,
"message": "License is valid"
}
Refresh client certificates
If your system uses the HTTPS protocol and you change an SSL certificate, you need to update the certificates on storage components.
POST https://host_ip:9099/mapi/v1/certificates/refresh
Not applicable.
Not applicable.
|
Status code |
HTTP name |
Description |
| 200 | OK | The request was executed successfully. |
| 401 | Unauthorized | Access was denied because credentials are not valid. |
| 405 | Method Not Allowed | The specified HTTP method is not allowed for administrative data. Resend using POST. |
Request example:
POST https://10.10.24.195:9099/mapi/v1/certificates/refresh
Set serial number
You can set the serial number of your HCP for cloud scale system. You must provide a valid serial number for the system to function.
POST https://host_ip:9099/mapi/v1/serial_number/set
The request body is:
{
"value": "serial_number"
}
| Parameter | Required | Type | Description |
| value | Yes | String | The serial number of your HCP for cloud scale system. |
The response returns the same parameter as the request.
|
Status code |
HTTP name |
Description |
| 200 | OK | The request was executed successfully. |
| 401 | Unauthorized | Access was denied because credentials were noit valid. |
| 405 | Method Not Allowed | The specified HTTP method is not allowed for administrative data. Resend using POST. |
Request example:
POST https://10.10.24.195:9099/mapi/v1/serial_number/set
JSON request:
{
"value": "SerialNumber48692"
}
JSON response:
{
"value": "SerialNumber48692"
}