AttackForge
Search
K

GetTestsuiteById

This method can be used for the following functionality: Get details for a testsuite and its testcases.

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/testsuites/: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:
GET /api/ss/testsuites/5e641773899bb708b55ea489 HTTP/1.1

Example

The following example is a cURL request to get a testsuite and its testcases.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
curl -X GET 'https://demo.attackforge.com/api/ss/testsuites/5e641773899bb708b55ea489' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'

Response

Response contains a testsuite object.
{
"testsuite": {
"created": "...",
"last_modified": "...",
"name": "...",
"description": "...",
"tags": [
"..."
],
"id": "...",
"created_by": "...",
"testcases": [
{
"created": "...",
"last_modified": "...",
"title": "...",
"details": "...",
"details_html": "...",
"tags": [
"..."
],
"created_by": "...",
"execution_flow": [
{
"title": "...",
"details": "...",
"details_html": "..."
}
],
"custom_fields": [
{
"key": "...",
"value": "...",
"type": "Field"
}
]
}
]
}
}