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/testsuite/:id HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

id (string)

Id of the testsuite.

Example:

PUT /api/ss/testsuite/5eac95f1e594ea09107e9bb5 HTTP/1.1

name (string) (optional)

Name of the testsuite.

Example:

{
   "name": "..."
}

description (string) (optional)

Brief description of the testsuite.

Example:

{
   "description": "..."
}

tags (array of strings) (optional)

Tags for the testsuite.

Example:

{
   "tags": ["...", "..."]
}

is_deleted (boolean) (optional)

Whether testsuite is deleted or not.

Example:

{
   "is_deleted": false
}

Example

The following example is a cURL request to update a testsuite.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.

curl -X PUT 'https://demo.attackforge.com/api/ss/testsuite/5eac95f1e594ea09107e9bb5' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
  "name": "7-day Web App Pentest",
  "description": "Methodology for a 7-day web app pentest.",
  "tags": ["Web App", "7-days"],
  "is_deleted": false
}'

Response

Response contains a status.

{
   "status": "Testsuite Updated"
}