Skip to main content
Version: 2608.1

Request Inquiry API

GEThttps://ondemand.sparrowcloud.ai/api/v1/request/{requestId}

Description

If you want to check the progress of a request after requesting that an analysis be performed, you can send the request inquiry API.

Request​

To request a request inquiry, you need the request ID. Check the request ID you received in the response from the analysis request API.

Response​

When you send the analysis inquiry API, information about the analysis progress and the detected issues at the time of the inquiry is returned. For details, see Response.

Request

pathName :requestIdapi 스펙과 일치하지 않는 pathName 입니다.

Response

✔️ Success response​

Request succeeded​

When the request inquiry request is processed normally, you receive 200 OK together with a RequestInfo object.

RequestInfo​

The object included in the response about a request. Depending on the type of request, it is one of the SastRequestInfo, ScaRequestInfo, DastRequestInfo, StopRequestInfo objects.

SastRequestInfo​

ScaRequestInfo​

DastAnalysisInfo​

StopRequestInfo​

❌ Failure response​

Authentication failure​

If the credentials are incorrect, you receive a 401 Unauthorized response.

Bad request​

For a bad request, you receive a 400 Bad Request response together with the following information.

  • resultCode: indicates the result of the request as a code. For details, see API result codes.
  • message : shows the error message.