Note: Beagle Security API v1 has been deprecated. We recommend that you upgrade to v2
Get all running tests of a team
Used to get the running tests of a team.
API
GEThttps://api.beaglesecurity.com/rest/v2/test/runningsessions?teamid={teamid}
Required scope: read_test_result
Request headers
| Name | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
Request body
| Name | Type | Description | Required |
|---|---|---|---|
| teamid | string | A unique token for identifying your team |
Example request
curl --location --request GET \
'https://api.beaglesecurity.com/rest/v2/test/runningsessions?teamid=xxxxxxxxxx' \
--header 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
// This token will be generated from Beagle security settings -> Access token
BeagleSecurityClient client = BeagleSecurityClientBuilder.instance()
.withAPIToken("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
.build();
// Get all running test sessions (with team)
String teamId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
List<TestRunningSession> testRunningSession = client.getTeamTestRunningSessions(teamId);
Response
| Name | Type | Description |
|---|---|---|
| sessions | array | List of test session objects |
| code | string |
Status code for the API call.
Values are:
SUCCESSAPI call is success
PLAN_NOT_SUPPORTEDYour plan does not support this feature.
INVALID_SESSIONInvalid session
FAILEDFailed to get test sessions.
NOT_AUTHORIZEDUser authentication failed.
|
| message | string | Success/failure message for the API call |
Example response
{
"code": null,
"message": null,
"sessions": [
{
"title": "Example 1",
"url": "https://example1.com",
"applicationToken": "9quf44bokfy0vto2kjlmush2zglr9wn7",
"resultToken": "6mynp3a2gyw9gb2k45jb158byk1n3dym",
"startTime": 1628712549237
},
{
"title": "Example 2",
"url": "http://example2.com",
"applicationToken": "9quf44bokfy0vto2kjlmush2zglr9wn7",
"resultToken": "6mynp3a2gyw9gb2k45jb158byk1n3dym",
"startTime": 1630740413141
}
]
}
{
"code": "PLAN_NOT_SUPPORTED",
"message": "Your plan does not support this feature."
}
{
"code": "NOT_AUTHORIZED",
"message": "Not authorized"
}