PCI
The PCI endpoint allows you to get a summary of PCI status and start the PCI compliance process.
Retrieve a summary of PCI reports and their status.
GET
https://api.halosecurity.com/api/v1/pci/summary.json
Retrieve a summary of PCI reports and their status.
https://www.halosecurity.com/user/security/pci/
{
"report_count": 1,
"last_report_id": 123,
"status": "pending"
}
Start PCI attestation process.
GET
https://api.halosecurity.com/api/v1/pci/start.json
Start PCI attestation process and receive questions which must be attested to.
https://www.halosecurity.com/user/security/pci/
{
'id':'UUID',
'attestation':'text you must agree to',
'target_count':10,
'target_hosts_oos':1,
'target_ids_require_scan':[1,2], //these targets must be scanned before attest
'target_ids_has_vuln':[1,2], //these targets have issues that must be resolved before attest
'questions':[{ //answers to these questions must be provided in attest
'id':1,
'text':'question 1 text?',
'type':'yesno'
},{...}],
'notes':[{ //acceptance of these notes must be provided in attest
'id':1,
'issue_id':100,
'issue_name':'XSS',
'target_id':5,
'target_host':'example.com',
'text':'note text',
'type':'note type'
},{...}]
}
Attest to a given PCI report.
POST
https://api.halosecurity.com/api/v1/pci/attest.json
Attest to a given PCI report. Requires the id
returned from the start.json
method.
https://www.halosecurity.com/user/security/pci/
Request Body
id*
UUID
report_name*
String
attest_person_name*
String
attest_person_title*
String
questions*
JSON Array
[{'id':1,answer:'yes'}]
notes*
JSON Array
[{
'target_id':'1',
'issue_id':'2',
'secure':'1',
'response':'your response message'
}]
{
"success": 1,
"report": {
"attest_name": "Attest Name",
"target_count": 1,
"name": "Report Name",
"pci_report_id": 12345,
"attest_title": "Attest Title",
"status": "draft"
}
}
List details about PCI reports.
GET
https://api.halosecurity.com/api/v1/pci/report-list.json
List details about PCI reports including their names and pci_report_id
.
https://www.halosecurity.com/user/security/pci/
{
"request": {
"target_count": 3,
"sort": "1"
},
"pagination": {
"total": 1,
"start": 0,
"limit": 100
},
"list": [
{
"report": {
"attest_name": "Attest Name",
"target_count": 1,
"name": "Report Name",
"pci_report_id": 127345,
"attest_title": "Attest Title",
"status": "draft"
}
}
]
}
Get details about a specific PCI report.
GET
https://api.halosecurity.com/api/v1/pci/report-get.json
Get details about a specific PCI report. Requires the pci_report_id
returned from the report-list.json
method.
https://www.halosecurity.com/user/security/pci/
Query Parameters
pci_report_id*
Integer
{
"request": {
"target_count": 3,
"sort": "1"
},
"report": {
"attest_name": "Attest Name",
"target_count": 1,
"notes": [],
"name": "Report Name",
"pci_report_id": 12345,
"attest_title": "Attest Title",
"target_ids": [
1234
],
"status": "draft"
}
}
Last updated
Was this helpful?