Available in VPC
Add or edit notes for a detection target.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| PATCH | /api/v1/servers/{server-id}/memo |
Request headers
For information about the headers common to all Webshell Behavior Detector APIs, see Webshell Behavior Detector request headers.
Request path parameters
You can use the following path parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
server-id |
Integer | Required | Instance ID of the detection target server
|
Request body
The following describes the request body.
| Field | Type | Required | Description |
|---|---|---|---|
content |
String | Required | Notes to be edited |
Request example
The following is a sample request.
curl --location --request PATCH 'https://wbd.apigw.ntruss.com/api/v1/servers/25****97/memo' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'X-NCP-USE_PLATFORM_TYPE: VPC' \
--data '{
"content": "duplicated server"
}'
Response
The following describes the response format.
Response body
The following describes the response body.
| Field | Type | Required | Description |
|---|---|---|---|
success |
Boolean | - | Request handling status |
code |
Integer | - | Response code |
message |
String | - | Response message |
result |
Object | - | Response result |
Response status codes
For information about the HTTP status codes common to all Webshell Behavior Detector APIs, see Webshell Behavior Detector response status codes.
Response example
The following is a sample example.
{
"success": true,
"code": 0,
"message": "success",
"result": {
"success": true,
"code": 0,
"message": "success",
"result": null
}
}