Campaigns List

GET

https://api.respan.ai/redteam/campaigns/

GET

/redteam/campaigns/

$ curl https://api.respan.ai/redteam/campaigns/ \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "count": 123,
3   "results": [
4     {
5       "target_id": "string",
6       "target_label": "string",
7       "created_at": "2024-01-15T09:30:00Z",
8       "summary": {
9         "status": "string",
10         "grade": "string",
11         "score": 1,
12         "findings_count": 1,
13         "probes_sent": 1,
14         "probes_completed": 1,
15         "probes_errored": 1,
16         "probes_total": 1
17       },
18       "id": "string",
19       "status": "queued",
20       "error": "string",
21       "started_at": "2024-01-15T09:30:00Z",
22       "finished_at": "2024-01-15T09:30:00Z"
23     }
24   ],
25   "next": "http://api.example.org/accounts/?page=4",
26   "previous": "http://api.example.org/accounts/?page=2"
27 }

Declare per-endpoint throttling configuration attributes for views.

Endpoints can inherit this mixin and set:

endpoint_default_rate_limit_per_user_per_min: float | None

When set (not None), throttling will use ONLY this default RPM for the endpoint without requiring API key / org attributes on the request. When unset, the standard API key / organization / subscription limits apply.

Declare per-endpoint throttling configuration attributes for views. Endpoints can inherit this mixin and set: - endpoint_default_rate_limit_per_user_per_min: float | None When set (not None), throttling will use ONLY this default RPM for the endpoint without requiring API key / org attributes on the request. When unset, the standard API key / organization / subscription limits apply.

Authentication

AuthorizationBearer

JWT access token or Respan API key

Query parameters

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

Response

countinteger

resultslist of objects

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"