Overview
The Web Security Checker APIs are provided in the RESTful form, and to call the provided APIs, you need to create a Sub Account and access key.
Common Web Security Checker API settings
The following describes commonly used request and response formats in Web Security Checker APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows:
https://wsc.apigw.ntruss.com
Request headers
The following describes the headers.
| Field | Required | Description |
|---|---|---|
x-ncp-apigw-timestamp |
Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
|
x-ncp-iam-access-key |
Required | Access key issued on NAVER Cloud Platform
|
x-ncp-apigw-signature-v2 |
Required | Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256)
|
Content-Type |
Required | Request data format
|
Response
The following describes the common response format.
Response status codes
The following describes the response status codes.
| HTTP status code | Code | Message | Description |
|---|---|---|---|
| 200 | 0 | success | Succeeded |
| 400 | 901 | API Call Fail | If it's temporarily unavailable and the error persists, contact Support > Contact us. |
| 401 | 169201 | Auth Check Error | No permissions |
| 400 | 169202 | User Check Error | Failed to verify customer account information, need to contact customer for verification. |
| 400 | 160331 | ActionURL Check Error | HTTP or HTTPS entered in the action URL. |
| 400 | 160332 | Param Check Error | Input value has an unacceptable value, special characters are restricted for the ID param/PW param value. |
| 400 | 160351 | Login_Check_Fail | An error occurred during the login process and you need to double-check your login information and try again, or enter cookies manually. |
| 400 | 160353 | URL Connection Error | Failed to connect to the entered action URL |
| 400 | 160431 | Param Check Error | Input value has an unacceptable value. |
| 400 | 160432 | Param Check Null | Input value has a missing value. |
| 400 | 160433 | Param Value Not Define | Input value has an undefined value. |
| 400 | 160441 | DB Execute Query Error | An error occurred while processing scan job registration, need to try again later. |
| 400 | 160451 | Assets_Check_Fail | It is not the customer's NAVER Cloud Platform server and only diagnostics of customer-owned NAVER Cloud Platform assets are available. |
| 400 | 160452 | Queue_Full | For the selected schedule, the reservation is full and need to select a different one. |
| 400 | 160453 | Already_Exists | You can't perform vulnerability scanning for one target at the same time, and the currently set scan target is pending scanning, so you need to check the “Scan Status/Results” menu at the top of the page. |
| 400 | 160454 | TooMany_Insert | Too many jobs pending and need to be added after scans run. |
| 400 | 160455 | ReScan Create failed | The target's domain and IP must be the same as the initial diagnosis to qualify for a re-diagnostic, and only three times within 60 days of the end of the initial diagnostic. |
| 400 | 160456 | Managed Service agree chk failed | Consent information for third-party web server diagnostics is unavailable and available after consent is given. |
| 400 | 160457 | Managed Service file chk failed | Failed to check files required for third-party web server diagnostics and need to proceed to step 2 of the third-party web server diagnostics instructions pop-up. |
| 400 | 160701 | Open period expired | Diagnostic reports are available for 1 year. |
| 400 | 160842 | DB Matcing Data 0 | There are no targets to cancel, and bulk cancel can only cancel reserved and pending jobs. |
| 400 | 165244 | DB Data Record CNT Not Matching | Requested instanceNo list and number of DB query records are different. |
Note
For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
Web Security Checker API
The following describes the APIs provided by the Web Security Checker service.
| Service | API | Method | Request URI |
|---|---|---|---|
| Web Security Checker | getJobs | GET | https://wsc.apigw.ntruss.com/api/v1/jobs |
| Web Security Checker | searchJobs | POST | https://wsc.apigw.ntruss.com/api/v1/jobs/search |
| Web Security Checker | cancelJob | PATCH | https://wsc.apigw.ntruss.com/api/v1/jobs/{instanceId}/cancel |
| Web Security Checker | stopJob | PATCH | https://wsc.apigw.ntruss.com/api/v1/jobs/{instanceId}/stop |
| Web Security Checker | getReport | GET | https://wsc.apigw.ntruss.com/api/v1/jobs/report |
| Web Security Checker | createJob | PUT | https://wsc.apigw.ntruss.com/api/v1/job |