LogoLogo
  • AttackForge Support
  • Release Notes
    • 2025
    • 2024
    • 2023
    • 2022
    • 2021
    • 2020
    • 2019
  • Core & Enterprise
    • Getting Started
      • How It Works
      • Requesting A Project
      • Creating & Updating Projects
      • Invite User To Project
      • View Project Team
      • Project Scope
      • Project Workspace
      • Project Notes
      • Project Pages
      • Test Cases
      • Creating Vulnerabilities
      • Updating Vulnerabilities
      • Review & QA
      • Attack Chains
      • Reporting
      • Retesting & Remediation
      • Notifications
      • Custom Fields & Forms
      • Vulnerability SLAs
      • User Settings
      • Login Redirects
    • Modules
      • Dashboard
      • Analytics
      • Vulnerabilities
      • Projects
      • Scheduling
      • Portfolios
      • Groups
      • Attack Chains
      • Assets
      • Writeups
      • Test Suites
      • Report Templates
        • Overview
        • Tutorial
        • Tips & Tricks
        • Troubleshooting
        • Template - Report Templates
        • Template - Tags
        • Template - Options
        • Template - Functions
        • Template - Filters
        • Template - Styles
        • Template - Tables
        • Template - Charts
        • Template - Conditions
        • ReportGen CLI
        • ReportGen Library
      • Users
      • Administration
      • Flows
      • Self-Service RESTful API
        • GETTING STARTED
        • EXPORTING TO CSV
        • ADVANCED QUERY FILTER
        • ActivateUser
        • AddProjectMembershipAdministrators
        • AddTestcaseToTestsuite
        • AddTestcasesToTestsuite
        • AddUserToGroup
        • ApproveProjectRequestById
        • ArchivePortfolio
        • ArchiveProject
        • CancelProjectRetestRound
        • CloneProject
        • CompleteProjectRetestRound
        • CreateAssetInLibrary
        • CreateGroup
        • CreatePortfolio
        • CreateProject
        • CreateProjectNote
        • CreateProjectRequest
        • CreateProjectTestCase
        • CreateProjectWorkspaceNote
        • CreateRemediationNote
        • CreateScope
        • CreateTestcaseNote
        • CreateTestsuite
        • CreateUser
        • CreateUsers
        • CreateVulnerability
        • CreateVulnerabilityBulk
        • CreateVulnerabilityLibraryIssue
        • CreateVulnerabilityWithLibrary
        • DeactivateUser
        • DownloadProjectTestCaseFile
        • DownloadProjectTestCaseNoteFile
        • DownloadProjectTestCaseWorkspaceNoteFile
        • DownloadVulnerabilityEvidence
        • DownloadVulnerabilityLibraryFile
        • DownloadWorkspaceFile
        • GetApplicationAuditLogs
        • GetAssets
        • GetAssetsByGroup
        • GetAssetInLibrary
        • GetAssetsInLibrary
        • GetCustomFieldsConfig
        • GetFormConfig
        • GetGroup
        • GetGroups
        • GetMostCommonVulnerabilities
        • GetMostFailedTestcases
        • GetMostVulnerableAssets
        • GetPortfolio
        • GetPortfolios
        • GetPortfolioStream
        • GetProjectAuditLogs
        • GetProjectById
        • GetProjects
        • GetProjectsAndVulnerabilities
        • GetProjectsByGroup
        • GetProjectMembershipAdministrators
        • GetProjectNotes
        • GetProjectReport
        • GetProjectReportData
        • GetProjectRequests
        • GetProjectRequestById
        • GetProjectTestcasesById
        • GetProjectVulnerabilitiesById
        • GetProjectWorkspace
        • GetTestsuiteById
        • GetTestsuites
        • GetUserByEmail
        • GetUserById
        • GetUserByUsername
        • GetUserAuditLogs
        • GetUserGroups
        • GetUserLoginHistory
        • GetUserProjects
        • GetUsers
        • GetVulnerabilityById
        • GetVulnerabilities
        • GetVulnerabilitiesByAssetName
        • GetVulnerabilitiesByGroup
        • GetVulnerabilityLibraryIssues
        • GetVulnerabilityRevisionHistory
        • InviteUserToProject
        • InviteUsersToProjectTeam
        • RejectProjectRequestById
        • RegenerateAPIKey
        • RemoveProjectMembershipAdministrators
        • RemoveProjectTeamMembers
        • RequestNewProjectRetest
        • RestoreProject
        • SendEmail
        • SendDailyCommencementEmail
        • SendDailyCompletionEmail
        • UpdateAssetInLibrary
        • UpdateCustomFieldsConfig
        • UpdateExecSummaryNotes
        • UpdateFormConfig
        • UpdateGroup
        • UpdatePortfolio
        • UpdateProjectById
        • UpdateProjectMembershipAdministrators
        • UpdateProjectNote
        • UpdateProjectRequestById
        • UpdateProjectRetestRound
        • UpdateProjectWorkspaceNote
        • UpdateScope
        • UpdateTestcase
        • UpdateTestcaseOnTestsuite
        • UpdateTestsuite
        • UpdateUserAccessOnGroup
        • UpdateUserAccessOnProject
        • UpdateUser
        • UpdateVulnerabilityById
        • UpdateVulnerabilityLibraryIssue
        • UpdateVulnerabilitySLAs
        • UpdateVulnerabilityWithLibrary
        • UploadTestcaseFile
        • UploadVulnerabilityEvidence
        • UploadVulnerabilityLibraryFile
        • UploadWorkspaceFile
      • Self-Service Events API
        • GETTING STARTED
        • Project Created
        • Project Updated
        • Project Request Created
        • Project Request Updated
        • Project Retest Requested
        • Project Retest Completed
        • Project Retest Cancelled
        • Vulnerability Created
        • Vulnerability Updated
        • Vulnerability Evidence Created
        • Vulnerability Evidence Updated
        • Vulnerability Remediation Note Created
        • Vulnerability Remediation Note Updated
    • AFScript
    • Access Control Matrix
    • Raising Support Tickets
    • Security
  • Contact
