Skip to main content
POST
Run Security Agent

Authorizations

Authorization
string
header
required

JWT login token tied to your Perfai user (not a separate API key). Obtain it via POST /api/v1/auth/token with your username and password (use the returned id_token) — the same login the web console performs. Carries org, user, and role; short-lived.

Path Parameters

appId
string
required

MongoDB ObjectId of the app (from GET /apps or POST /apps).

Body

application/json

No request body — it runs all available test categories for the app identified by the appId path segment.

Response

Run scheduled.

taskId
string
appId
string
state
enum<string>
Available options:
QUEUED,
RUNNING,
COMPLETED,
FAILED,
CANCELLED,
INTERRUPTED
createdAt
string<date-time> | null
updatedAt
string<date-time> | null
statusUrl
string
runNumber
integer

Monotonically increasing counter per app (status endpoint only).