List test agents

Retrieves the list of test agents

GET /manage/agents?offset={offset}&limit={limit}

URI Parameters

Name In Required Type Description

offset

query

False

integer

Offset of the first test agent in the list, default: 0

limit

query

False

integer

Maximum number of test agents returned, default: 20, maximum: 100

Responses

Name Type Description

200 OK

AgentListResponse

Test agent list response object

Produces

  • application/json

Security

Every request requires a JWT access token for authentication in the Authorisation HTTP header. Please see the API authentication page for details about how to get a JWT token.

Authorization: Bearer {JWT_TOKEN}

Roles

  • Wenenu Owner

  • Wenenu Contributor

  • Wenenu Test Agent Administrator

Sample request

GET https://wenenu.com/manage/agents?offset=0&limit=20 HTTP/1.1
Authorization: Bearer {jwt_token}

Sample Response

Status code: 200

{
  "result": [
    {
      "id": "20b050c1b115543a6d3634034f08f46c43b604b0a89bbb705363344289c40a80",
      "tenantId": "108365366dc9-88be-4c42-8329-55808630",
      "name": "Wenenu agent 1",
      "type": "user",
      "key1": "20b050c1b115543a6d3634034f08f46c43b604b0a89bbb705363344289c40a80.Je/ZOdOqH2EQ5wEA8Z813ngQmsMpYKeKt5GIfRJjB0YAg0JSAD1WyVDitFjUqs+QNOOkW8u5r30r90qeFg/7nw==",
      "key2": "20b050c1b115543a6d3634034f08f46c43b604b0a89bbb705363344289c40a80.+r/3g0VXl0ERYQn7nSyLTDexV9ZWbzzgEkgPOxaDpW4pb8FEBciyoYwQFM8n3AdpcT/NiD/OJ4u2tS7LNgLqGg=="
    },
    {
      "id": "aa1244414cc1241f39037a37eb95df436ebd580fbe4cc4e78287450d68507019",
      "tenantId": "108365366dc9-88be-4c42-8329-55808630",
      "name": "Wenenu agent 2",
      "type": "user",
      "key1": "aa1244414cc1241f39037a37eb95df436ebd580fbe4cc4e78287450d68507019.LLXDuhFrSdqhxbdR6fKKmAHRC+nmq8k9yJnm0YOSM0+bJlJt/mgT7q28Afqoj3E/jHynz5SwnjpgZ5qVjghXtg==",
      "key2": "aa1244414cc1241f39037a37eb95df436ebd580fbe4cc4e78287450d68507019.E2LEsVMAnOEHEemm1jBrOMNzbNV6V2mYtY/qMo+Fm21ScXZMkJDumI826XKaxo7gWJAKBRRaFLsIjprZEjVgMA=="
    }
  ],
  "total":2
}

Definitions

AgentListResponse

Name Type Description

result

Agent[]

List of the requested test agents

total

long

Total number of test agents

Agent

Name Type Description

id

string

Id of th test agent

tenantId

string

Version 4 UUID of the Wenenu tenant of the test agent

name

string

Arbitrary name of the test agent, length 1-256

type

string

Type of the test agent, always 'user' for user-created agents

key1

string

First API key of the test agent

key2

string

Second API key of the test agent