This URL imports a customised YAML file.
Resource URL
suricata/yaml/import
Content-type value
multipart/form-data
Request Parameters
Payload (form-data) Request Parameters:
Field Name | Description | Data Type | Mandatory |
|---|---|---|---|
| YAML file | File | Yes |
Response Parameters
Following fields are returned if the request parameters are correct.
Field Name | Description | Data Type |
|---|---|---|
| Displays the success status | Boolean |
| Displays the message | String |
| Displays the error message | Boolean |
| An object that contains the details of the field | Boolean |
| Error code | Number |
Example
Request
POST https://<IPSM_IP>/sdkapi/suricata/yaml/import
Response
{
"success": true,
"msg": "File imported successfully",
"errMsg": null,
"data": null,
"errorCode": 0
}
Error Information
The following error code is returned by this URL:
S.No | Generic Error Codes | ErrorMessage | Error Reason |
|---|---|---|---|
1 | 1001 | Bad URL - HTTP 404 Not Found | Mistyped URL |
Internal Error – Null | Incorrect Input data, authentication issues |