icon-zcspm.svg
ZCSPM

Scan Status API

The Scan Status API allows you to get scan status in ZCSPM for the provided cloud account.

URI

GET https://<ZCSPM API DOMAIN>/compliance/license/<LICENSE ID>/account/<ACCOUNT ID>/job/<JOB ID>/status
Environment Values for ZCSPM API Domain
PROD api.cloudneeti.com, api1.cloudneeti.com
TRIAL trialapi.cloudneeti.com

URI Parameters

Parameter Description Required/Optional
LICENSE ID ZCSPM license ID Required
ACCOUNT ID ZCSPM cloud account ID Required
JOB ID Cloud account scan job ID Required

Authorization

Type Description Required/Optional
Bearer Token Account Token Required
Key Value
Ocp-Apim-Subscription-Key ZCSPM API key

Response

Name Type Description
jobStatus String ZCSPM cloud account scan job status
statusCode Integer ZCSPM API response status code
message String Response describing operation result as success or failed

Sample Response

    {
            "result": {
                    "jobStatus": "Success"
            },
            "statusCode": 200,
            "message": "Request Successful"
    }

Definitions

JobStatus

Name Type
Pending String
New String
Running String
Success String
Failed String
Related Articles
Getting Started with ZCSPM APIToken APIInitiate Scan APIOnboard Cloud Account APIUpdate Access Scope APIAudit Report APILicense Accounts APISupported Benchmarks APICloud Account Health Status APIScan Status API