Skip to main content
Version: 2608.1

Analysis Inquiry API

GEThttps://ondemand.sparrowcloud.ai/api/v3/analysis/{analysisId}

Description

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

Request​

To request an analysis inquiry, you need the analysis ID. Check the analysis 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 :analysisIdapi 스펙과 일치하지 않는 pathName 입니다.

Response

✔️ Success response​

Request succeeded​

When the analysis inquiry request is processed normally, you receive 200 OK together with an AnalysisInfo object.

AnalysisInfo​

The object included in the response about an analysis. Depending on the type of analysis, it is one of the SastAnalysisInfo, ScaAnalysisInfo, DastAnalysisInfo objects.

SastAnalysisInfo​

ScaAnalysisInfo​

DastAnalysisInfo​

❌ Failure response​

Authentication failure​

If the credentials are incorrect, you receive 401 Unauthorized.

Bad request​

For a bad request, you receive 400 Bad Request.

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