Powered by GitBook

Check YouTube for more tutorials: https://youtube.com/@attackforge

On this page
  • Parameters
  • Headers
  • Query
  • Example
  • Request
  • Response
  1. Core & Enterprise
  2. Modules
  3. Self-Service RESTful API

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_organization_code": "...",
    "project_vulnerability_code": "..."
    "project_groups": [
      {
        "id": "...",
        "name": "..." 
      }
    ],
    "project_status": "...",
    "project_extended_status": "...",
    "project_testing_progress": "100%",
    "project_on_hold": "...",
    "project_start_date": "...",
    "project_end_date": "...",
    "project_scope": [
      "..."
    ],
    "project_scope_details": [
      {
        "id": "...",
        "name": "...",
        "asset_id": "..."
      }
    ],
    "project_scoring": "...",
    "project_team_notifications": [
      "..."
    ],
    "project_admin_notifications": [
      "..."
    ],
    "project_start_stop_testing_email": "...",
    "project_start_stop_testing_email_additional_recipients": [
      "..."
    ],
    "project_new_vulnerability_email_type": "...",
    "project_new_vulnerability_email": "...",
    "project_new_vulnerability_email_additional_recipients": [
      "..."
    ],
    "project_forced_emails": [
      "..."
    ],
    "project_executive_summary": "...",
    "project_reporting_custom_fields": [
      { 
        "key": "...",
        "value": "...",
        "type": "Tag/Field"
      }
    ],
    "project_attack_chains": [
      {
        "total": 999
      }
    ],
    "project_team": [
      {
        "id": "...",
        "user_id": "...", 
        "first_name": "...", 
        "last_name": "...", 
        "access_level": "...", 
        "role": "...", 
        "email_notifications": [
          "..."
        ], 
        "last_modified": "..."
      }
    ],
    "project_hold_history": [
      "status": "...", 
      "reason": "...", 
      "created": "..."
    ],
    "project_retests_requested": 999,
    "project_retests_completed": 999,
    "project_retesting_history: [
      {
        "retesting_round_id": "...",
        "retesting_round": 1,
        "retesting_round_status": "...",
        "retesting_round_actioned_by": {
          "user_id": "...",
          "user_first_name": "...",
          "user_last_name": "..."
        },
        "retesting_round_vulnerabilities": [
          {
            "vulnerability_id": "...",
            "vulnerability_alternate_id": "...",
            "vulnerability_title": "..."
          }
        ],
        "retesting_window_end": "...",
        "retesting_window_start": "...",
        "retesting_round_retested_vulnerabilities": [
          {
            "vulnerability_id": "...",
            "vulnerability_alternate_id": "...",
            "vulnerability_title": "..."
          }
        ]
      }
    ],
    "project_streams": [
        {
          "id": "...",
          "name": "...",
          "stream_portfolios": [
            {
              "id": "...",
              "name": "...",
            }
          ]
        }
      ],
    "project_total_assets": 999,
    "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_open_vulnerabilities": 999,
    "project_closed_vulnerabilities": 999,
    "project_retest_vulnerabilities": 999,
    "project_critical_vulnerabilities": 999,
    "project_critical_open_vulnerabilities": 999,
    "project_critical_ready_for_retest_vulnerabilities": 999,
    "project_critical_closed_vulnerabilities": 999,
    "project_high_vulnerabilities": 999,
    "project_high_open_vulnerabilities": 999,
    "project_high_ready_for_retest_vulnerabilities": 999,
    "project_high_closed_vulnerabilities": 999,
    "project_medium_vulnerabilities": 999,
    "project_medium_open_vulnerabilities": 999,
    "project_medium_ready_for_retest_vulnerabilities": 999,
    "project_medium_closed_vulnerabilities": 999,
    "project_low_vulnerabilities": 999,
    "project_low_open_vulnerabilities": 999,
    "project_low_ready_for_retest_vulnerabilities": 999,
    "project_low_closed_vulnerabilities": 999,
    "project_info_vulnerabilities": 999,
    "project_info_open_vulnerabilities": 999,
    "project_info_ready_for_retest_vulnerabilities": 999,
    "project_info_closed_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_testsuites": [
      {
        "id": "...",
        "name": "..."
      }
    ],
    "project_created": "...",
    "project_last_modified": "...",
    "project_custom_fields": [
      {
        "key": "...", 
        "value": "...", 
        "type": "Tag/Field"
      }
    ],
    "project_features": {
    "attack_chains": {
      "access": {
        "project_access_level": "...",
        "roles": [
          "..."
        ]
      },
      "enabled": true
    },
    "reporting": {
      "access": {
        "project_access_level": "...",
        "roles": [
          "..."
        ]
      },
      "enabled": true
    },
    "retesting": {
      "access": {
        "project_access_level": "...",
        "roles": [
          "..."
        ]
      },
      "enabled": true
    },
    "testcases": {
      "access": {
        "project_access_level": "...",
        "roles": [
          "..."
        ]
      }
    }
  },
  "project_pages": {
    "summary": {
      "access": {
        "edit_project_access_levels": [
          "..."
        ],
        "edit_roles": [
          "..."
        ],
        "upload_project_access_levels": [
          "..."
        ],
        "upload_roles": [
          "..."
        ],
        "view_project_access_levels": [
          "..."
        ],
        "view_roles": [
          "..."
        ]
      },
      "enabled": true,
      "custom_fields": [
        {
          "key": "...",
          "value": "...",
          "type": "Tag/Field"
        }
      ]
    }
  }
}
PreviousGetProjectAuditLogsNextGetProjects

Last updated 1 month ago