PCI Compliance Release 1.7 API

The following are the input parameters to create PCI scan schedule.

The following sample demonstrate using Update PCI Scan API to updated the scan schedules.

API Request

POST /pci/scan/schedule HTTP/1.1
Host: api.example.com
Authorization: Bearer <toke_value>
Content-Type: application/json
    

API Request Body

{
  "title": "Monthly PCI IP Scan",
  "scanType": "IP",
  "bandwidth": "Medium",
  "targetAll": "true",
  "launchDate": "2026-03-15T02:00:00Z",
  "gmtShift": -5
} 
    

API Response

 {
  "responseApiVersion": "v1",
  "data": {
    "scheduleId": 10234,
    "title": "Monthly PCI IP Scan",
    "launchDate": "2026-03-15T02:00:00Z",
    "status": "waiting",
    "isRecurring": false
  }
}
    

The following are the input parameters for update PCI Scan Schedule API.

The following sample demonstrate using Update PCI Scan API to updated the scan schedules.

API Request

  curl -X PUT "https://api.example.com/pci/scan/schedule/10234/update" \
  -H "Authorization: Bearer <your-jwt-token>" \
  -H "Content-Type: application/json" \
  
    

API Request Body

 -d '{
    "title": "Updated Monthly PCI Scan",
    "launchDate": "2026-04-15T02:00:00Z"
  }'
    

API Response

{
  "responseApiVersion": "v1",
  "data": {
    "scheduleId": 10234,
    "title": "Updated Monthly PCI Scan",
    "launchDate": "2026-04-15T02:00:00Z",
    "status": "waiting",
    "isRecurring": false,
    "message": "Schedule scan 10234 has been successfully updated."
  }
}    
    

The following input parameters are required for generating the PCI Scan report.

The following sample illustrates using the Generate Scan Report API to initiate the report generation.

API Request

 
    curl.exe -i -u "mjaisinghani@pci:{password}" -X POST "<qualys_base_url>/pci/scan/14251/report" \
    -H "apiVersion: V1" \
    -H "Content-Type: application/" \
    -H "X-Requested-With: Test"
    

API Response

 
    {
       "responseApiVersion": "V1",
       "data": {
         "status": "Report generation initiated"
         }
    }
    

The following input parameters are required to check the PCI Scan report status.

The following sample illustrates checking PCI Scan Report generation status.

API Request

 
    curl.exe -i -u "mjaisinghani@pci:{password}" -X GET "<qualys_base_url>/pci/scan/14251/report/status" \
    -H "apiVersion: V1" \
    -H "Content-Type: application/" \
    -H "X-Requested-With: Test"
    

API Response

 
    { 
       "responseApiVersion": "V1",
       "data": {
          "status": "Finished"
       }
    }
    

The following input parameters are required for downloading the PCI Scan report.

The following sample illustrates downloading PCI Scan Report.

API Request

 
    curl.exe -i -u "mjaisinghani@pci:{password}" -X GET "<qualys_base_url>/pci/scan/14251/report/download" \
    -H "apiVersion: V1" \
    -H "X-Requested-With: Test" \
    --output "PCIScanReport-14251.pdf"
    

API Response

 
    HTTP/1.1 200
    Content-Disposition: attachment; filename=PCIScanReport14251-20260213.pdf
    Content-Type: application/pdf
    

API Request

    curl --location '<<token generation url>>' JWT Token
    --header 'Content-Type: application/x-www-form-urlencoded' JWT Token
    --data-urlencode 'grant_type=password' JWT Token
    --data-urlencode 'username=<<Qualys_okta_sandbox_user_id>>' JWT Token
    --data-urlencode 'password=<<Qualys_okta_sandbox_password>>' \
    --data-urlencode 'client_id=<<Qualys_okta_sandbox_application_client_id>>' \
    --data-urlencode 'scope=openid profile'
    

The token generation URL may vary based on the IdP application you are using.The sample below illustrates the request and response for Okta.

API Response

    {
        "token_type": "Bearer",
        "expires_in": 3600,
        "access_token": "<JWT token value",
        "scope": "profile openid",
        "id_token": "<JWT token value>"
     }
     

API Request

 
      curl --location --globoff '<qualys_base_url>/pci/scan/list?limit=10' \
      --header 'Content-Type: application/json' \
      --header 'X-Requested-With: test' \
      --header 'Authorization: Bearer eyJraWQiOiJnbGhramRmc2F.......OqUA_r4hhg'
      

API Response

 
    {
       "responseApiVersion": "LATEST",
       "data":
          {
              "totalCount": 1267,
              "fetchRange": "1-10",
              "scanInfoList":
              [  {
                  "scanId": 9094,
                  "title": "a",
                  "status": "Failed",
                  "date": "December 18, 2020 at 07:54 AM GMT",
                  "scanType": "DNS",
                  "compliance": "Fail"
                  },
                 {
                  "scanId": 9093,
                  "title": "a",
                  "status": "Running",
                  "date": "December 18, 2020 at 07:54 AM GMT",
                  "scanType": "DNS",
                  "compliance": "Fail"
                 },
                 {
                  "scanId": 9092,
                  "title": "a",
                  "status": "Failed",
                  "date": "December 18, 2020 at 07:50 AM GMT",
                  "scanType": "DNS",
                  "compliance": "Fail"
                 },
                 {
                  "scanId": 9091,
                  "title": "a",
                  "status": "Failed",
                  "date": "December 18, 2020 at 07:50 AM GMT",
                  "scanType": "IP",
                  "compliance": "Fail"
                 },
                 {
                  "scanId": 9090,
                  "title": "a",
                  "status": "Launch Requested",
                  "date": "December 18, 2020 at 07:44 AM GMT",
                  "scanType": "DNS",
                  "compliance": "Fail"
                 }
              ]
            }
          }