Table of Contents
Read methods
| Method / Path: | GET /{agentId} |
|---|---|
| Description: | Returns a single capture agent. |
| Path params: | agentId: The agent id |
| Optional (query) params: | NONE |
| Response formats: |
application/json
application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json application/v1.11.0+json |
| Status codes: |
200: OK, The agent is returned. 404: Not Found, The specified agent does not exist. |
| Testing: |
Sample:
/{agentId}
Testing form (click to reveal)
|
| Method / Path: | GET / |
|---|---|
| Description: | Returns a list of agents. |
| Path params: | NONE |
| Optional (query) params: |
limit(Default value=0):
The maximum number of results to return for a single request. offset(Default value=0): The index of the first result to return. |
| Response formats: |
application/json
application/v1.1.0+json application/v1.2.0+json application/v1.3.0+json application/v1.4.0+json application/v1.5.0+json application/v1.6.0+json application/v1.7.0+json application/v1.8.0+json application/v1.9.0+json application/v1.10.0+json application/v1.11.0+json |
| Status codes: | 200: OK, A (potentially empty) list of agents is returned. |
| Testing: |
Sample:
/?limit=0&offset=0
Testing form (click to reveal)
|