UpdateTestsuite

This method can be used for the following functionality: Update a test suite.

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: localhost:3000
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

id (string)

Id of the test suite.

Example:

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

name (string) (optional)

Name of the test suite.

Example:

{   
    "name": "..."
}

description (string) (optional)

Brief description of the test suite.

Example:

{   
    "description": "..."
}

code (string) (optional)

Code for the test suite.

Example:

{   
    "code": "..."
}

sort_order (number) (optional)

Sort Order to apply to the test suite.

Example:

{   
    "sort_order": 1
}

is_visible_on_project_requests (boolean) (optional)

Whether this test suite should be displayed and made available to be selected when a user is requesting a project.

Example:

{   
    "is_visible_on_project_requests": false
}

tags (array of strings) (optional)

Tags for the test suite.

Example:

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

is_deleted (boolean) (optional)

Whether test suite is deleted or not.

Example:

{   
    "is_deleted": false
}

Example

The following example is a cURL request to update a test suite.

Request

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

curl -X PUT 'https://localhost:3000/api/ss/testsuite/5eac95f1e594ea09107e9bb5' -H 'Host: localhost:3000' -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.",
  "code": "WEBAPP-7DAY",
  "sort_order": 1,
  "is_visible_on_project_requests": false,
  "tags": ["Web App", "7-days"],
  "is_deleted": false
}'

Response

Response contains a status.

{   
    "status": "Testsuite Updated"
}