GetProjectById

This method can be used for the following functionality: Get details for a project user has access to, by project identifier (Id).
Parameters
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.
Headers
GET /api/ss/project/:id HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close
Query
id (string)
Identifier for the project.
Example:
GET /api/ss/project/5e48c12ec0376309d73aad71 HTTP/1.1
Example
The following example is a cURL request to get a project by its identifier (Id).
Request
Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
curl -X GET 'https://demo.attackforge.com/api/ss/project/5e48c12ec0376309d73aad71' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'
Response
Response contains a project object.
{
   "project": {
      "project_id": "...",
      "project_name": "...",
      "project_code": "...",
      "project_groups": [{"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": [{"name":"...", "id":"...", "workspaceId":"..."}, ...],
      "project_on_hold": "...",
      "project_scoring": "...",
      "project_team": ["...", "..."],
      "project_created": "...",
      "project_last_modified": "..."
   }
}
GetProjectAuditLogs
GetProjects
Last updated 3 months ago