AttackForge Enterprise & AttackForge Core
Powered By GitBook
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

1
GET /api/ss/testsuites/:id HTTP/1.1
2
Host: demo.attackforge.com
3
X-SSAPI-KEY: APIKey
4
Content-Type: application/json
5
Connection: close
Copied!

Query

id (string)
Id of the testsuite.
Example:
1
GET /api/ss/testsuites/5e641773899bb708b55ea489 HTTP/1.1
Copied!

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.
1
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'
Copied!

Response

Response contains a testsuite object.
1
{
2
"testsuite": {
3
"created": "...",
4
"last_modified": "...",
5
"name": "...",
6
"description": "...",
7
"tags": ["...", "..."],
8
"id": "...",
9
"created_by": "...",
10
"testcases": [
11
{
12
"created": "...",
13
"last_modified": "...",
14
"title": "...",
15
"tags": ["...", "..."],
16
"created_by": "..."
17
}
18
]
19
}
20
}
Copied!
Last modified 3mo ago