The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.
GET /api/ss/projects HTTP/1.1Host: demo.attackforge.comX-SSAPI-KEY: APIKeyContent-Type: application/jsonConnection: close
name (string) (optional)
Name of the project.
Example:
GET /api/ss/projects?name=Test Project HTTP/1.1
code (string) (optional)
Project code.
Example:
GET /api/ss/projects?code=Project123 HTTP/1.1
status (string) (optional)
Status of the project. Must be one of the following: Waiting-to-Start, Testing, Completed, On-Hold
Example:
GET /api/ss/projects?status=Testing HTTP/1.1
startDate (string) (optional)
Start date to query projects from. String in YYYY-MM-DD format.
Example:
GET /api/ss/projects?startDate=2020-01-01 HTTP/1.1
endDate (string) (optional)
End date to query projects to. String in YYYY-MM-DD format.
Example:
GET /api/ss/projects?endDate=2020-12-31 HTTP/1.1
The following example is a cURL request to get all projects with status 'Testing' which have a test window between 1st January 2020 to 1st February 2020.
Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
curl -X GET 'https://demo.attackforge.com/api/ss/projects?startDate=2020-01-01&endDate=2020-02-01&status=Testing' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'
Response contains an array of project objects.
{"count": 999,"projects":[{"project_id": "...","project_name": "...","project_code": "...","project_groups": [{"name":"...","id":"..."},{"name":"...","id":"..."}],"project_status": "...","project_total_testcases": 999,"project_not_tested_testcases": 999,"project_in_progress_testcases": 999,"project_tested_testcases": 999,"project_not_applicable_testcases": 999,"project_total_vulnerabilities": 999,"project_critical_vulnerabilities": 999,"project_high_vulnerabilities": 999,"project_medium_vulnerabilities": 999,"project_low_vulnerabilities": 999,"project_info_vulnerabilities": 999,"project_open_vulnerabilities": 999,"project_closed_vulnerabilities": 999,"project_retest_vulnerabilities": 999,"project_zeroday_vulnerabilities": 999,"project_easily_exploitable_vulnerabilities": 999,"project_cwe_top_25_vulnerabilities": 999,"project_owasp_top_10_vulnerabilities": 999,"project_pending_vulnerabilities": 999,"project_retests_requested": 999,"project_retests_completed": 999,"project_start_date": "...","project_end_date": "...","project_scope": ["...","..."],"project_on_hold": "...","project_scoring": "...","project_created": "...","project_last_modified": "..."}]}