Skip to content

Scan status API

Cloudneeti offers scan API to get scan status in Cloudneeti for provided cloud account.

    GET https://<CLOUDNEETI API DOMAIN>/compliance/license/<LICENSE ID>/account/<ACCOUNT ID>/job/<JOB ID>/status
Environment Values for Cloudneeti API domain
PROD api.cloudneeti.com
TRIAL trialapi.cloudneeti.com

URI Parameters

Parameter Description Required/Optional
LICENSE ID Cloudneeti license id Required
ACCOUNT ID Cloudneeti 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 Cloudneeti API key generated

Response

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

Sample Response

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

Definations

JobStatus

Name Type
Pending String
New String
Running String
Completed String
Failed String