UpdateProjectById
This method can be used for the following functionality: Update a project by it's 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
PUT /api/ss/project/:id HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: closeQuery
id (string)
Project Id.
Example:
PUT /api/ss/project/5eab99471e18050942c7607a HTTP/1.1created (string) (optional)
Overwrite the created timestamp for the project. Must be UTC string e.g. 2021-06-03T23:15:33.008Z.
Example:
name (string) (optional)
Name of the project.
Example:
code (string) (optional)
Project code.
Example:
groups (array of strings) (optional)
Groups to link to the project. Must match group IDs.
Example:
startDate (string) (optional)
Project start date. Must be UTC string e.g. 2021-06-03T23:15:33.008Z.
Example:
endDate (string) (optional)
Project end date. Must be UTC string e.g. 2021-06-03T23:15:33.008Z.
Example:
scoringSystem (string) (optional)
Scoring system to be used on the project. Must be either Manual or CVSSv3.1.
Example:
isOnHold (string) (optional)
Whether project is currently On-Hold. Must be either Yes or No.
Example:
isOnHoldReason (string) (optional)
If project is On-Hold, or is now Off-Hold - include a reason. This will be sent in email to project team informing status change.
Example:
organization_code (string) (optional)
Project organization code.
Example:
vulnerability_code (string) (optional)
Vulnerability code for user friendly vulnerability ids. Must be unique per project, 3-8 characters in length.
Example:
team_notifications (array of strings) (optional)
Project team notifications. Must include one or more of the following: critical, high, medium, low, info, retest, reopened, closed
Example:
admin_notifications (array of strings) (optional)
Admin notifications. Must include one or more of the following: retest, reopened, closed
Example:
start_stop_testing_email (string) (optional)
Email body for daily start & stop testing notifications.
Example:
start_stop_testing_email_additional_recipients (array of strings) (optional)
Additional email recipients for daily start & stop testing notifications. Must be a list of email addresses.
Example:
new_vulnerability_email_type (string) (optional)
Individual or Grouped emails to be sent for new vulnerabilities. Must include one of the following: individual, group. If not specified, default option is individual
Example:
new_vulnerability_email (string) (optional)
Email body for new vulnerability discovered notifications.
Example:
new_vulnerability_email_additional_recipients (array of strings) (optional)
Additional email recipients for new vulnerability discovered notifications. Must be a list of email addresses.
Example:
forced_emails (array of strings) (optional)
Force emails to project team. Must include one or more of the following: all_emails, daily_start_stop_testing, new_critical_vulnerability, new_high_vulnerability, new_medium_vulnerability, new_low_vulnerability, new_info_vulnerability, vulnerability_ready_for_retesting, vulnerability_reopened, vulnerability_closed, project_role_updated, project_hold, retest_completed
Example:
sla_activation (string) (optional)
Apply vulnerability SLAs automatically or manually. Must be either "automatic" or "manual". Automatic is default.
Example:
executive_summary (string) (optional)
Executive summary for the reports.
Example:
custom_fields (array of objects) (optional)
Custom fields. Must include a key and value. Key must be unique and letters, numbers and underscores only.
For more information visit https://support.attackforge.com/attackforge-enterprise/getting-started/custom-fields-and-forms#using-custom-fields-with-apis
Example:
reporting_custom_fields (array of objects) (optional)
Reporting custom fields. Must include a key and value. Key must be unique and letters, numbers and underscores only.
For more information visit https://support.attackforge.com/attackforge-enterprise/getting-started/custom-fields-and-forms#using-custom-fields-with-apis
Example:
summary_custom_fields (array of objects) (optional)
Summary page custom fields. Must include a key and value. Key must be unique and letters, numbers and underscores only.
For more information visit https://support.attackforge.com/attackforge-enterprise/getting-started/custom-fields-and-forms#using-custom-fields-with-apis
Example:
portfolio_streams (array of objects) (optional)
Enter a list of Portfolio & Stream Ids to link this project to. Stream must be part of the Portfolio.
Example:
features (object) (optional)
Configure features on the project. Roles must be either client, consultant or librarymod. Minimum Project Access Level must be either View, Upload or Edit.
Example:
pages (object) (optional)
Configure pages on the project. Roles must be either client, consultant or librarymod. Project Access Level must be either View, Upload or Edit.
Example:
Example
The following example is a cURL request to update a project by its identifier (Id).
Request
Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
Response
Response contains a project object.
Last updated